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

Make the Contributing Guide play nice with website #3063

Merged

Conversation

kichristensen
Copy link
Contributor

What does this change

The Contributing Guide is taken directly from CONTRIBUTING.md, while the formatting plays nice in the Github view, it breaks the ToC on the website. This changes changes the headings to make it work in both Github and on the website.

What issue does it fix

Closes #3062

Notes for the reviewer

Checklist

  • Did you write tests?
  • Did you write documentation?
  • Did you change porter.yaml or a storage document record? Update the corresponding schema file.
  • If this is your first pull request, please add your name to the bottom of our Contributors list. Thank you for making Porter better! 🙇‍♀️

The Contributing Guide is taken directly from CONTRIBUTING.md, while
the formatting plays nice in the Github view, it breaks the ToC on the
website. This changes changes the headings to make it work in both Github
and on the website.

Signed-off-by: Kim Christensen <kimworking@gmail.com>
@schristoff schristoff merged commit 5beb467 into getporter:main Apr 8, 2024
15 checks passed
@kichristensen kichristensen deleted the contribGuideWebsitePlayNice branch April 9, 2024 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"Top-level" links in the Contributing Guide on the website doesn't work
2 participants