Skip to content

Commit 7513481

Browse files
authoredDec 6, 2018
Update links to docs in all package README files (facebook#5912)
* Update links to docs in all package README files * Fix formatting of issue template * Fix formatting of issue template

File tree

8 files changed

+30
-26
lines changed

8 files changed

+30
-26
lines changed
 

‎.github/ISSUE_TEMPLATE.md

+14-10
Original file line numberDiff line numberDiff line change
@@ -6,12 +6,13 @@
66

77
(write your answer here)
88

9+
910
<!--
1011
If you answered "Yes":
11-
12+
1213
Please note that your issue will be fixed much faster if you spend about
1314
half an hour preparing it, including the exact reproduction steps and a demo.
14-
15+
1516
If you're in a hurry or don't feel confident, it's fine to report bugs with
1617
less details, but this makes it less likely they'll get fixed soon.
1718
@@ -37,14 +38,14 @@
3738
Then you need to decide which package manager you prefer to use.
3839
We support both npm (https://npmjs.com) and yarn (http://yarnpkg.com/).
3940
However, **they can't be used together in one project** so you need to pick one.
40-
41+
4142
If you decided to use npm, run this in your project directory:
4243
4344
npm install -g npm@latest
4445
npm install
4546
4647
This should fix your project.
47-
48+
4849
If you decided to use yarn, update it first (https://yarnpkg.com/en/docs/install).
4950
Then run in your project directory:
5051
@@ -62,19 +63,20 @@
6263

6364
(Write your answer here.)
6465

66+
6567
### Which terms did you search for in User Guide?
6668

6769
<!--
6870
There are a few common documented problems, such as watcher not detecting changes, or build failing.
6971
They are described in the Troubleshooting section of the User Guide:
7072
71-
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
73+
https://facebook.github.io/create-react-app/docs/troubleshooting
7274
7375
Please scan these few sections for common problems.
7476
Additionally, you can search the User Guide itself for something you're having issues with:
75-
76-
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md
77-
77+
78+
https://facebook.github.io/create-react-app/
79+
7880
If you didn't find the solution, please share which words you searched for.
7981
This helps us improve documentation for future readers who might encounter the same problem.
8082
-->
@@ -98,6 +100,7 @@
98100

99101
(paste the output of the command here)
100102

103+
101104
### Steps to Reproduce
102105

103106
<!--
@@ -154,13 +157,14 @@
154157

155158
(Paste the link to an example project and exact instructions to reproduce the issue.)
156159

160+
157161
<!--
158162
What happens if you skip this step?
159-
163+
160164
We will try to help you, but in many cases it is impossible because crucial
161165
information is missing. In that case we'll tag an issue as having a low priority,
162166
and eventually close it if there is no clear direction.
163-
167+
164168
We still appreciate the report though, as eventually somebody else might
165169
create a reproducible example for it.
166170

‎README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Create React App [![Build Status](https://travis-ci.org/facebook/create-react-app.svg?branch=master)](https://travis-ci.org/facebook/create-react-app) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/facebook/create-react-app/pulls)
1+
# Create React App [![Build Status](https://travis-ci.org/facebook/create-react-app.svg?branch=master)](https://travis-ci.org/facebook/create-react-app) [![PRs Welcome](https://img.shields.io/badge/PRs-welcome-green.svg)](https://github.com/facebook/create-react-app/pulls)
22

33
Create React apps with no build configuration.
44

@@ -111,7 +111,7 @@ You will see the build errors and lint warnings in the console.
111111
Runs the test watcher in an interactive mode.<br>
112112
By default, runs tests related to files changed since the last commit.
113113

114-
[Read more about testing.](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#running-tests)
114+
[Read more about testing.](https://facebook.github.io/create-react-app/docs/running-tests)
115115

116116
### `npm run build` or `yarn build`
117117

@@ -153,7 +153,7 @@ Your environment will have everything you need to build a modern single-page Rea
153153

154154
Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together.
155155

156-
The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject) and customize it, but then you will need to maintain this configuration.
156+
The tradeoff is that **these tools are preconfigured to work in a specific way**. If your project needs more customization, you can ["eject"](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject) and customize it, but then you will need to maintain this configuration.
157157

158158
## Popular Alternatives
159159

‎packages/babel-preset-react-app/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This package includes the Babel preset used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
7+
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
88

99
## Usage in Create React App Projects
1010

‎packages/create-react-app/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
This package includes the global command for [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
7+
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.

‎packages/eslint-config-react-app/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
7+
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
88

99
## Usage in Create React App Projects
1010

@@ -64,4 +64,4 @@ If you want to enable even more accessibility rules, you can create an `.eslintr
6464
}
6565
```
6666

67-
However, if you are using [Create React App](https://github.com/facebook/create-react-app) and have not ejected, any additional rules will only be displayed in the [IDE integrations](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#displaying-lint-output-in-the-editor), but not in the browser or the terminal.
67+
However, if you are using [Create React App](https://github.com/facebook/create-react-app) and have not ejected, any additional rules will only be displayed in the [IDE integrations](https://facebook.github.io/create-react-app/docs/setting-up-your-editor#displaying-lint-output-in-the-editor), but not in the browser or the terminal.

‎packages/react-dev-utils/README.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -3,16 +3,16 @@
33
This package includes some utilities used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
7+
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.
88

99
## Usage in Create React App Projects
1010

1111
These utilities come by default with [Create React App](https://github.com/facebook/create-react-app), which includes it by default. **You don’t need to install it separately in Create React App projects.**
1212

1313
## Usage Outside of Create React App
1414

15-
If you don’t use Create React App, or if you [ejected](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject), you may keep using these utilities. Their development will be aligned with Create React App, so major versions of these utilities may come out relatively often. Feel free to fork or copy and paste them into your projects if you’d like to have more control over them, or feel free to use the old versions. Not all of them are React-specific, but we might make some of them more React-specific in the future.
15+
If you don’t use Create React App, or if you [ejected](https://facebook.github.io/create-react-app/docs/available-scripts#npm-run-eject), you may keep using these utilities. Their development will be aligned with Create React App, so major versions of these utilities may come out relatively often. Feel free to fork or copy and paste them into your projects if you’d like to have more control over them, or feel free to use the old versions. Not all of them are React-specific, but we might make some of them more React-specific in the future.
1616

1717
### Entry Points
1818

‎packages/react-scripts/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
This package includes scripts and configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://facebook.github.io/create-react-app/docs/getting-started) – How to create a new app.
7+
- [User Guide](https://facebook.github.io/create-react-app/) – How to develop apps bootstrapped with Create React App.

‎packages/react-scripts/bin/react-scripts.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ switch (script) {
5959
console.log('Unknown script "' + script + '".');
6060
console.log('Perhaps you need to update react-scripts?');
6161
console.log(
62-
'See: https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#updating-to-new-releases'
62+
'See: https://facebook.github.io/create-react-app/docs/updating-to-new-releases'
6363
);
6464
break;
6565
}

0 commit comments

Comments
 (0)
Please sign in to comment.