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(v2): clarify instructions on docs-only mode #2395

Merged
merged 2 commits into from
Mar 10, 2020
Merged

docs(v2): clarify instructions on docs-only mode #2395

merged 2 commits into from
Mar 10, 2020

Conversation

phoqe
Copy link
Contributor

@phoqe phoqe commented Mar 10, 2020

Motivation

The docs-only mode instructions didn't work, this change clarifies the instructions and adds an additional step for the index page.

Have you read the Contributing Guidelines on pull requests?

Yes

Test Plan

N/A

Related PRs

#2378

@phoqe phoqe requested a review from wgao19 as a code owner March 10, 2020 07:31
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 10, 2020
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Mar 10, 2020

Deploy preview for docusaurus-2 ready!

Built with commit 8ecb1a4

https://deploy-preview-2395--docusaurus-2.netlify.com

Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

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

Did you test the changes? Please test it first since the previous way was incorrect.

Copy link
Contributor

@yangshun yangshun left a comment

Choose a reason for hiding this comment

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

I made some changes.

@yangshun yangshun merged commit 1b1b122 into facebook:master Mar 10, 2020
@phoqe
Copy link
Contributor Author

phoqe commented Mar 10, 2020

@yangshun Yes, I tested it. I am using those settings for my own site and haven’t run into any problems. But if the way you described it is the ”true way“ I‘ll adopt those new changes and integrate them into my site. Thank you.

@yangshun
Copy link
Contributor

I don't think using routeBasePath: '/' works because your generated path ends up having two slashes. I just tested the config of using empty string and it works better IMO. In your pages/index.js do remember to use useBaseUrl in case your base URL is not '/'.

@phoqe
Copy link
Contributor Author

phoqe commented Mar 10, 2020

Ah, that makes sense. Must have overlooked it, thanks for clarifying.

@yangshun yangshun added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 18, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: documentation This PR works on the website or other text documents in the repo.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants