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 Guides pages #27

Conversation

rogeruiz
Copy link
Contributor

This patch migrates all the Backend Guides 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.

The PR builds on the work of #24 and must be merged before that PR can be merged into main.

@rogeruiz rogeruiz added the documentation Improvements or additions to documentation label Oct 21, 2021
@rogeruiz rogeruiz self-assigned this Oct 21, 2021
@rogeruiz rogeruiz mentioned this pull request Oct 23, 2021
This originally broke the build with this message:

```sh
? Server cache (99%) shutdown IdleFileCachePlugin
 stored

[Local Search] [INFO]: Gathering documents
[Local Search] [INFO]: Parsing documents
Unable to build website for locale "en".
Error: Redirect file creation error for "~/Developer/tmp/mymove-docs/build/docs/about/Overview-of-Milmove/index.html" path: Error: The redirect plugin is not supposed to override existing files..
    at writeRedirectFile (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/plugin-client-redirects/lib/writeRedirectFiles.js:78:15)
    at async Promise.all (index 0)
    at async Object.writeRedirectFiles [as default] (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/plugin-client-redirects/lib/writeRedirectFiles.js:83:5)
    at async Object.postBuild (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/plugin-client-redirects/lib/index.js:29:13)
    at async ~/Developer/tmp/mymove-docs/node_modules/@docusaurus/core/lib/commands/build.js:158:9
    at async Promise.all (index 9)
    at async buildLocale (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/core/lib/commands/build.js:154:5)
    at async tryToBuildLocale (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/core/lib/commands/build.js:32:20)
    at async Object.mapAsyncSequencial (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/utils/lib/index.js:263:24)
    at async build (~/Developer/tmp/mymove-docs/node_modules/@docusaurus/core/lib/commands/build.js:68:25)
error Command failed with exit code 1.
info Visit https://yarnpkg.com/en/docs/cli/run for documentation about this command.
```
@rogeruiz rogeruiz force-pushed the rogeruiz/mb-9609-migrate-backend-pages branch from bdff1c9 to fb4e560 Compare October 23, 2021 03:28
@rogeruiz rogeruiz force-pushed the rogeruiz/mb-9609-migrate-backend-guides-pages branch from b1c7deb to cc4f669 Compare October 23, 2021 03:45
rogeruiz added a commit that referenced this pull request Oct 23, 2021
This fixed the local `yarn build` and [addresses this
comment](#27 (comment)).
@rogeruiz rogeruiz force-pushed the rogeruiz/mb-9609-migrate-backend-guides-pages branch from 2673ebb to 74315f2 Compare October 30, 2021 04:50
@@ -275,3 +279,4 @@ var eventModels = map[KeyType]eventModel{


If you'd like to learn more about event triggers, you can find more details [here](https://github.com/transcom/mymove-docs/blob/720592c63db4bffe402a801417f7c14772573c28/docs/dev/contributing/backend/How-to-Add-an-Event-Trigger.md).

Copy link
Contributor

Choose a reason for hiding this comment

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

Sometimes I wonder if we should standardize on adding or not adding a newline at the end of the file.

@rogeruiz rogeruiz changed the base branch from rogeruiz/mb-9609-migrate-backend-pages to main November 2, 2021 04:28
@rogeruiz rogeruiz changed the base branch from main to rogeruiz/mb-9609-migrate-backend-pages November 2, 2021 04:31
@rogeruiz rogeruiz marked this pull request as ready for review November 2, 2021 04:38
@rogeruiz rogeruiz merged commit 7a69853 into rogeruiz/mb-9609-migrate-backend-pages Nov 2, 2021
@rogeruiz rogeruiz deleted the rogeruiz/mb-9609-migrate-backend-guides-pages branch November 2, 2021 04:39
@rogeruiz
Copy link
Contributor Author

rogeruiz commented Nov 2, 2021

Merging this in myself since it's not being merged into main directly.

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