fix: disable dashboard next version doc config#1915
Merged
Conversation
There was a problem hiding this comment.
Pull Request Overview
This PR disables the next version documentation task for the apisix-dashboard project to ensure that the documentation site renders properly. Key changes include:
- In scripts/sync-docs.js, a skip condition is added to bypass extracting next version documents for apisix-dashboard.
- In doc/docusaurus.config.js, the includeCurrentVersion flag is set to false for the dashboard documentation.
Reviewed Changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| scripts/sync-docs.js | Added a skip condition for apisix-dashboard to disable next version docs |
| doc/docusaurus.config.js | Disabled includeCurrentVersion for dashboard docs configuration |
| }, | ||
| { | ||
| title: `Extract ${project.name} next version documents`, | ||
| skip: () => project.name === 'apisix-dashboard', |
There was a problem hiding this comment.
Consider adding an inline comment to explain why the extraction is skipped for apisix-dashboard, referencing the temporary solution from the linked review.
| path: 'docs/apisix-dashboard', | ||
| showLastUpdateAuthor: true, | ||
| showLastUpdateTime: true, | ||
| includeCurrentVersion: false, |
There was a problem hiding this comment.
Adding an explanatory comment for disabling includeCurrentVersion would clarify that this setting is necessary to render the documentation site properly as a temporary measure.
bzp2010
approved these changes
May 16, 2025
juzhiyuan
approved these changes
May 16, 2025
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
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.
Fixes: #[Add issue number here]
Changes:
In order for the documentation site to render properly.
Temp solution from #1912 (review).
Screenshots of the change: