-
Notifications
You must be signed in to change notification settings - Fork 536
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(docs): Add some "how-to" documentation for website development #23311
Conversation
For reviewers:
|
docs/README.md
Outdated
|
||
These steps are based on Docusaurus's tutorial [here](https://docusaurus.io/docs/versioning#tutorials). | ||
|
||
Note: in order for API documentation to be available for the new version, you will need to ensure that API model artifacts are being published for the new major version series. |
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.
@zhenmichael I'd like to document the steps for setting up API model artifacts publishing for a new release branch, if possible. Hoping you can help me fill that in, assuming we have a process in place for that 🙂
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.
Looks good overall! The pubishing pipeline should automatically generate new artifacts in the blob storage the first time a new major version release version is run. As long as the config file is updated the download-apis step should have access the correct artifacts.
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.
Reads well and I like the references to the Docusaurus docs!
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.
Pretty clear IMO 👍
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.
Copilot reviewed 1 out of 2 changed files in this pull request and generated 1 suggestion.
Files not reviewed (1)
- .vscode/settings.json: Language not supported
Tip: Copilot only keeps its highest confidence comments to reduce noise and keep you focused. Learn more
docs/README.md
Outdated
|
||
These steps are based on Docusaurus's tutorial [here](https://docusaurus.io/docs/versioning#tutorials). | ||
|
||
Note: in order for API documentation to be available for the new version, you will need to ensure that API model artifacts are being published for the new major version series. |
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.
Looks good overall! The pubishing pipeline should automatically generate new artifacts in the blob storage the first time a new major version release version is run. As long as the config file is updated the download-apis step should have access the correct artifacts.
🔗 No broken links found! ✅ Your attention to detail is admirable. linkcheck output
|
Includes notes on:
AB#24262