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

[MB-9609] Migrate Backend all pages #24

Merged
merged 75 commits into from
Nov 3, 2021

Conversation

rogeruiz
Copy link
Contributor

@rogeruiz rogeruiz commented Oct 20, 2021

This patch migrates all the Backend Testing pages to its own section. Because of how the docs are setup in Docusaurus, they will start to appear on the top left so they are not integrated into “Docs” while we migrate more pages.

This PR is an amalgamation of other PRs, #27 #30.

@rogeruiz rogeruiz added the documentation Improvements or additions to documentation label Oct 20, 2021
@rogeruiz rogeruiz self-assigned this Oct 20, 2021
Copy link
Contributor Author

@rogeruiz rogeruiz left a comment

Choose a reason for hiding this comment

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

Leaving some helpful notes for any one curious how Docusaurus needs to be setup to be able to navigate around the documentation.

"position": 4,
"collapsed": true
}

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a placeholder for when this gets merged in so we can begin with other sections. Backend Setup cannot easily be worked on until this PR is merged.

"label": "Guides",
"position": 3,
"collapsed": true
}
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is a placeholder for when this gets merged in so we can begin with other sections. Backend Guides cannot easily be worked on until this PR is merged.

docId: 'backend/index',
position: 'left',
label: 'Backend',
},
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is how links to docs are added to the Header Navigation.

@@ -15,6 +15,10 @@ module.exports = {
type: 'autogenerated',
dirName: 'about',
}],
backendSidebar: [{
Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is how pages are added to the Sidebar Navigation.

@rogeruiz rogeruiz mentioned this pull request Oct 20, 2021
3 tasks
@rogeruiz
Copy link
Contributor Author

rogeruiz commented Oct 20, 2021

Because this is waiting for #25 to be merged into main, I'm converting this back to a Draft so I can add the redirects for all the missing pages so old links don't 404.

@rogeruiz rogeruiz marked this pull request as draft October 20, 2021 14:00
This was referenced Oct 22, 2021
@rogeruiz rogeruiz force-pushed the rogeruiz/mb-9609-migrate-backend-pages branch from bdff1c9 to fb4e560 Compare October 23, 2021 03:28
@rogeruiz rogeruiz changed the base branch from main to rogeruiz/mb-9609-migrate-backend-guides-pages November 2, 2021 04:29
@rogeruiz rogeruiz changed the base branch from rogeruiz/mb-9609-migrate-backend-guides-pages to main November 2, 2021 04:31
rogeruiz and others added 3 commits November 2, 2021 00:37
Merge remote-tracking branch 'origin/main' into rogeruiz/mb-9609-migrate-backend-pages
…-guides-pages

[MB-9609] Migrate Backend Guides pages
@rogeruiz rogeruiz changed the title [MB-9609] Migrate Backend testing pages [MB-9609] Migrate Backend all pages Nov 2, 2021
@rogeruiz rogeruiz requested a review from gidjin November 2, 2021 04:50
@rogeruiz rogeruiz marked this pull request as ready for review November 2, 2021 04:50
Comment on lines +90 to +101
// {
// label: 'Getting Started',
// to: '/docs',
// },
// {
// label: 'Help',
// to: '/docs/help',
// },
// {
// label: 'Vault',
// to: '/docs/vault',
// },
Copy link
Contributor Author

Choose a reason for hiding this comment

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

I commented this out, but it might make sense to just remove these? Although, Getting Started still exists as a page that can be navigated to via the Navigation Bar.

Comment on lines +188 to +195
redirects: (() => {
let redirects = [];
redirects.push(FrontendPages);
redirects.push(BackendPages);
redirects.push(ToolsPages);
redirects.push(APIPages);
return redirects.flat();
})(),
Copy link
Contributor Author

Choose a reason for hiding this comment

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

To me this makes a lot more sense given how large this file is becoming. There is probably more things we could modularize under the utils/ directory pattern.

Copy link
Contributor

@YanZ777 YanZ777 left a comment

Choose a reason for hiding this comment

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

Approving.
This is just to migrate the pages and not handle all the broken links, correct?

@rogeruiz
Copy link
Contributor Author

rogeruiz commented Nov 3, 2021

Thanks @YanZ777 🎉

This should also handle the broken links. but I'll use your approval here to merge things in and then we can handle broken links on a case by case basis if folks notice or bring it up in #wg-documentation.

@rogeruiz rogeruiz merged commit f1b9cbc into main Nov 3, 2021
@rogeruiz rogeruiz deleted the rogeruiz/mb-9609-migrate-backend-pages branch November 3, 2021 14:24
@YanZ777
Copy link
Contributor

YanZ777 commented Nov 3, 2021

Thanks @YanZ777 🎉

This should also handle the broken links. but I'll use your approval here to merge things in and then we can handle broken links on a case by case basis if folks notice or bring it up in #wg-documentation.

When I build Docusaurus I see a lot of broken link warnings. Maybe I didn't build cleanly? I agree though, we can handle broken links on a case by case basis.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Development

Successfully merging this pull request may close these issues.

3 participants