Skip to content

Commit

Permalink
Update instruction for gh-pages deploy
Browse files Browse the repository at this point in the history
  • Loading branch information
yoshi-1224 authored and uberspot committed Aug 29, 2019
1 parent 7e05ad5 commit b600c7c
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@ Compiled minikube-es
- [Continuous Integration](CI.md)
- [Set up kapitan on older Python systems](pyenv-scl.md)

### Examples

- [Kubernetes](example-kubernetes.md)

## Credits

* [Jsonnet](https://github.com/google/jsonnet)
Expand Down
6 changes: 3 additions & 3 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,14 +73,14 @@ mkdocs serve

### 2. Submit a PR for gh-pages branch to deploy the update

Once the above PR has been merged, use `mkdocs gh-deploy` command to create and push a branch in your fork with the generated site content:
Once the above PR has been merged, use `mkdocs gh-deploy` command to push the commit that updates the site content to your own gh-pages branch. Make sure that you already have this gh-pages branch in your fork that is up-to-date with our gh-pages branch such that the two branches share the commit history (otherwise Github would not allow PRs to be created).

```
# locally, on master branch (which has your updated docs)
mkdocs gh-deploy -m "Commit message" -f ./mkdocs.yml -b remote_branch_name
mkdocs gh-deploy -m "Commit message" -f ./mkdocs.yml -b gh-pages
```

After it's pushed, create a PR that targets our gh-pages branch.
After it's pushed, create a PR that targets our gh-pages branch from your gh-pages branch.

## Contributor License Agreement

Expand Down

0 comments on commit b600c7c

Please sign in to comment.