-
Notifications
You must be signed in to change notification settings - Fork 580
feat(community): New unversioned Community website section #1935
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
Conversation
d9bd338 to
c393408
Compare
|
I put this on this week's Helm dev meeting agenda. Don't want to merge yet until we discuss the governance docs in this location, etc. |
|
typos is triggered |
4ef9ccc to
5aa446c
Compare
paigecalvert
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Build looks good to me!
112a63b to
b7272a5
Compare
|
Do these changes imply further localization? There should be a Ukrainian version of https://deploy-preview-1935--helm-merge.netlify.app/uk/community/localization. I see that the page |
TerryHowe
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Some of this content I question the value of including like archived meeting notes and HIPs. Archived meeting notes should just be linked from current meeting notes and HIPS should be linked I think.
- create new docusaurus plugin instance for unversioned community docs - move files from docs/community to community directory - change a few page names and weights for better organization - fix links and add helm 4 notice to i18n pages behind main - remove community sections from versioned docs (v2, v3) - migrate i18n community translations to new plugin structure - update internal links to point to /community paths - add netlify redirect for legacy /docs/community URLs - update navbar to show community as top-level item - fix breadcrumbs label in community section Signed-off-by: Scott Rigby <[email protected]>
- add docusaurus-plugin-remote-content with configuration - create transformation utilities for imported content - add frontmatter injection and H1 title extraction - implement HIP-specific formatting with metadata tables - handle .txt file conversion with code block wrapping - configure link exceptions for special cases - add import notice headers to all imported files - update typos config to exclude imported files from checks - add custom index files for better organization Signed-off-by: Scott Rigby <[email protected]>
- create weekly scheduled workflow with manual trigger - automatically create or update PR with upstream changes - use DCO signoff for helm compliance - label PRs with docs and community tags Signed-off-by: Scott Rigby <[email protected]>
- document rationale in ARCHITECTURAL_DECISIONS.md - explain plugin configuration and workarounds - add contributor guidelines for community docs - document why files are committed to git - update README.md accordingly Signed-off-by: Scott Rigby <[email protected]>
b7272a5 to
2d5118e
Compare
@Andygol Good catch! I initially made a mistake and added an extra community subdir when automating the other community translations. I had moved the UK community translations to, eg |
|
Also squashed my commits into more sensible, easily reviewable commit groups. |
@TerryHowe I get where you’re coming from. For this PR, my goal was to pull everything from helm/community into the new A few folks told me they really like having the HIPs browsable on the site and included in global search, so that part might just come down to team preference. Importing the archived meeting notes did make me question whether that directory should even remain top-level in helm/community. And while pulling everything over, I noticed we have some pretty outdated files upstream that probably deserve a cleanup. For example:
Might be worth a group conversation about what should stay in helm/community, what should be archived or removed, and what should (or shouldn’t) get imported into the website. My instinct is that we clean things up in helm/community first, then adjust the importer configs accordingly. Curious what others think. |
TerryHowe
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
/lgtm
Might as well iterate on it. The content looked fine to me, my concerns were about maintenance.
Signed-off-by: Scott Rigby <[email protected]>
makes sense. I just pushed one more change before merging to keep the main docusaurus config file readable. Moved the community remote-content config to a separate file, following the sidebars config file naming pattern. Also merged the link exceptions config and documents config into a single config, and typed it. You can test it by doing: Also note I added the images to a separate remote-content instance. I didn't add this to package.json scripts, but you can test the same by running |
Fixes: - Broken anchor on source page path = /zh/docs/plugins/overview: -> linking to /zh/community/related#helm-plugins - Broken anchor on source page path = /zh/docs/topics/plugins: -> linking to /zh/community/related#helm-plugins Signed-off-by: Scott Rigby <[email protected]>
|
The only other broken anchors are from the imported HIPs capitalizing anchors. I made an upstream PR for that here helm/community#422 Thinking we should merge this PR first, then use chat upstream PR fix to test the gh action in this PR. |
Community docs are not specific to a Helm version. And our website should include content from the github helm/community repo, without duplication or manual effort to copy and ensure remote community pages are up to date. This PR addresses these in a sustainable way.