Skip to content

Documentation improvements and refactoring #2736

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
csviri opened this issue Mar 19, 2025 · 0 comments · Fixed by #2737
Closed

Documentation improvements and refactoring #2736

csviri opened this issue Mar 19, 2025 · 0 comments · Fixed by #2737
Milestone

Comments

@csviri
Copy link
Collaborator

csviri commented Mar 19, 2025

It's not easy to read / follow the current documentation. Would like to improve it, by continuously improving based on the following guidelines:

  1. Would move sections like Patterns and Best Practices and Using sample Operators under Getting Started. These still would be separate pages, just under getting started.
  2. Breaking down features page to sub-pages around topics. Like EventSources, Retries,Implementing Reconciler, and Higher level abstractions. And continuously improve these docs.
  3. The page should always contains a simple introduction, and then basically a reference documentation that touches all the aspects and links also related integration tests.
@csviri csviri added this to the 5.1 milestone Mar 19, 2025
@csviri csviri changed the title Documentation re-structurizing Documentation improvements and refactoring Mar 19, 2025
@csviri csviri linked a pull request Mar 19, 2025 that will close this issue
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 a pull request may close this issue.

1 participant