Skip to content

Commit

Permalink
docs: building and running docs locally (#2502)
Browse files Browse the repository at this point in the history
Signed-off-by: Faeka Ansari <[email protected]>
  • Loading branch information
fykaa authored Sep 11, 2024
1 parent 3d705c1 commit a64eb0e
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions docs/docs/40-contributor-guide/10-hacking-on-kargo.md
Original file line number Diff line number Diff line change
Expand Up @@ -421,3 +421,35 @@ as native processes.

</TabItem>
</Tabs>

## Contributing to Documentation

Contributors should ensure that their changes are accompanied by relevant documentation
updates. This helps maintain the project's sustainability. Pull requests with
corresponding documentation updates are more likely to be merged faster.
To make this process smoother, you can refer to [Docusaurus](https://docusaurus.io/docs)
for guidance on writing and maintaining docs effectively.
### Previewing Doc Changes Locally
After making your changes, preview the documentation locally to ensure everything renders
correctly. You can either run it in a container or natively on your system.
To build and serve the docs inside a container:
```shell
make hack-serve-docs
```
:::info
If you wish to opt-out of executing code-generation within a container (for
performance reasons, perhaps), drop the `hack-` prefix from the target to run the docs natively on your system:
```shell
make serve-docs
```
This will require quite a variety of tools to be installed locally, so we do not
recommend this if you can avoid it.
:::

0 comments on commit a64eb0e

Please sign in to comment.