Skip to content

Recategorizes most "Hubs Cloud" docs as "Administration" #207

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 2 commits into from
Apr 25, 2025

Conversation

DougReeder
Copy link
Contributor

@DougReeder DougReeder commented Apr 5, 2025

What?

  • Most "Hubs Cloud" docs are recategorized as "Administration"
  • Other Hubs Cloud docs are removed from navigation
  • References to Hubs Cloud were changed to Community Edition, when that made sense.
  • Adds a link to Hubs Foundation to the top bar
  • A few outside links were cleaned up

Why?

Hubs Cloud proper is gone, but most admin tools are present in Community Edition. What people see right now is confusing, or appears irrelevant:

image image

This pull request fixes that — we won't have to tell people "read this page, but ignore some of it..." We will have fewer people asking questions on Discord (or, worse, not asking questions and giving up) that could be answered by the docs.

It's also a large chunk to review. I'd rather polishing each page was a separate, later, pull request, so this pull request doesn't get any larger.

How to test

cd website
npm ci
npm run start
navigate to localhost:3000; observe revised navigation menu
skim Administration section

Limitations

Only a few screenshots were updated. The unchanged screen shots in the Admin section don't quite match the current UI, but are still quite useful.
After we've corrected all the incorrect info in the site, add added CE setup, we should move the Admin section to immediately after the CE setup pages.
We'll need new pages corresponding to a number of the pages that are currently hidden from navigation.

@DougReeder DougReeder requested a review from keianhzo April 25, 2025 16:00
@hobbs-Hobbler
Copy link
Contributor

hobbs-Hobbler commented Apr 25, 2025

Cursory review, LGTM. Following the philosophy of Voltaire in that "the best is the enemy of the good" so I agree that this should be updated ASAP to reduce issues in Discord. Vote for calling this "Hubs Admin Panel"

…e sense

Why: Kubernetes administration is distinct, and "Admin Panel" is used all over.
The headings on some pages did not create a useful navigation outline on the right.
@Exairnous
Copy link
Contributor

LGTM. Thanks. This will be a nice improvement.

@Exairnous Exairnous merged commit 4673399 into master Apr 25, 2025
5 checks passed
@Exairnous Exairnous deleted the cloud-to-community branch April 25, 2025 20:01
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.

3 participants