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.

Sign up for GitHub

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

Jump to bottom

Documentation: Cluster Core Concept Documentation #791

Open
Tracked by #463
elliotxx opened this issue Feb 10, 2025 · 2 comments
Open
Tracked by #463

Documentation: Cluster Core Concept Documentation #791

elliotxx opened this issue Feb 10, 2025 · 2 comments
Assignees
@MiirzaBaig
Labels
documentation Improvements or additions to documentation easy Suitable for beginners or junior developers help wanted Extra attention is needed priority/awaiting-more-evidence P3 Lowest priority. Possibly useful, but not yet enough interest in it.
Milestone
v0.8.0

Comments

@elliotxx
Copy link
Collaborator

elliotxx commented Feb 10, 2025 •
edited
Loading

What would you like to be added?

Enhance the documentation for Karpor Cluster core concept to provide clear and comprehensive information.

Requirements Source: #783

Why is this needed?

The current documentation lacks detailed explanations of Cluster core concepts, which may confuse users and hinder effective utilization of the feature. This enhancement will:

  1. Provide a thorough definition of Clusters in Karpor
  2. Detail key attributes and their significance
  3. Explain the Cluster lifecycle from creation to deletion
  4. Offer usage scenarios and practical examples.

This improved documentation will guide users in understanding and effectively managing Clusters within Karpor.
@elliotxx elliotxx added documentation Improvements or additions to documentation easy Suitable for beginners or junior developers priority/awaiting-more-evidence P3 Lowest priority. Possibly useful, but not yet enough interest in it. labels Feb 10, 2025
@elliotxx elliotxx modified the milestones: v0.7.0, v0.8.0 Feb 10, 2025
@github-actions github-actions bot mentioned this issue Feb 10, 2025
Open
18 tasks
@MiirzaBaig
Copy link

would like to work on this...

@elliotxx
Copy link
Collaborator Author

elliotxx commented Feb 11, 2025 •
edited
Loading

@MiirzaBaig I'm glad you're interested in this issue. You can put the document here and i18n. If you need any help, please feel free to contact me anytime

@elliotxx elliotxx added the help wanted Extra attention is needed label Feb 11, 2025
@github-actions github-actions bot mentioned this issue Feb 11, 2025
Open
36 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@MiirzaBaig MiirzaBaig

Labels
documentation Improvements or additions to documentation easy Suitable for beginners or junior developers help wanted Extra attention is needed priority/awaiting-more-evidence P3 Lowest priority. Possibly useful, but not yet enough interest in it.
Projects
None yet
Milestone
v0.8.0
Development

No branches or pull requests
2 participants
@elliotxx @MiirzaBaig