Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

website: surface contributing docs, extend them #3751

Closed
srenatus opened this issue Aug 19, 2021 · 0 comments
Closed

website: surface contributing docs, extend them #3751

srenatus opened this issue Aug 19, 2021 · 0 comments

Comments

@srenatus
Copy link
Contributor

There's some light documentation about contributing in

It would be nice if these were integrated into the website's documentation, under a new "Contributing" section.

This section could then be extended with more guides, for example

  • How do I contribute a new built-in function to core OPA?
  • Different ways to add a builtin, per rego.New() call, registered globally, or contributed to the main repo.
srenatus added a commit to srenatus/opa that referenced this issue Aug 24, 2021
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 <stephan.renatus@gmail.com>
dolevf pushed a commit to dolevf/opa that referenced this issue Nov 4, 2021
…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 <stephan.renatus@gmail.com>
Signed-off-by: Dolev Farhi <farhi.dolev@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant