docs(sidebar): add missing contributor guide entries - #785
Conversation
hami-robot
Bot
added
the
kind/documentation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: ipsitapp8 The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
|
Warning Review limit reached
Next review available in: 18 minutes Limit details: You’ve used the included review currently available. You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository. How can I continue?Wait for the limit to reset, then comment An organization admin can change what happens after included review limits in Billing. How do review limits work?CodeRabbit enforces per-developer PR review limits within each organization. For paid Pro and Pro+ reviews, CodeRabbit uses a developer's included PR review attempts over the past 7 days to set the current hourly allowance. At typical activity levels, the full plan allowance applies. Higher sustained activity can lower the allowance until earlier attempts leave the 7-day window. Please refer docs for additional details. Review details⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (2)
✨ Finishing Touches🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
✅ Deploy Preview for project-hami ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
c739bc1 to
fff6428
Compare
Signed-off-by: ipsitapp8 <ipsitapp8@gmail.com>
fff6428 to
89ab3cc
Compare
|
The reason these documents are not included in the sidebar is that I don't think all of them need to be kept. Some of them contain outdated or incorrect information, such as the roadmap and contributor list, which are no longer necessary to maintain on the website. There are also some basic Git operation instructions that I don't think need to be part of the Contributor Guide. Instead of keeping these documents as they are, I think we should revisit and reorganize the structure and content of the entire |
|
@rootsongjc I only wired existing docs into the sidebar without checking whether they still hold up. Could you point me at which ones you'd cut (you mentioned roadmap and contributor list as outdated, plus the basic git instructions as out of scope for a Contributor Guide)? I'll narrow this PR to just the docs that are still accurate and worth surfacing, and leave the bigger Contributor directory reorganization as a separate follow-up rather than trying to fold it into this one. |
mesutoezdil
left a comment
mesutoezdil
left a comment
There was a problem hiding this comment.
verified all four files exist in en and zh, none are marked unlisted, ci is fully green. one gap inline.
…fix ordering The four new Contributor Guide entries (cherry-picks, lifted, adopters, contributors) only landed in the unversioned sidebar. The same four docs already exist in the versioned_docs/version-v2.9.0 snapshot, and v2.9.0 is the default version readers land on, so without this the pages were unreachable from the sidebar for most visitors. Added the same four entries to versioned_sidebars/version-v2.9.0-sidebars.json. Also moved lifted to sit next to cherry-picks in both sidebars instead of between roadmap and e2e-testing, they're both maintenance-process docs and read better grouped together. Signed-off-by: ipsitapp8 <ipsitapp8@gmail.com>
|
@mesutoezdil can you check the pr now if you have time? |
3 participants
What type of PR is this?
/kind documentation
What this PR does / why we need it:
Registers four existing documentation files under
docs/contributor/intosidebars.js:contributor/cherry-picks(How to cherry-pick PRs)contributor/lifted(How to manage lifted code)contributor/adopters(HAMi Adopters list and submission guide)contributor/contributors(Contributors list)These documents were present in the repository but not listed in
sidebars.js, making them unreachable through the site's sidebar navigation.Which issue(s) this PR fixes:
N/A
Checklist:
npm run lintandnpm run format:checkpassnpm run buildsucceeds for bothenandzhsidebars.js)git commit -s)