Skip to content

Contributing guide #1642

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

Merged
merged 7 commits into from
Jun 3, 2025
Merged

Contributing guide #1642

merged 7 commits into from
Jun 3, 2025

Conversation

cloudjumpercat
Copy link
Contributor

@cloudjumpercat cloudjumpercat commented May 29, 2025

Description

Fixes #1470

For reviewers

  • As noted in the linked GitHub issue, this doesn't cover everything from the existing Kong Docs contributing guide. This is just meant to document some of the main changes to formatting that other users need to know to contribute to the dev site. I've created an issue to migrate the relevant content from the existing guide here: Migrate the Kong Docs contributing/style guides #1641

Preview Links

https://deploy-preview-1642--kongdeveloper.netlify.app/contributing/

Checklist

  • Every page is page one.
  • Tested how-to docs. If not, note why here.
  • All pages contain metadata.
  • Updated sources.yaml. For more info, review track docs changes
  • Any new docs link to existing docs.
  • All autogenerated instructions render correctly (API, decK, Konnect, Kong Manager).
  • Style guide (capitalized gateway entities, placeholder URLs) implemented correctly.
  • Every page has a description entry in frontmatter
  • Add new pages to the product documentation index (if applicable)

@cloudjumpercat cloudjumpercat requested a review from a team as a code owner May 29, 2025 16:06
Copy link

netlify bot commented May 29, 2025

Deploy Preview for kongdeveloper ready!

Name Link
🔨 Latest commit 573e5e0
🔍 Latest deploy log https://app.netlify.com/projects/kongdeveloper/deploys/683f0123b3fb4200081a8e6d
😎 Deploy Preview https://deploy-preview-1642--kongdeveloper.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Signed-off-by: Diana <[email protected]>
cloudjumpercat and others added 2 commits June 2, 2025 10:35
Copy link
Contributor

@lena-larionova lena-larionova left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just one typo, otherwise lgtm!

I wonder if we can add a link to this guide from somewhere. At least in the dev site repo readme?

@cloudjumpercat
Copy link
Contributor Author

just one typo, otherwise lgtm!

I wonder if we can add a link to this guide from somewhere. At least in the dev site repo readme?

I've added a link to the guide in the README in my latest commit!

@cloudjumpercat cloudjumpercat merged commit c36f7ad into main Jun 3, 2025
11 checks passed
@cloudjumpercat cloudjumpercat deleted the style-guide branch June 3, 2025 14:11
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.

Contribution guide
2 participants