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): add section for docs-only mode #2378

Merged
merged 2 commits into from
Mar 8, 2020
Merged

docs(v2): add section for docs-only mode #2378

merged 2 commits into from
Mar 8, 2020

Conversation

phoqe
Copy link
Contributor

@phoqe phoqe commented Mar 7, 2020

Motivation

There's information on a Blog-only mode but there's none for a Docs-only mode. The same principle applies, and are documented in this documentation addition.

Have you read the Contributing Guidelines on pull requests?

Yes

@facebook-github-bot
Copy link
Contributor

Hi @phoqe!

Thank you for your pull request and welcome to our community.We require contributors to sign our Contributor License Agreement, and we don't seem to have you on file.

In order for us to review and merge your code, please sign at https://code.facebook.com/cla. If you are contributing on behalf of someone else (eg your employer), the individual CLA may not be sufficient and your employer may need to sign the corporate CLA.

If you have received this in error or have any questions, please contact us at cla@fb.com. Thanks!

@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Mar 7, 2020

Deploy preview for docusaurus-2 ready!

Built with commit abeec31

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

Copy link
Contributor

@lex111 lex111 left a comment

Choose a reason for hiding this comment

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

I am not against such additions, although it might be worth considering creating a new section for such issues, something like FAQ or Troubleshooting, to keep the pages as clean as possible.

website/docs/configuration.md Outdated Show resolved Hide resolved
@lex111 lex111 added the pr: documentation This PR works on the website or other text documents in the repo. label Mar 7, 2020
@lex111 lex111 requested a review from yangshun March 7, 2020 21:49
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Mar 7, 2020
@phoqe
Copy link
Contributor Author

phoqe commented Mar 7, 2020

@lex111 Yes, it feels like this section is a bit misplaced but there was no better place to put it since the info about the docs is a category and not a single page. Could maybe be a worthwhile mention in the setup for people that only want to use Docusaurus for the 'documentation' feature.

@lex111
Copy link
Contributor

lex111 commented Mar 7, 2020

@phoqe agree, so let's wait feedback from @yangshun

Co-Authored-By: Alexey Pyltsyn <lex61rus@gmail.com>
@facebook-github-bot
Copy link
Contributor

Thank you for signing our Contributor License Agreement. We can now accept your code for this (and any) Facebook open source project. Thanks!

@phoqe
Copy link
Contributor Author

phoqe commented Mar 7, 2020

By the way, it appears that using only that code snippet and removing the pages altogether will results in a 404. It seems that it's required to have a index.js with a Redirect component.

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.

Nice, thank you!

@yangshun yangshun merged commit ad3accd into facebook:master Mar 8, 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.

5 participants