-
Notifications
You must be signed in to change notification settings - Fork 6
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
Conversation
There was a problem hiding this 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 | ||
} | ||
|
There was a problem hiding this comment.
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 | ||
} |
There was a problem hiding this comment.
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', | ||
}, |
There was a problem hiding this comment.
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: [{ |
There was a problem hiding this comment.
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.
Because this is waiting for #25 to be merged into |
bdff1c9
to
fb4e560
Compare
Merge remote-tracking branch 'origin/main' into rogeruiz/mb-9609-migrate-backend-pages
…-guides-pages [MB-9609] Migrate Backend Guides pages
// { | ||
// label: 'Getting Started', | ||
// to: '/docs', | ||
// }, | ||
// { | ||
// label: 'Help', | ||
// to: '/docs/help', | ||
// }, | ||
// { | ||
// label: 'Vault', | ||
// to: '/docs/vault', | ||
// }, |
There was a problem hiding this comment.
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.
redirects: (() => { | ||
let redirects = []; | ||
redirects.push(FrontendPages); | ||
redirects.push(BackendPages); | ||
redirects.push(ToolsPages); | ||
redirects.push(APIPages); | ||
return redirects.flat(); | ||
})(), |
There was a problem hiding this comment.
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.
There was a problem hiding this 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?
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. |
This patch migrates all the Backend
Testingpages 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.