From d0b46a59ee3035202bbb751a0315331ac5ceb4bd Mon Sep 17 00:00:00 2001 From: Yash Pimple <97302447+YashPimple@users.noreply.github.com> Date: Sat, 27 May 2023 23:38:52 +0530 Subject: [PATCH] docs: update building docs locally section --- docs/CONTRIBUTING.md | 86 +----------------- .../general/build_docs_locally/index.md | 91 +++++++++++++++++++ 2 files changed, 92 insertions(+), 85 deletions(-) create mode 100644 docs/content/en/contribute/general/build_docs_locally/index.md diff --git a/docs/CONTRIBUTING.md b/docs/CONTRIBUTING.md index 05519a2a358..da8e8d32df4 100644 --- a/docs/CONTRIBUTING.md +++ b/docs/CONTRIBUTING.md @@ -59,91 +59,7 @@ please create an issue on the GitHub repository: include that information in your description of the issue or in a comment to the issue. -## Building the documentation locally - -You can run Docsy locally so that you can view the formatted version -of what you are writing before you push it to github. -We provide a Docsy run environment in a Docker container, -which simplifies the set up -and makes it easier to upgrade your local build environment -as the software is updated. - -To set up a local Docsy build: - -1. Install Docker Desktop: - - * [Install on macOS](https://docs.docker.com/desktop/install/mac-install/) - * [Install on Linux](https://docs.docker.com/desktop/install/linux-install/) - * [Install on Windows](https://docs.docker.com/desktop/install/windows-install/) - -1. Build the Keptn Docsy repo: - - ```console - make build - ``` - - > **Note** - To utilize the `Makefile`, you must have GNU **make** - available on your local machine. - Versions are available for all the usual Operating Systems. - -1. Execute the following command from the `docs` folder of your clone: - - ```console - make server - ``` - - It will continue running in its own shell. - -1. Start contributing! -Note that Hugo updates the rendered documentation each time you write the file. - -1. Enter the following in a browser to view the website: - - `http://localhost:1314/docs-dev/` - - > **Note** - By default, Hugo serves the local docs on port 1313. - We have modified that port for the lifecycle-toolkit docs - to avoid conflicts with the keptn.github.io docs, which use - port 1313 for local builds. - -1. Use Ctrl+C to stop the local Hugo server when you are done. - -1. To restart the continuous build: - - * Restart Docker-Desktop, if necessary - * If changes have been made to the build tools: - * make clone - * make build - * Run `make server` - -### Building markdown files without Hugo - -The Hugo generator described above only renders -the markdown files under the */content/docs* directory. -If you need to render another markdown file -(such as this *CONTRIBUTING.md* file) -to check your formatting, you have the following options: - -* If you are using an IDE to author the markdown text, - use the markdown preview browser for the IDE. -* You can push your changes to GitHub - and use the GitHub previewer (*View Page*). -* You can install and use the - [grip](https://github.com/joeyespo/grip/blob/master/README.md) previewer - to view the rendered content locally. - When *grip* is installed, - you can format the specified file locally - by running the following in its own shell: - - ```console - grip .md - ``` - - Point your browser at `localhost:6419` to view the formatted file. - The document updates automatically - each time you write your changes to disk. +## [Building the documentation locally](./content/en/contribute/general/build_docs_locally/index.md) ## Interacting with github diff --git a/docs/content/en/contribute/general/build_docs_locally/index.md b/docs/content/en/contribute/general/build_docs_locally/index.md new file mode 100644 index 00000000000..c9bddb1cc11 --- /dev/null +++ b/docs/content/en/contribute/general/build_docs_locally/index.md @@ -0,0 +1,91 @@ +--- +title: Build documentation locally +description: This guide explains how to create a local version of the documentation +weight: 400 +--- + +## Building the documentation locally + +You can run Docsy locally so that you can view the formatted version +of what you are writing before you push it to github. +We provide a Docsy run environment in a Docker container, +which simplifies the set up +and makes it easier to upgrade your local build environment +as the software is updated. + +To set up a local Docsy build: + +1. Install Docker Desktop: + + * [Install on macOS](https://docs.docker.com/desktop/install/mac-install/) + * [Install on Linux](https://docs.docker.com/desktop/install/linux-install/) + * [Install on Windows](https://docs.docker.com/desktop/install/windows-install/) + +1. Build the Keptn Docsy repo: + + ```console + make build + ``` + + > **Note** + To utilize the `Makefile`, you must have GNU **make** + available on your local machine. + Versions are available for all the usual Operating Systems. + +1. Execute the following command from the `docs` folder of your clone: + + ```console + make server + ``` + + It will continue running in its own shell. + +1. Start contributing! +Note that Hugo updates the rendered documentation each time you write the file. + +1. Enter the following in a browser to view the website: + + `http://localhost:1314/docs-dev/` + + > **Note** + By default, Hugo serves the local docs on port 1313. + We have modified that port for the lifecycle-toolkit docs + to avoid conflicts with the keptn.github.io docs, which use + port 1313 for local builds. + +1. Use Ctrl+C to stop the local Hugo server when you are done. + +1. To restart the continuous build: + + * Restart Docker-Desktop, if necessary + * If changes have been made to the build tools: + * make clone + * make build + * Run `make server` + +### Building markdown files without Hugo + +The Hugo generator described above only renders +the markdown files under the */content/docs* directory. +If you need to render another markdown file +(such as this *CONTRIBUTING.md* file) +to check your formatting, you have the following options: + +* If you are using an IDE to author the markdown text, + use the markdown preview browser for the IDE. +* You can push your changes to GitHub + and use the GitHub previewer (*View Page*). +* You can install and use the + [grip](https://github.com/joeyespo/grip/blob/master/README.md) previewer + to view the rendered content locally. + When *grip* is installed, + you can format the specified file locally + by running the following in its own shell: + + ```console + grip .md + ``` + + Point your browser at `localhost:6419` to view the formatted file. + The document updates automatically + each time you write your changes to disk.