-
-
Notifications
You must be signed in to change notification settings - Fork 8.7k
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): adding and specifying powershell and cmd for deployment in windows section #3459
Conversation
- specified batch command is for cmd - added powershell as an option for deployment, changed to single quotes
- 2.0.0-alpha.63 - 2.0.0-alpha.64 - Next (Dev)
Deploy preview for docusaurus-2 ready! Built without sensitive environment variables with commit bd1bfb2 |
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.
How about using tabs for this docs change?
- bash, windows, powershell, and cmd are now part of <tabs> - default value is bash
- Next (dev) now has better syntax - 2.0.0-alpha-63 and 2.0.0-alpha-64 now include the tabs as well
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.
Let's stick to following order: Bash - Windows (instead of "cmd")- PowerShell
- Labels now are first-letter uppercase - eg. bash -> Bash - cmd is now Windows to align with original docs
- Removed spacing at end of `values` statement - Removed spacing between `<Tabs>` and `<TabItem>` - build successful locally
@jeremyhager thank you! |
Thank you!! |
* Added powershell command for deployment - specified batch command is for cmd - added powershell as an option for deployment, changed to single quotes * - This affects the following versioned docs: - 2.0.0-alpha.63 - 2.0.0-alpha.64 - Next (Dev) * Changed deploy commands to tabbed - bash, windows, powershell, and cmd are now part of <tabs> - default value is bash * Changed deployment commands to tabs in v63 and 64 - Next (dev) now has better syntax - 2.0.0-alpha-63 and 2.0.0-alpha-64 now include the tabs as well * Updated lables in deploy and cmd to Windows - Labels now are first-letter uppercase - eg. bash -> Bash - cmd is now Windows to align with original docs * Removed `<Tab>` spacing in deploy section - Removed spacing at end of `values` statement - Removed spacing between `<Tabs>` and `<TabItem>` - build successful locally
Motivation
Refs: #3389
The documentation for deploying in a Windows environment may not be as specific as it needs to be, example issue: #3389. Because of this I have added a powershell command for Windows and have specified that one is for command prompt (title cmd) and the other is for PowerShell (title powershell).
Have you read the Contributing Guidelines on pull requests?
Yes
Test Plan
yarn build
cd website
yarn start
Current (before changes):
Proposed (after changes):
Related PRs.
N/A
(If this PR adds or changes functionality, please take some time to update the docs at https://github.com/facebook/docusaurus, and link to your PR here.)