website: add contributing section #3752
Conversation
srenatus
force-pushed
the
sr/website/contributing
branch
2 times, most recently
from
a891087 to
e63c623
Compare
|
Alright, I'll move the development.md content and update the old files. Will have to figure out if the "Contributing" link that Github builds here can be altered, or would follow a symlink, or how it works in general... 👇 |
srenatus
force-pushed
the
sr/website/contributing
branch
from
e63c623 to
555734d
Compare
| @@ -5,9 +5,7 @@ weight: 30 | |||
| restrictedtoc: true | |||
| --- | |||
|
|
|||
| ## Monitoring | |||
There was a problem hiding this comment.
Found this looking a bit silly, updated:
⬇️
|
|
||
| ## Workflow | ||
|
|
||
| ### Fork, clone, create a branch |
There was a problem hiding this comment.
We had a list here, but that suffered from gohugoio/hugo#2928. So, reformatted this slightly...
|
Nit: Instead of just adding a link to the new location in the existing CONTRIBUTING.md and DEVELOPMENT.md doc, we could say something like "Want to contribute to OPA? Please refer to OPA's contribution guidelines to find out how you can help." Unless we plan to delete the file, not sure how that will look. |
|
I kind of like the simplicity of the symlink, see https://github.com/open-policy-agent/opa/tree/25643327cbe138d10659221ef266a9781d04e0a9, but I can add some words instead. |
There was a problem hiding this comment.
I kind of like the simplicity of the symlink, see https://github.com/open-policy-agent/opa/tree/25643327cbe138d10659221ef266a9781d04e0a9, but I can add some words instead.
I was looking at it from the pov of someone new wanting to contribute to OPA. But since we are adding a new section in the docs we can always point them there I think 🤷♂️ .
|
Thought about this some more, and I think you're right. Adding a sentence or two there doesn't cost us, and it's a nicer welcome. After all, the audience is potentially different, it's probably wrong to assume that all code-reading happens via github. I'll get that done tomorrow 👍 |
This is taken as-is from CONTRIBUTING.md for starters. The subsection markup has been adjusted as there can only be one "# header 1" in a document. Also done some light copy-editing. Also adds the DEVELOPMENT.md content, slightly reformatted because of bugs in our old hugo version. Code blocks in lists would look all wonky. Both CONTRIBUTING.md and DEVELOPMENT.md now refer to the corresponding website sections. As of now, it'll be `edge`, we can flip it to `latest` after the next release. Fixes open-policy-agent#3751. Signed-off-by: Stephan Renatus <[email protected]>
srenatus
force-pushed
the
sr/website/contributing
branch
from
2564332 to
3747472
Compare
|
https://github.com/open-policy-agent/opa/blob/3747472a12e0b8aadec79573046e0371198675e1/CONTRIBUTING.md is indeed better than a symlink. Could you please review this once more, @ashutosh-narkar? 😃 |
…agent#3752) This is taken as-is from CONTRIBUTING.md for starters. The subsection markup has been adjusted as there can only be one "# header 1" in a document. Also done some light copy-editing. Also adds the DEVELOPMENT.md content, slightly reformatted because of bugs in our old hugo version. Code blocks in lists would look all wonky. Both CONTRIBUTING.md and DEVELOPMENT.md now refer to the corresponding website sections. As of now, it'll be `edge`, we can flip it to `latest` after the next release. Fixes open-policy-agent#3751. Signed-off-by: Stephan Renatus <[email protected]> Signed-off-by: Dolev Farhi <[email protected]>
This is taken as-is from CONTRIBUTING.md for starters. The subsection
markup has been adjusted as there can only be one "# header 1" in a
document.