Skip to content

Commit 2aada64

Browse files
committed
updates contributing page
1 parent 1bfe9c2 commit 2aada64

5 files changed

+41
-21
lines changed

content/docs/community/contributing.md

+41-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,64 @@ 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)
105+
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.
107+
108+
Committing your changes will create a new branch and start a PR.
101109

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

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).
105112

106-
![edit this page link using github](./img/contributing-edit-this-page-github.png)
107113

108114
### Bigger changes
109115

110116
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.
111117

112-
#### Pre-requisites
118+
#### Prerequisites
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+
We use [Docusaurus](https://docusaurus.io/) to generate our docs. Docusaurus is a React-powered static-site generator designed for documentation.
115121

116-
1. [Node.js](https://nodejs.org/en/download/).
117-
2. [Yarn](https://yarnpkg.com/lang/en/docs).
122+
Before building the docs, you'll need the following packages:
123+
124+
- [Node.js](https://nodejs.org/en/download/)
125+
- [Yarn](https://yarnpkg.com/lang/en/docs)
118126

119127
#### Make changes
120128

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.
129+
Once you've installed Node and Yarn, in a terminal run the following command:
130+
131+
```bash
132+
yarn start
133+
```
134+
135+
You should see a link to the development server:
122136

123137
```bash
124-
success [19:02:54] Build f9f5f7 finished in 246 ms! ( http://localhost:8081/ )
138+
[INFO] Starting the development server...
139+
[SUCCESS] Docusaurus website is running at: http://localhost:3001/
125140
```
126141

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

129144
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`.
130145

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.
146+
To make changes to the sidebar or navigation, see the following Docusaurus docs for instructions:
147+
148+
- [Sidebar](https://docusaurus.io/docs/sidebar)
149+
- [Navbar](https://docusaurus.io/docs/api/themes/configuration#navbar)
150+
151+
### PR previews
132152

133-
### PR Previews
153+
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.
134154

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.
155+
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.
136156

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

0 commit comments

Comments
 (0)