Forward-merge release/2.2 into develop - #352
Merged
Merged
Conversation
#### Overview Fix the AI-Q 2.2 documentation publication contract and refresh release-facing documentation against the current `release/2.2` branch. The version selector had three independent sources of drift: - `conf.py` still rendered `version_match = 1.2.1` after the site was deployed under `2.2.0-rc1`. - `project.json` and the Sphinx release value had to be updated separately. - `../versions1.json` resolved to the publisher-managed root index on top-level pages but to the copied per-version file on nested pages. That copied file contained only one version and used the invalid `ai-blueprint` site slug. This change makes `docs/source/project.json` the single version authority, sets it to the exact `v2.2.0-rc1` artifact version, points every page at the canonical publisher-managed selector index, and removes the duplicated per-build `versions1.json`. The release-facing README, changelog, FAQ, troubleshooting, and navigation now cover Azure AI Search, You.com, Nimble, the standalone public MCP server, the workflow-configuration maintainer skill, and all eleven checked-in workflow profiles. The Nimble links use its canonical documentation, with narrowly scoped exclusions in both link checkers because Nimble's certificate chain is not accepted by Python/OpenSSL or the Node link checker. Developer impact: advancing the docs version now requires one edit to `project.json`; Sphinx and the NVIDIA Docs publisher consume the same value. #### DCO sign-off for the squash commit Signed-off-by: Ajay Thorve <AjayThorve@users.noreply.github.com> #### Validation ```text $ uv run ruff check docs/source/conf.py All checks passed! $ uv run ruff format --check docs/source/conf.py 1 file already formatted $ uv run --extra docs sphinx-build -M html docs/source docs/build -W --keep-going -n build succeeded. $ uv run --extra docs sphinx-build -M linkcheck docs/source docs/build -W --keep-going -n build succeeded. $ uv run python <metadata, config-inventory, and generated-HTML assertions> docs metadata, config inventory, and generated switcher contract: PASS $ uv run pre-commit run --files <complete PR diff> All applicable hooks passed, including Ruff, detect-secrets, and Markdown Link Check. ``` The live publisher index at `https://docs.nvidia.com/aiq-blueprint/versions1.json` currently reports `2.2.0-rc1`, `2.1.0`, `2.0.0`, and `1.2.1`. Generated top-level and nested pages both use that canonical index and match `2.2.0-rc1`. - [x] I ran the relevant local checks or explained why they are not applicable. - [x] I added or updated validation for behavior changes. - [x] I updated documentation for user-facing or contributor-facing changes. - [x] I confirmed this PR does not include secrets, credentials, or internal-only data. - [x] I certify this contribution under the Developer Certificate of Origin (DCO) and signed my commits with `git commit -s` or an equivalent sign-off. - [x] I replaced the DCO sign-off placeholder with my GitHub commit identity and kept the required angle brackets around the email address. #### Where should reviewers start? Start with `docs/source/conf.py`, `docs/source/project.json`, and the removal of `docs/source/versions1.json`; together they define the publication and selector invariant. Then review the config inventory in `README.md` and `docs/source/customization/configuration-reference.md`, followed by `docs/source/customization/you-com.md` and the Nimble link-check handling. #### Related Issues - Relates to #261, #308, #316, #319, and #334. ## Summary by CodeRabbit * **New Features** * Added documentation for You.com tools, configurable Nimble web search modes, Azure AI Search knowledge retrieval (API key and managed identity), and standalone MCP server setup. * Updated setup guidance with new Nimble/You.com data-source options. * **Documentation** * Expanded sources/integrations, authentication, and workflow configuration details. * Improved docs release metadata and versioning/switcher behavior; added additional configuration profiles and references. * Refreshed troubleshooting and FAQ entries for You.com and Azure AI Search. * **Chores** * Refreshed the secrets baseline metadata. * Improved markdown link-check ignore rules for specific Nimble URLs. Authors: - Ajay Thorve (https://github.com/AjayThorve) Approvers: - Eddy (https://github.com/eddy-nassif) - Kyle Zheng (https://github.com/KyleZheng1284) URL: #345
Author
|
SUCCESS - forward-merge complete. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Forward-merge triggered by push to release/2.2 that creates a PR to keep develop up-to-date. If this PR is unable to be immediately merged due to conflicts, it will remain open for the team to manually merge. See forward-merger docs for more info.