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

[Umbrella issue] Restructure Turtles documentation content #165

Open
6 tasks
furkatgofurov7 opened this issue Oct 17, 2024 · 0 comments
Open
6 tasks

[Umbrella issue] Restructure Turtles documentation content #165

furkatgofurov7 opened this issue Oct 17, 2024 · 0 comments
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request

Comments

@furkatgofurov7
Copy link
Contributor

furkatgofurov7 commented Oct 17, 2024

The current flow in the documents seems somewhat confusing to the Turtles' end users and consumers, so this is an umbrella issue mainly meant to improve the current document's user-friendly and easy-to-follow outline.

Things we could potentially improve:

  • Have an A-Z exemplary guide explaining the required steps starting from kind cluster creation til the CAPI cluster is imported into the Rancher Dashboard and visible in UI/CLI running in the infrastructure of certified providers (we might already have some parts of this covered in different places)
  • Restructure book sections to make them easy-to-follow and more end-user structured (move out HOW TO/A-Z guides to make them visible instead of hiding them under multiple sub-folders)
  • possible have a dedicated section for the Turtles features, each described and followed with 'how to use' example
  • Improve the content (rephrase/reword or change completely) to make it easier to read and follow wherever applicable
  • Make the docs more visual with extra screenshots/recordings/gifs wherever applicable
  • Remove unnecessary/outdated/confusing content
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/documentation Improvements or additions to documentation kind/enhancement New feature or request
Development

No branches or pull requests

2 participants