Skip to content

Commit

Permalink
Update contributing docs based on new website setup
Browse files Browse the repository at this point in the history
  • Loading branch information
mortent committed Sep 3, 2020
1 parent 3be8029 commit 0f14f81
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 22 deletions.
7 changes: 1 addition & 6 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,7 @@ but should be mostly understandable without following the links (e.g. when
reading the git commit log).
If you are updating the documentation, please do it in separate PRs from
code changes. Use the following structure for your documentation PR:
* The first commit in the PR should include the changes to the files under site/
and the name of the commit should start with `Docs:`.
* The second commit should be the generated content from running `make docs`.
The commit message should be `Regenerate docs`.
code changes and the commit message should start with `Docs:`.
**PLEASE REMOVE THIS COMMENT BLOCK BEFORE SUBMITTING THE PR** (the bits
between the arrows)
Expand Down
14 changes: 4 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,13 +49,8 @@ Conduct].

## Contributing to docs

If you are updating the documentation, please do it in separate PRs from code
changes. Use the following structure for your documentation PR:

- The first commit in the PR should include the changes to the files under
[site/] and the name of the commit should start with `Docs:`.
- The second commit should be the generated content from running `make docs`.
The commit message should be `Regenerate docs`.
If you are updating the documentation, please do it in separate PRs from
code changes and the commit message should start with `Docs:`.

### Run the docs locally

Expand All @@ -74,9 +69,8 @@ It's usually a good idea to test locally for the following:
### Update docs

Docs are under [site/] and use the [docsy] theme for hugo. Learn more about
docsy from [docsy docs]. Regenerate the docs with:

`make docs`
docsy from [docsy docs]. The site itself are generated from the markdown
automatically after commit.

### Adding or updating catalog functions

Expand Down
6 changes: 0 additions & 6 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,5 @@ gencatalog:
rm site/content/en/guides/consumer/function/catalog/_index.md
(cd site/content/en/guides/consumer/function/catalog/catalog && npm run gen-docs)

gendocs:
rm -rf docs/
(cd site && env HUGO_ENV="production" hugo)

docs: gencatalog lintdocs gendocs license

servedocs:
(cd site && go run github.com/gohugoio/hugo server)

0 comments on commit 0f14f81

Please sign in to comment.