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: Rename/move 'introduction' to 'key concepts' and fix broken links #926

Merged
merged 26 commits into from
Jun 12, 2024

Conversation

josmperez
Copy link
Contributor

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

Fixes: #925

@josmperez josmperez added type/docs Changes only affect the documentation no-changelog Don't include in changelog and version calculations labels May 24, 2024
@josmperez josmperez self-assigned this May 24, 2024
@josmperez josmperez requested a review from a team as a code owner May 24, 2024 23:21
@josmperez josmperez requested review from leventebalogh and removed request for a team May 24, 2024 23:21
Copy link

github-actions bot commented May 24, 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.

@josmperez josmperez changed the title Docs: Rename 'introduction' to 'key concepts' and fix broken links Docs: Rename/move 'introduction' to 'key concepts' and fix broken links May 24, 2024
@josmperez josmperez removed the no-changelog Don't include in changelog and version calculations label May 25, 2024
@josmperez
Copy link
Contributor Author

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

@josmperez josmperez marked this pull request as draft May 25, 2024 00:10
@josmperez
Copy link
Contributor Author

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

@josmperez josmperez added patch Increment the patch version when merged no-changelog Don't include in changelog and version calculations and removed patch Increment the patch version when merged labels May 25, 2024
@josmperez
Copy link
Contributor Author

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

@josmperez josmperez marked this pull request as ready for review May 29, 2024 22:40
@CLAassistant
Copy link

CLAassistant commented Jun 5, 2024

CLA assistant check
All committers have signed the CLA.

@josmperez josmperez requested a review from academo June 6, 2024 22:52
@josmperez
Copy link
Contributor Author

josmperez commented Jun 7, 2024

@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
Copy link
Collaborator

tolzhabayev commented Jun 10, 2024

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

@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.

Copy link
Collaborator

@leventebalogh leventebalogh left a comment

Choose a reason for hiding this comment

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

LGTM 👍

docusaurus/docs/key-concepts/ui-extensions.md 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.

Some comments to address but once resolved, good to merge i believe

@josmperez josmperez merged commit 08b6717 into main Jun 12, 2024
18 of 19 checks passed
@josmperez josmperez deleted the josmperez/key branch June 12, 2024 21:26
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 skip-release 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
7 participants