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

Contributing link in the Pomerium Core README gives a 404 #5487

Open
nickytonline opened this issue Feb 19, 2025 · 6 comments
Open

Contributing link in the Pomerium Core README gives a 404 #5487

nickytonline opened this issue Feb 19, 2025 · 6 comments
Assignees
Labels
docs Docs update required good first issue Good for newcomers

Comments

@nickytonline
Copy link
Member

nickytonline commented Feb 19, 2025

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.

@nickytonline nickytonline added docs Docs update required good first issue Good for newcomers labels Feb 19, 2025
@nickytonline
Copy link
Member Author

@kenjenkins pointed out that it's still in the docs for 0.27 and was removed in pomerium/documentation#1726, potentially by accident?

We can probably just bring it back @rjbeers @desimone. https://0-27-0.docs.pomerium.com/docs/community/contributing

@nickytonline nickytonline transferred this issue from pomerium/pomerium Feb 19, 2025
@nickytonline nickytonline closed this as not planned Won't fix, can't repro, duplicate, stale Feb 19, 2025
@nickytonline nickytonline reopened this Feb 19, 2025
@nickytonline nickytonline changed the title Contributing link in the README gives a 404 Contributing link in the Pomerium Core README gives a 404 Feb 19, 2025
@AlexVCS
Copy link

AlexVCS commented Feb 19, 2025

Hey Nick, I’d like to work on this issue. Can you assign it to me please?

@nickytonline
Copy link
Member Author

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.

@nickytonline nickytonline transferred this issue from pomerium/documentation Feb 19, 2025
@nickytonline
Copy link
Member Author

nickytonline commented Feb 19, 2025

@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.

@AlexVCS
Copy link

AlexVCS commented Mar 4, 2025

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?

@nickytonline
Copy link
Member Author

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

Image

You can use the GitHub Note special markdown syntax, e.g.

Note

Highlights information that users should take into account, even when skimming.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Docs update required good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants