kustomize docs tweaks

This commit is contained in:
Phillip Wittrock
2020-06-11 21:40:35 -07:00
parent 3012dd67ac
commit 589ddcb4fa
10 changed files with 467 additions and 42 deletions

View File

@@ -18,15 +18,11 @@ forked from the [docsy-example](https://github.com/google/docsy-example)
## Development
The docs are in the `site` directory
The doc input files are in the `site` directory. The site can be hosted locally using
`hugo serve`.
```shell script
cd site/
```
To view the docs run
```shell script
hugo serve
```
@@ -36,13 +32,12 @@ Running in Fast Render Mode. For full rebuilds on change: hugo server --disableF
Web Server is available at http://localhost:1313/kustomize/ (bind address 127.0.0.1)
```
and visit the URL that is printed
## Publishing
The `site` content is compiled by Hugo into the `docs` folder using the hugo command:
Hugo compiles the files under `site` Hugo into html which it puts in the `docs` folder:
```shell script
cd site/
hugo
```
@@ -59,4 +54,29 @@ hugo
Cleaned | 0
```
Add the `site` and `docs` folders to a commit, and create a PR.
Add the `site/` and `docs/` folders to a commit, then create a PR.
## Publishing docs to your kustomize fork
It is possible to have the kustomize docs published to your forks github pages.
### Setup GitHub Pages for the fork
1. Go to the *forked repo's* **Settings** tab
- e.g. [https://github.com/pwittrock/kustomize](https://github.com/pwittrock/kustomize)
2. Go to the **GitHub Pages** section
3. Set the source to master branch **/docs folder**
### Publish to the fork's GitHub Pages
{{% pageinfo color="info" %}}
Changes must be pushed to the fork's **master branch** to be served as the fork's GitHub Page.
{{% /pageinfo %}}
1. Make a change to a file under `site/content`
2. Run `hugo` from the `site/` directory
3. Add the `site` and `docs` directories to the **master branch**
4. Commit and push the changes to the *remote fork's* **master branch**
5. After a few minutes, the docs should be served from the fork's GitHub Page
- e.g. [https://pwittrock.github.io/kustomize/](https://pwittrock.github.io/kustomize/)