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: set up the docs/ folder #593

Merged
merged 7 commits into from
Nov 6, 2023
Merged

Conversation

michaelawyu
Copy link
Contributor

Description of your changes

This PR features initial setup of the docs/ folder for Fleet documentation on the upstream end.

I have:

  • Run 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.

Copy link
Contributor

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"?

Copy link
Contributor Author

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

Copy link
Contributor

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?

Copy link
Contributor Author

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.

zhiying-lin
zhiying-lin previously approved these changes Nov 6, 2023
@michaelawyu
Copy link
Contributor Author

Merged to unblock the progress; approval acquired previously.

If there's any concern, please let me know.

@michaelawyu michaelawyu merged commit 67d8a34 into Azure:main Nov 6, 2023
5 checks passed
@michaelawyu michaelawyu deleted the docs/setup branch November 6, 2023 12:11
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 this pull request may close these issues.

2 participants