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

[Docs] Many docs improvements #2170

Open
6 of 7 tasks
peterschmidt85 opened this issue Dec 31, 2024 · 0 comments · May be fixed by #2171
Open
6 of 7 tasks

[Docs] Many docs improvements #2170

peterschmidt85 opened this issue Dec 31, 2024 · 0 comments · May be fixed by #2171
Assignees
Labels
docs Improvements or additions to documentation

Comments

@peterschmidt85
Copy link
Contributor

peterschmidt85 commented Dec 31, 2024

  • Fix the issue with TOC
Screenshot 2024-12-25 at 20 43 38
  • Introduce Backends under Concepts with backend configuration examples moved from the reference
  • Improve the reference structure by making it easier to read
Screenshot 2024-12-31 at 23 51 10
  • Improve the reference structure by moving it before examples
  • Move Projects from Concepts to Guides and rename it to Administration (to focus not only on projects but on all aspects of administration)
  • Ensure Dev environments, Tasks, and Services are also under /concepts
  • Move major examples from the reference page to Concepts (e.g. Distributed tasks, Ports, Replicas and scaling, etc.)
@peterschmidt85 peterschmidt85 added the docs Improvements or additions to documentation label Dec 31, 2024
@peterschmidt85 peterschmidt85 self-assigned this Dec 31, 2024
@peterschmidt85 peterschmidt85 linked a pull request Dec 31, 2024 that will close this issue
@peterschmidt85 peterschmidt85 linked a pull request Dec 31, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant