Skip to content

Other self-hosted docs improvements #11137

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

Closed
4 of 10 tasks
Tracked by #10464
lucasvaltl opened this issue Jul 5, 2022 · 1 comment
Closed
4 of 10 tasks
Tracked by #10464

Other self-hosted docs improvements #11137

lucasvaltl opened this issue Jul 5, 2022 · 1 comment
Labels
meta: stale This issue/PR is stale and will be closed soon

Comments

@lucasvaltl
Copy link
Contributor

lucasvaltl commented Jul 5, 2022

This is a placeholder ticket - these are follow up action items resulting from https://github.com/gitpod-io/website/pull/2337

  • Restructure repo: We should restructure the self-hosted docs in the repo to have one folder per subsection. This will break a lot of links though - I don't know how to best do this from an execution perspective.
  • UX improvements: This change makes the docs look empty. We should have the sub-menus default to open for the self-hosted section to facilitate jumping between them and facilitate discovery (at least until we have too many menu items that it becomes untenable). Should probably better indicate in the UI which menu items are a subsection to facilitate discovery of docs pages.
  • Rename Self-Hosted Section into Administer Gitpod
  • Rename current getting started guide into installation guide. Subsequently rename local preview into getting started. Move getting started (formerly local preview) to the top Self-Hosted hierarchy level
  • Should move TLS guide one level up the hierarchy (under installation Guides)
  • Split releases into release policy and upgrade guides (maybe move the latter to the operational guides section?
  • Need to improve the trouble shooting section with info on how to reach out to support / community.
  • Add background section for (future) topics like Architecture Basics, Disaster Recovery, Update strategies, and TLS certificates basics - once we have the first one of these.
  • Split How to update Gitpod docs into two - update guide and update strategies. Move update strategies into the background subsection.
  • Move reference architectures up one level once we have them in a V1 state and can remove the cluster set up guides
@stale
Copy link

stale bot commented Jan 3, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the meta: stale This issue/PR is stale and will be closed soon label Jan 3, 2023
@stale stale bot closed this as completed Jun 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
meta: stale This issue/PR is stale and will be closed soon
Projects
None yet
Development

No branches or pull requests

1 participant