Skip to content

Commit 31f1fb0

Browse files
ZPain8464github-actions[bot]
authored andcommitted
Updates contributing page (#1363)
* updates contributing page * runs prettier
1 parent 9f144ff commit 31f1fb0

5 files changed

+39
-21
lines changed

content/docs/community/contributing.md

+39-21
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ description: This document describes how you can find issues to work on, fix/add
88

99
First of all, thank you for considering contributing to Pomerium! You can have a direct impact on Pomerium by helping with its code or documentation.
1010

11-
- To contribute to Pomerium, open a [pull request](https://github.com/pomerium/pomerium/pulls) (PR) to the Pomerium repository.
12-
- To contribute to the documentation, open a [pull request](https://github.com/pomerium/documentation/pulls) (PR) to the documentation repository.
11+
- To contribute to Pomerium, open a [pull request](https://github.com/pomerium/pomerium/pulls) (PR) to the Pomerium repository
12+
- To contribute to the documentation, open a PR to the documentation repository
1313

1414
If you're new to our community, that's okay: **we gladly welcome pull requests from anyone, regardless of your native language or coding experience.**
1515

@@ -35,12 +35,14 @@ Here are some of the expectations we have of contributors:
3535

3636
- **Use comments properly.** We expect good godoc comments for package-level functions, types, and values. Comments are also useful whenever the purpose for a line of code is not obvious.
3737

38-
- **Recommended reading**
38+
:::info **Recommended reading**
3939

40-
- [CodeReviewComments](https://github.com/golang/go/wiki/CodeReviewComments)
41-
- [Linus Torvalds describes a good commit message](https://gist.github.com/matthewhudson/1475276)
42-
- [Best Practices for Maintainers](https://opensource.guide/best-practices/)
43-
- [Shrinking Code Review](https://alexgaynor.net/2015/dec/29/shrinking-code-review/)
40+
- [**CodeReviewComments**](https://github.com/golang/go/wiki/CodeReviewComments)
41+
- [**Linus Torvalds describes a good commit message**](https://gist.github.com/matthewhudson/1475276)
42+
- [**Best Practices for Maintainers**](https://opensource.guide/best-practices/)
43+
- [**Shrinking Code Review**](https://alexgaynor.net/2015/dec/29/shrinking-code-review/)
44+
45+
:::
4446

4547
### Development
4648

@@ -93,46 +95,62 @@ Pomerium uses the [zerolog](https://github.com/rs/zerolog) package for logging.
9395

9496
## Docs
9597

96-
Pomerium's documentation is available at [https://www.pomerium.io/docs](https://www.pomerium.io/docs). If you find a typo, feel a section could be better described, or have an idea for a totally new application or section, don't hesitate to make a pull request change. There are few ways you can do this.
98+
Pomerium's documentation is available at [https://www.pomerium.io/docs](https://www.pomerium.io/docs). If you find a typo, feel a section could be better described, or have an idea for a totally new application or section, don't hesitate to make a PR change. There are few ways you can do this.
9799

98100
### Simple edits
99101

100-
The easiest way to fix minor documentation issues in Pomerium is to click on "Edit this page in Github" on any page.
102+
The easiest way to fix minor documentation issues in Pomerium is to click on the **Edit this page** link at the bottom of any page.
103+
104+
![Selecting the Edit this page link on a docs page](./img/contributing-edit-this-page.png)
101105

102-
![edit this page link](./img/contributing-edit-this-page.png)
106+
Doing so will redirect you to the the respective file in the Documentation repository. Here, you can [update the page](https://guides.github.com/features/mastering-markdown/) and commit your changes.
103107

104-
Doing so will create a [fork](https://help.github.com/en/articles/fork-a-repo) of the project, allow you to [update the page](https://guides.github.com/features/mastering-markdown/), and create a [pull request](https://help.github.com/en/articles/about-pull-requests).
108+
Committing your changes will create a new branch and start a PR.
105109

106-
![edit this page link using github](./img/contributing-edit-this-page-github.png)
110+
![Adding proposed changes in the docs repository](./img/contributing-proposed-changes.png)
107111

108112
### Bigger changes
109113

110114
If you need to add a new page, or would like greater control over the editing process you can edit the docs similar to how you would make changes to the source code.
111115

112-
#### Pre-requisites
116+
#### Prerequisites
117+
118+
We use [Docusaurus](https://docusaurus.io/) to generate our docs. Docusaurus is a React-powered static-site generator designed for documentation.
113119

114-
We use [VuePress](https://vuepress.vuejs.org) to generate our docs. Vuepress is a simple, [markdown](https://v1.vuepress.vuejs.org/config/#markdown) and [Vue.js](https://v1.vuepress.vuejs.org/config/#markdown) based static site generator. Before building the docs, you'll need to install the following pre-requisites.
120+
Before building the docs, you'll need the following packages:
115121

116-
1. [Node.js](https://nodejs.org/en/download/).
117-
2. [Yarn](https://yarnpkg.com/lang/en/docs).
122+
- [Node.js](https://nodejs.org/en/download/)
123+
- [Yarn](https://yarnpkg.com/lang/en/docs)
118124

119125
#### Make changes
120126

121-
Once you have Nodejs and Yarn installed, simply run `make docs` in a terminal which will install any required node packages as well as start up a development server. You should see something like the below, with a link to the local doc server.
127+
Once you've installed Node and Yarn, in a terminal run the following command:
122128

123129
```bash
124-
success [19:02:54] Build f9f5f7 finished in 246 ms! ( http://localhost:8081/ )
130+
yarn start
131+
```
132+
133+
You should see a link to the development server:
134+
135+
```bash
136+
[INFO] Starting the development server...
137+
[SUCCESS] Docusaurus website is running at: http://localhost:3001/
125138
```
126139

127140
Once you have the development server up and running, any changes you make will automatically be reloaded and accessible in your browser.
128141

129142
To add a new document, simply add a new file with the `.md` markdown extension. For example, this document would be `docs/community/contributing.md`.
130143

131-
To add a new document to the side or top-bar navigation, see `docs/.vuepress/config.js` and add that document to the desired section.
144+
To make changes to the sidebar or navigation, see the following Docusaurus docs for instructions:
145+
146+
- [Sidebar](https://docusaurus.io/docs/sidebar)
147+
- [Navbar](https://docusaurus.io/docs/api/themes/configuration#navbar)
148+
149+
### PR previews
132150

133-
### PR Previews
151+
We use [Netlify](https://www.netlify.com) to build and host our docs. A nice feature of Netlify is the [Deploy Preview URL](https://docs.netlify.com/site-deploys/deploy-previews/#deploy-preview-urls), which generates a link for PRs. This is helpful if you want to compare your local changes to what will ultimately be deployed in production.
134152

135-
We use [Netlify](https://www.netlify.com) to build and host our docs. One of nice features of Netlify, is that a preview of the docs are automatically created for each new pull request that is made, which lets you be sure that the version of your docs that you see locally match what will ultimately be deployed in production.
153+
After you've pushed your PR, a member of the documentation team will review your PR and communicate any next steps or suggestions before the PR is merged.
136154

137155
[configuration variables]: /docs/reference
138156
[docker compose]: https://docs.docker.com/compose/
Binary file not shown.
Loading
Loading
Binary file not shown.

0 commit comments

Comments
 (0)