search

grafana / plugin-tools

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

Docs: Move/redirect files out of 'Create a plugin' folder #993

Closed josmperez closed 1 week ago

josmperez commented 2 weeks ago

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

Note: some links in the package were updated, so "patch" tag added

Instructions for testing redirects: docusaurus/website/README.md#Redirects

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

Testing: Refer to design doc

github-actions[bot] commented 2 weeks 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 2 weeks ago

LGTM! 🚀

Note: some links in the package were updated, so "patch" tag added

I can't see any changed links in package files so swapped out the patch label for docs and no-changelog. Maybe there's a commit missing here?

Instructions for testing redirects: docusaurus/website/README.md#Redirects

I cannot see any redirects added to the docusaurus config here. Should they be included in this PR?

Thanks. I forgot to check in the files outside the /docs directory. They are now checked in.

josmperez commented 1 week ago

The comments in the reorg proposal and PR review were about combining the content into other pages. As this was more complex and given time/date, I've gone ahead and made the changes directly, but I've tried to group the commits logically should we need to revert.

The changes I have made:

  1. 9c39436 Took content from Setting up GitHub Workflows and Extending config into Set up your development environment. Then adjusted layout somewhat on that page and fixed up links.
  2. a3b89f2 removed the Work with frontend/backend pages as these have generally felt confusing. I have merged this into the getting started guide and tried to tidy the workflow up generally within that page. Updating the SDK has been moved to the same page as the SDK itself. This is a relatively large commit as required a bunch of new snippets as well.
  3. bc16fb4 As I'd moved things around again, I updated the links you'd changed in create-plugin.

@josmperez These changes should definitely still be checked prior to merging. But the website is building without errors or missing links at least. Happy to jump on a call regarding the changes if helpful

@jackw from you I'm mostly re-asking for a review so you can see the structural changes as I'm not sure whether you'd seen in the google doc proposal.

These changes all look good so far. I'm okay with removing the "backend" and "frontend" topics for now; let's give more thought to how to repurpose or retire the content later.

I just need to check the links and wait for Jack's review and I'll merge later today or Monday.

sympatheticmoose commented 1 week ago

Sounds good - Jack won't be able to review till next week at this stage.

let's give more thought to how to repurpose or retire the content later

Just to be clear I have moved the unique content out of these pages.

josmperez commented 1 week ago

Thanks for your work on this topic, getting it across the finish line @sympatheticmoose @jackw @academo ! One small step for plugin-tools, one giant leap for mankind!