grafana / plugin-tools

Create Grafana plugins with ease.
https://grafana.com/developers/plugin-tools/
Apache License 2.0
57 stars 31 forks source link

Docs: Rename/move 'introduction' to 'key concepts' and fix broken links #926

Closed josmperez closed 3 months ago

josmperez commented 4 months ago

Complete 2nd stage of the plugin-tools site reorganization project. Move/rename site, fix broken links.

Fixes: https://github.com/grafana/plugin-tools/issues/925

github-actions[bot] commented 4 months ago

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.

josmperez commented 4 months ago

Eliminating no-changelog label because there were fixes of broken links in the packages.

josmperez commented 4 months ago

Changing to draft to allow for fixing of failing check and additional testing.

josmperez commented 4 months ago

Per Slack conversation, it's okay to ignore failing test. Moving from draft to review status.

CLAassistant commented 4 months ago

CLA assistant check
All committers have signed the CLA.

josmperez commented 3 months ago

@tolzhabayev @jackw @academo - Hi, I'm having difficulty testing some of the redirects. They look to be properly formed in the docusaurus/website/docusaurus.config.base.js file; also, when the old URL is entered into the browser's address bar, the links go to a page with the correct content. However, the page that is displayed appears at the wrong URL when testing on the dev server.

For example,

I guess this is some sort of caching issue, however I'm not sure and I would like to resolve this problem so the redirects can be properly tested before the PR is published.

Thoughts on what is going wrong and how to fix it?

tolzhabayev commented 3 months ago

@josmperez there were still some wrong links in this branch that's why the build did not work properly, and that's why it never actually got deployed to dev stage.

adding to that - it was quite outdated so the errors did not surface locally but only when running in CI.

We have made the fixes and pushed them directly in this branch and deployed to dev - so please pull your changes and now you should be able to see the redirects working.

josmperez commented 3 months ago

@josmperez there were still some wrong links in this branch that's why the build did not work properly, and that's why it never actually got deployed to dev stage.

adding to that - it was quite outdated so the errors did not surface locally but only when running in CI.

We have made the fixes and pushed them directly in this branch and deployed to dev - so please pull your changes and now you should be able to see the redirects working.

Excellent, thank you all for the troubleshooting assistance. I finished testing the files that couldn't be verified appropriately, and then fixed a few other errors as well.