Skip to content

Commit 572d191

Browse files
sundaramramaswamysundaramramaswamy
authored
Drop version quotes in documentation (#1089)
Commit 14c9769 fixed the _Getting Started_ page by dropping quotes around version strings as it meddles with some scripts creating the project from a template. This fixes the public documentation under The Basics (Windows) -> Get Started with Windows. However, Native Development (Windows) -> Getting Started is another public document illustrating how to create an RN library. This was missed out by the above commit. Resolves microsoft/react-native-windows#15181
1 parent aca98ba commit 572d191

7 files changed

Lines changed: 36 additions & 29 deletions

File tree

‎docs/.unbroken_exclusions‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,4 @@
11
!coreapp.md
2+
3+
# See issue 1090 about npmjs.com blocking requests with 403
4+
URL not found https://www.npmjs.com/package/react-native-windows while parsing new-architecture.md (HTTP 403)

‎docs/native-platform-getting-started.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ Before you get started, make sure you have installed all of the [development dep
1616

1717
Call the following from the place where you want your project directory to live:
1818

19-
<!-- Note, make sure `--react-native-version "XYZ"` are pointing to the correct NPM tags in the command below. -->
19+
<!-- Note, make sure `--react-native-version XYZ` are pointing to the correct NPM tags in the command below. -->
2020

21-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "nightly" for the RN version -->
22-
<!-- 2. For stable versions in versioned_docs use the semantic version, i.e. "^0.73.0" for the RN version -->
21+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `nightly` for the RN version -->
22+
<!-- 2. For stable versions in versioned_docs use the semantic version, i.e. `^0.73.0` for the RN version -->
2323

2424
<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. -->
2525

2626
```bat
27-
npx --yes create-react-native-library@0.48.9 --react-native-version "nightly" <projectName>
27+
npx --yes create-react-native-library@0.48.9 --react-native-version nightly <projectName>
2828
```
2929

3030
> **Note:** Replace `<projectName>` with the name of your library. The rest of this guide will assume you named your project `testlib`.
@@ -49,10 +49,10 @@ cd <projectName>
4949

5050
### Add React Native for Windows to your project's node dependencies
5151

52-
<!-- Note, make sure "version" is pointing to the correct react-native-windows NPM tag in the command below. -->
52+
<!-- Note, make sure `version` is pointing to the correct react-native-windows NPM tag in the command below. -->
5353

54-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "canary" -->
55-
<!-- 2. For other versions in versioned_docs use the version in the format "^0.XY.0" -->
54+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `canary` -->
55+
<!-- 2. For other versions in versioned_docs use the version in the format `^0.XY.0` -->
5656

5757
Next you'll want to add `react-native-windows` as a dependency:
5858

‎website/.unbroken_exclusions‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,10 @@ File not found native-api/ReactNativeHost-api-windows.md while parsing versioned
3232
File not found IViewManagerCreateWithProperties while parsing versioned_docs/version-0.76/view-managers.md
3333
File not found IViewManagerCreateWithProperties while parsing versioned_docs/version-0.79/view-managers.md
3434

35+
# See issue 1090 about npmjs.com blocking requests with 403
36+
URL not found https://www.npmjs.com/package/rnpm-plugin-windows while parsing versioned_docs/version-0.60/getting-started.md (HTTP 403)
37+
URL not found https://www.npmjs.com/package/react-native-macos while parsing versioned_docs/version-0.78/rnm-getting-started.md (HTTP 403)
38+
3539
#fix-unbroken.js auto-generated do not edit this line or below
3640
File not found new-architecture.md while parsing versioned_docs/version-0.79/app-publishing.md
3741
File not found run-windows-cli.md while parsing versioned_docs/version-0.79/autolink-windows-cli.md

‎website/versioned_docs/version-0.72/getting-started.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ For information around how to set up React Native, see the [React Native Getting
1414

1515
Remember to call `react-native init` from the place you want your project directory to live.
1616

17-
<!-- Note, make sure "version" is pointing to the correct react-native NPM tag in the command below. -->
17+
<!-- Note, make sure `version` is pointing to the correct react-native NPM tag in the command below. -->
1818

19-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "nightly" -->
20-
<!-- 2. For the latest stable version in versioned_docs use "latest" -->
21-
<!-- 3. For older stable versions use the stable tag name, i.e. "0.72-stable" -->
19+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `nightly` -->
20+
<!-- 2. For the latest stable version in versioned_docs use `latest` -->
21+
<!-- 3. For older stable versions use the stable tag name, i.e. `0.72-stable` -->
2222

2323
<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. -->
2424

2525
```bat
26-
npx react-native@0.72-stable init <projectName> --version "0.72-stable"
26+
npx react-native@0.72-stable init <projectName> --version 0.72-stable
2727
```
2828

2929
### Navigate into this newly created directory

‎website/versioned_docs/version-0.73/getting-started.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,16 +14,16 @@ For information around how to set up React Native, see the [React Native Getting
1414

1515
Remember to call `react-native init` from the place you want your project directory to live.
1616

17-
<!-- Note, make sure "version" is pointing to the correct react-native NPM tag in the command below. -->
17+
<!-- Note, make sure `version` is pointing to the correct react-native NPM tag in the command below. -->
1818

19-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "nightly" -->
20-
<!-- 2. For the latest stable version in versioned_docs use "latest" -->
21-
<!-- 3. For older stable versions use the stable tag name, i.e. "0.73-stable" -->
19+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `nightly` -->
20+
<!-- 2. For the latest stable version in versioned_docs use `latest` -->
21+
<!-- 3. For older stable versions use the stable tag name, i.e. `0.73-stable` -->
2222

2323
<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. -->
2424

2525
```bat
26-
npx --yes react-native@0.73-stable init <projectName> --version "0.73-stable"
26+
npx --yes react-native@0.73-stable init <projectName> --version 0.73-stable
2727
```
2828

2929
### Navigate into this newly created directory

‎website/versioned_docs/version-0.74/getting-started.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,17 @@ For information around how to set up React Native, see the [React Native Getting
1414

1515
Remember to call `@react-native-community/cli init` from the place you want your project directory to live.
1616

17-
<!-- Note, make sure both `@react-native-community/cli@ABC` and `--version "XYZ"` are pointing to the correct NPM tags in the command below. -->
17+
<!-- Note, make sure both `@react-native-community/cli@ABC` and `--version XYZ` are pointing to the correct NPM tags in the command below. -->
1818

19-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "next" for the CLI and "nightly" for the RN version -->
20-
<!-- 2. For the latest stable version in versioned_docs use "latest" for both the CLI and RN version -->
21-
<!-- 3. For older stable versions you'll have to look up the CLI version, but for the RN version use the stable tag name, i.e. "0.73-stable" -->
19+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `next` for the CLI and `nightly` for the RN version -->
20+
<!-- 2. For the latest stable version in versioned_docs use `latest` for both the CLI and RN version -->
21+
<!-- 3. For older stable versions you'll have to look up the CLI version, but for the RN version use the stable tag name, i.e. `0.73-stable` -->
2222

2323
<!-- See https://www.npmjs.com/package/@react-native-community/cli?activeTab=versions for the CLI version tags. -->
2424
<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. -->
2525

2626
```bat
27-
npx --yes @react-native-community/cli@latest init <projectName> --version "0.74-stable"
27+
npx --yes @react-native-community/cli@latest init <projectName> --version 0.74-stable
2828
```
2929

3030
### Navigate into this newly created directory

‎website/versioned_docs/version-0.79/native-platform-getting-started.md‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -17,15 +17,15 @@ Before you get started, make sure you have installed all of the [development dep
1717

1818
Call the following from the place where you want your project directory to live:
1919

20-
<!-- Note, make sure `--react-native-version "XYZ"` are pointing to the correct NPM tags in the command below. -->
20+
<!-- Note, make sure `--react-native-version XYZ` are pointing to the correct NPM tags in the command below. -->
2121

22-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "nightly" for the RN version -->
23-
<!-- 2. For stable versions in versioned_docs use the semantic version, i.e. "^0.73.0" for the RN version -->
22+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `nightly` for the RN version -->
23+
<!-- 2. For stable versions in versioned_docs use the semantic version, i.e. `^0.73.0` for the RN version -->
2424

2525
<!-- See https://www.npmjs.com/package/react-native?activeTab=versions for the RN version tags. -->
2626

2727
```bat
28-
npx --yes create-react-native-library@0.48.9 --react-native-version "^0.79.0" <projectName>
28+
npx --yes create-react-native-library@0.48.9 --react-native-version ^0.79.0 <projectName>
2929
```
3030

3131
> **Note:** Replace `<projectName>` with the name of your library. The rest of this guide will assume you named your project `testlib`.
@@ -50,10 +50,10 @@ cd <projectName>
5050

5151
### Add React Native for Windows to your project's node dependencies
5252

53-
<!-- Note, make sure "version" is pointing to the correct react-native-windows NPM tag in the command below. -->
53+
<!-- Note, make sure `version` is pointing to the correct react-native-windows NPM tag in the command below. -->
5454

55-
<!-- 1. For the next version (i.e. in docs/getting-started.md) use "canary" -->
56-
<!-- 2. For other versions in versioned_docs use the version in the format "^0.XY.0" -->
55+
<!-- 1. For the next version (i.e. in docs/getting-started.md) use `canary` -->
56+
<!-- 2. For other versions in versioned_docs use the version in the format `^0.XY.0` -->
5757

5858
Next you'll want to add `react-native-windows` as a dependency:
5959

0 commit comments

Comments
 (0)