-
Notifications
You must be signed in to change notification settings - Fork 26
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: set up the docs/ folder #593
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the "howtos"? is it "Debugging Guide"? or "Scenarios"?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is a very common terms used in technical documentation, usu. reserved for instructions on specific functionalities.
Examples:
In Azure documentation: https://learn.microsoft.com/en-us/azure/aks/scale-cluster?tabs=azure-cli
In GCP documentation: https://cloud.google.com/dataproc/docs/how-to
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
got it, do we need a troubleshooting folder?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Either way's OK with me. We could put in the how-to guides, or make a dedicated folder for it.
Merged to unblock the progress; approval acquired previously. If there's any concern, please let me know. |
Description of your changes
This PR features initial setup of the
docs/
folder for Fleet documentation on the upstream end.I have:
make reviewable
to ensure this PR is ready for review.How has this code been tested
N/A.
Special notes for your reviewer
N/A.