docs: correct documentation framework from Jekyll to Hugo and Docsy - #1180
Conversation
The "Documentation Contribution Flow" section stated that Layer5 documentation "uses Jekyll and GitHub Pages to host docs sites". This repository is built with Hugo and the Docsy theme: - hugo.toml is the site configuration - go.mod requires github.com/google/docsy v0.14.3 - there is no _config.yml or Gemfile anywhere in the tree The statement was also inconsistent with its own surrounding instructions, which already tell contributors to install Hugo and PostCSS to build the site. Correct the sentence so new contributors are not sent looking for a Jekyll toolchain that this project does not use. Signed-off-by: Will Calcote <53543954+willcalcote@users.noreply.github.com>
|
Yay, your first pull request! 👍 A contributor will be by to give feedback soon. In the meantime, please review the Layer5 Community Welcome Guide and sure to join the community Slack. |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Plus Run ID: 📒 Files selected for processing (1)
📝 WalkthroughWalkthroughThe contribution guidance now states that Layer5 documentation uses Hugo and the Docsy theme instead of Jekyll and GitHub Pages. ChangesDocumentation platform
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ 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 |
|
|
Thank you for contributing to the Layer5 community! 🎉 \ \ |
1 participant
Description
Corrects the documentation framework named in
CONTRIBUTING.md. The "Documentation Contribution Flow" section told contributors that Layer5 documentation "uses Jekyll and GitHub Pages to host docs sites". This repository is built with Hugo and the Docsy theme:hugo.tomlis the site configurationgo.modrequiresgithub.com/google/docsy v0.14.3_config.ymlorGemfileanywhere in the treeThe stale sentence also contradicted its own surrounding instructions, which already tell contributors to install Hugo and PostCSS in order to build the site. A new contributor reading top-to-bottom was told to set up a Jekyll toolchain this project does not use.
One line changed.
Why the account/organization deletion content is not in this PR
This branch was originally opened to also document account-deletion and organization-deletion behaviour: that deleting your account offers to delete a sole-membership organization, that you confirm with a checkbox plus typing the organization name, that free-plan organizations are permanently deleted while paid ones have their subscription cancelled at period end with data retained, and that shared resources require separate confirmation.
That content was verified against
layer5io/meshery-cloudmaster and does not describe the shipped product, so it has been deliberately left out. Today, account deletion soft-deletes the user record and removes the backing login identity - there is no organization handling, no organization deletion, no subscription cancellation and no ownership transfer anywhere in that path. The UI confirmation is a single Cancel/Proceed prompt with no checkbox and no name field.The wire contract for the feature did land in
meshery/schemas, but the corresponding design inmeshery-cloudis still marked Draft (design in review; pending final written-spec approval) and no PR implements it. The docs had been written from the design spec rather than from shipped behaviour.The draft also removed a statement that is accurate today - that only an Org Owner can delete an organization and Org Admins cannot (the route is gated by
AuthorizationMiddlewareForOrgOwnerplusAuthorizationMiddlewarePreventingLastOrgDeletion). That text is intentionally kept as-is.Publishing the rest would have given users steps they cannot follow on a page about irreversible, destructive actions. This is a deliberate exclusion, not an oversight - please do not re-add the deletion content until the feature exists in meshery-cloud.
Testing
hugo --gcbuilds clean (exit 0, 1579 pages, no errors or broken refs) on this branch rebased onto currentmaster.hugo.tomlanddocsyare present and no Jekyll configuration exists.Notes for reviewers
The framework correction is unrelated to the deletion content described above; it is called out separately here rather than buried, since the two arrived on the same branch.
Summary by CodeRabbit