Closed daniel-sanche closed 4 months ago
Here is the summary of changes.
This comment is generated by snippet-bot.
If you find problems with this result, please file an issue at:
https://github.com/googleapis/repo-automation-bots/issues.
To update this comment, add snippet-bot:force-run
label or use the checkbox below:
Added a feature to remove sections, and used it to remove the bottom "Bigtable" section. This section was a duplicate of the content we have in the two client folders
Changes
Previously, the devsite page for bigtable was messy, combining pages for both clients into a single list:
This change adds a post-processing step to
docfx
, to add sections for the two client types to the table of contents, to keep things organizedImplementation Details
The table of contents on devsite is configured through
docs/_build/html/docfx_yaml/toc.yml
, which is generated uisngnox -s docfx
as part of the release pipeline.This PR adds a new script called
patch_devsite_toc.py
, which is added as a post-processing step to the end ofnox -s docfx
to add new sections to the auto-generated table of contents.As part of the PR, all pages specific to each client have been moved into subfolders in the
docs/
directory. These sub-folders can then be referenced bypatch_devsite_toc.py
when adding new sections to the table of contentsTo avoid docs issues in the future, I also added a verification step to the new script, to make sure the table of contents remains formatted as expected
Staged page available to reviewers on request