Chore: fix docs anchors #1778
Merged
Chore: fix docs anchors #1778
Conversation
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
github-project-automation
bot
moved this to 📬 Triage
in Plugins Platform / Grafana Community
tolzhabayev
added
documentation
tolzhabayev
moved this from 📬 Triage
to 🔬 In review
in Plugins Platform / Grafana Community
|
Hello! 👋 This repository uses Auto for releasing packages using PR labels. ✨ This PR can be merged. It will not be considered when calculating future versions of the npm packages and will not appear in the changelogs. |
tolzhabayev
commented
May 8, 2025
| @@ -30,6 +30,8 @@ yarn-error.log* | |||
| # Generated files | |||
| .docusaurus | |||
| .cache-loader | |||
| docusaurus/website/scripts/plugin.schema.json | |||
There was a problem hiding this comment.
added some files to .gitignore to avoid committing them accidentally
tolzhabayev
commented
May 8, 2025
|
|
||
| # Add docusaurus header to the top of the file | ||
| sed $SED_OPTS "1i\\ | ||
| sed -i.bak "1i\\ |
There was a problem hiding this comment.
Had to change a bit the way sed works as it was not working on my mac - it was creating metadata.md" file (yes with quotes at the end). Moved it towards a sed command that works on both mac and gnu
s4kh
approved these changes
May 8, 2025
tolzhabayev
commented
May 8, 2025
| @@ -31,6 +31,7 @@ const config: Config = { | |||
| baseUrl: 'developers/plugin-tools/', | |||
| onBrokenLinks: 'throw', | |||
| onBrokenMarkdownLinks: 'warn', | |||
| onBrokenAnchors: 'throw', | |||
There was a problem hiding this comment.
Fails now when broken anchors are detected, instead of only warning
academo
approved these changes
May 8, 2025
jackw
approved these changes
May 8, 2025
hugohaggmark
approved these changes
May 9, 2025
github-project-automation
bot
moved this from 🔬 In review
to 🚀 Shipped
in Plugins Platform / Grafana Community
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.
What this PR does / why we need it:
Fixing broken anchors, mostly related to anchors changing due to #1770
Making
onBrokenAnchorsthrow an error now to catch those broken anchors earlier.Special notes for your reviewer:
sedworks as it was not working on my mac - it was creatingmetadata.md"file (yes with quotes at the end). Moved it towards a sed command that works on both mac and gnuTesting