You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardexpand all lines: content/docs/community/contributing.md
+39-21
Original file line number
Diff line number
Diff line change
@@ -8,8 +8,8 @@ description: This document describes how you can find issues to work on, fix/add
8
8
9
9
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.
10
10
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
13
13
14
14
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.**
15
15
@@ -35,12 +35,14 @@ Here are some of the expectations we have of contributors:
35
35
36
36
-**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.
@@ -93,46 +95,62 @@ Pomerium uses the [zerolog](https://github.com/rs/zerolog) package for logging.
93
95
94
96
## Docs
95
97
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.
97
99
98
100
### Simple edits
99
101
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
+

101
105
102
-

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.
103
107
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.
105
109
106
-

110
+

107
111
108
112
### Bigger changes
109
113
110
114
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.
111
115
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.
113
119
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:
115
121
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)
118
124
119
125
#### Make changes
120
126
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:
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.
134
152
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.
0 commit comments