(MAINT) Sync reference docs #147
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This change syncs the reference documentation in the repository with the reference documentation published to the official docs site. This enables us to keep the reference documentation in the repository as the source of truth for the schemas and CLI. When there is a release or a fix to the documentation, the docs team will sync the docs as-needed. This should keep the friction lower for the engineering team, so they can adjust (or ping the docs team to adjust) reference documentation in the repository instead of tracking documentation across multiple repos. Primarily, the updates in this sync include: - Adding the required metadata - Fixing broken links - Fixing incorrect syntax
SteveL-MSFT
approved these changes
Aug 9, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
PR Summary
This change syncs the reference documentation in the repository with the reference documentation published to the official docs site.
PR Context
This enables us to keep the reference documentation in the repository as the source of truth for the schemas and CLI. When there is a release or a fix to the documentation, the docs team will sync the docs as-needed.
This should keep the friction lower for the engineering team, so they can adjust (or ping the docs team to adjust) reference documentation in the repository instead of tracking documentation across multiple repos.
Primarily, the updates in this sync include: