pomerium
pomerium copied to clipboard
pomerium
Contributing link in the Pomerium Core README gives a 404
What happened?
Clicked on the contributing guide in https://github.com/pomerium/pomerium/blob/main/README.md results in a page not found in our docs, i.e. https://www.pomerium.com/docs/community/contributing
I'm not sure what the actual URL is supposed to be, but this would be a great first issue for someone.
@kenjenkins pointed out that it's still in the docs for 0.27 and was removed in https://github.com/pomerium/documentation/pull/1726, potentially by accident?
We can probably just bring it back @rjbeers @desimone. https://0-27-0.docs.pomerium.com/docs/community/contributing
Hi @AlexVCS, just assigned this to you. We're going to actually do the changes in the https://github.com/pomerium/pomerium repository. Just going to transfer this issue first.
@AlexVCS, I chatted with @desimone, and it would make more sense to have a CONTRIBUTONG.md in this repository and it would contain the contents of the contributing page https://0-27-0.docs.pomerium.com/docs/community/contributing.
In the README, update the broken link to the new CONTRIBUTING.md. Let me know if you have any questions.
Hey @nickytonline, sorry for the delay. I'd like to clarify, do I need to recreate the markdown from https://0-27-0.docs.pomerium.com/docs/community/contributing ? If so, there's no raw version of that markdown available, is there?
Alex, let's create a CONTRIBUTING.md and link to it in the README, with something along the lines of Interested in contributing to the project? See our [contributing guide](CONTRIBUTING.md). In CONTRIBUTING.md, copy all the markdown from https://github.com/pomerium/documentation/blob/0-27-0/content/docs/community/contributing.md
For this part of the markdown
You can use the GitHub Note special markdown syntax, e.g.
[!NOTE]
Highlights information that users should take into account, even when skimming.