Skip to content
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

Redesign Docs site navigation #452

Open
roraback opened this issue Apr 15, 2024 · 3 comments
Open

Redesign Docs site navigation #452

roraback opened this issue Apr 15, 2024 · 3 comments
Assignees

Comments

@roraback
Copy link

roraback commented Apr 15, 2024

Sections (names TBD—need to refine our language to ensure it resonates with new and returning users):

  • Homepage / Dashboard that links out to useful sections or articles (see Stripe docs for a great example of this)
  • Getting Started
  • Managing Access
  • End-User Guide (Connecting to Infrastructure)
  • Tutorials
  • Reference

Also want to feature search more prominently!

Photos of Post-It notes from the brainstorming session:
Image

Image

Image

Image

Image

@rishibarbhaya-design rishibarbhaya-design self-assigned this May 1, 2024
@rishibarbhaya-design
Copy link

For design updates, check this link
https://www.figma.com/design/VxtetU0SfDgD16KQANzAMU/Teleport-Documentation?node-id=162-7499&t=mmu5ynOmbKyKSUik-1

Designs and Annotations - In Progress

@rishibarbhaya-design
Copy link

Based on the feedback, we have landed on the following decisions
Click here to check Documentation Designs

  • Designs are ready but implementation is on hold till further notice.
  • The current page structure will be implemented as per @ptgott implementation Link
  • We need to wait for Docusaurus for the revised page structure. (Timeline not finalized)

@ptgott
Copy link
Contributor

ptgott commented Jul 10, 2024

On the Docs Team side, we're taking a more incremental approach to the docs site restructuring. Here is the first iteration, which condenses a number of sidebar sections into a single "Enroll Resources" section: gravitational/teleport#43979

We're going to have a comprehensive sidebar, eventually converging on:

  • Get Started
  • Admin Guides
  • Enroll resources
  • References
  • User Guides

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

No branches or pull requests

3 participants