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): adding and specifying powershell and cmd for deployment in windows section #3459

Merged
merged 6 commits into from
Sep 19, 2020

Conversation

jeremyhager
Copy link
Contributor

  • Specified batch command is for cmd
  • Added powershell as an option for deployment, changed outer quotes to single in deployment command
  • This affects the following versioned docs:
    • 2.0.0-alpha.63
    • 2.0.0-alpha.64
    • Next (Dev)

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

  1. ran yarn build
  2. cd website
  3. yarn start
  4. Implemented changes
  5. Confirmed changes were made on versioned docs specified above

Current (before changes):
image

Proposed (after changes):
image

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.)

- 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)
@docusaurus-bot
Copy link
Contributor

docusaurus-bot commented Sep 17, 2020

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit bd1bfb2

https://deploy-preview-3459--docusaurus-2.netlify.app

@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Sep 17, 2020
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.

How about using tabs for this docs change?

See https://v2.docusaurus.io/docs/markdown-features/#tabs

- 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
@jeremyhager
Copy link
Contributor Author

I've updated the docs to include the change - bundled bash, powershell, and cmd together so they are all tabs:
image

(bash is default). Let me know what you think

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.

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
Copy link
Contributor Author

Done and done. Noticed you specified "Bash" vs "_b_ash" as well as "PowerShell", so I've updated the labels to reflect that:
image

Had some issues with spaces and using <Tab> strangely, however it's been resolved now.

@jeremyhager jeremyhager requested a review from lex111 September 18, 2020 14:44
@lex111 lex111 merged commit 521ef59 into facebook:master Sep 19, 2020
@lex111
Copy link
Contributor

lex111 commented Sep 19, 2020

@jeremyhager thank you!

@jeremyhager
Copy link
Contributor Author

Thank you!!

@lex111 lex111 added this to the v2.0.0-alpha.65 milestone Sep 26, 2020
slorber pushed a commit that referenced this pull request Sep 29, 2020
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants