Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 13 commits into from
Jul 15, 2024

Conversation

josmperez
Copy link
Contributor

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: #925

Testing: Refer to design doc

@josmperez josmperez added the patch Increment the patch version when merged label Jul 8, 2024
@josmperez josmperez self-assigned this Jul 8, 2024
@josmperez josmperez requested a review from a team as a code owner July 8, 2024 22:43
@josmperez josmperez requested review from leventebalogh and removed request for a team July 8, 2024 22:43
Copy link

github-actions bot commented Jul 8, 2024

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.

@jackw jackw added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations and removed patch Increment the patch version when merged labels Jul 9, 2024
Copy link
Collaborator

@jackw jackw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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?

@josmperez
Copy link
Contributor Author

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.

Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's a few suggestions from the reorg proposal that were made in comments and haven't been reflected here - not sure if there was a change in plan which needs to be discussed or if it was just missed? Otherwise LGTM but we need to address those comments first before merging 🙂

Also even with the latest commit, there are no changes in the packages. I can see (at least) references to /extend-a-plugin pages within:

  • /packages/create-plugin/README.md
  • /packages/create-plugin/src/constants.ts
  • /packages/create-plugin/templates/common/.config/_eslintrc
  • /packages/create-plugin/templates/common/.config/jest-setup.js
  • /packages/create-plugin/templates/common/.config/jest.config.js
  • /packages/create-plugin/templates/common/.config/tsconfig.json
  • /packages/create-plugin/templates/common/.config/webpack/webpack.config.ts

docusaurus/docs/get-started/extend-configurations.md Outdated Show resolved Hide resolved
docusaurus/docs/get-started/set-up-github-workflows.md Outdated Show resolved Hide resolved
docusaurus/docs/get-started/work-with-backend.md Outdated Show resolved Hide resolved
docusaurus/docs/get-started/work-with-frontend.mdx Outdated Show resolved Hide resolved
docusaurus/docs/get-started/get-started.mdx Outdated Show resolved Hide resolved
Copy link
Contributor

@sympatheticmoose sympatheticmoose left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

@josmperez
Copy link
Contributor Author

josmperez commented Jul 12, 2024

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
Copy link
Contributor

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
Copy link
Contributor Author

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!

@josmperez josmperez merged commit 979e744 into main Jul 15, 2024
12 checks passed
@josmperez josmperez deleted the josmperez/reorg-moves branch July 15, 2024 17:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
no-changelog Don't include in changelog and version calculations type/docs Changes only affect the documentation
Projects
Development

Successfully merging this pull request may close these issues.

Reorganize plugin-tools site based on new design plan
4 participants