|
1 |
| -# reactjs.org |
| 1 | +# legacy.reactjs.org |
2 | 2 |
|
3 |
| -This repo contains the source code and documentation powering [reactjs.org](https://reactjs.org/). |
| 3 | +This repo contains the source code and documentation powering [legacy.reactjs.org](https://reactjs.org/). |
4 | 4 |
|
5 |
| -## Getting started |
| 5 | +## Not actively maintained |
6 | 6 |
|
7 |
| -### Prerequisites |
| 7 | +This site is archived and not maintained. For new React docs, go to [react.dev](https://react.dev). |
8 | 8 |
|
9 |
| -1. Git |
10 |
| -1. Node: any 12.x version starting with v12.0.0 or greater |
11 |
| -1. Yarn v1: See [Yarn website for installation instructions](https://yarnpkg.com/lang/en/docs/install/) |
12 |
| -1. A fork of the repo (for any contributions) |
13 |
| -1. A clone of the [reactjs.org repo](https://github.com/reactjs/reactjs.org) on your local machine |
| 9 | +## Installation |
14 | 10 |
|
15 |
| -### Installation |
16 |
| - |
17 |
| -1. `cd reactjs.org` to go into the project root |
| 11 | +1. `cd legacy.reactjs.org` to go into the project root |
18 | 12 | 1. `yarn` to install the website's npm dependencies
|
19 | 13 |
|
20 |
| -### Running locally |
| 14 | +## Running locally |
21 | 15 |
|
22 |
| -1. `yarn dev` to start the hot-reloading development server (powered by [Gatsby](https://www.gatsbyjs.org)) |
| 16 | +1. `yarn dev` to start the development server (powered by [Gatsby](https://www.gatsbyjs.org)) |
23 | 17 | 1. `open http://localhost:8000` to open the site in your favorite browser
|
24 | 18 |
|
25 |
| -## Contributing |
26 |
| - |
27 |
| -### Guidelines |
28 |
| - |
29 |
| -The documentation is divided into several sections with a different tone and purpose. If you plan to write more than a few sentences, you might find it helpful to get familiar with the [contributing guidelines](https://github.com/reactjs/reactjs.org/blob/main/CONTRIBUTING.md#guidelines-for-text) for the appropriate sections. |
30 |
| - |
31 |
| -### Create a branch |
32 |
| - |
33 |
| -1. `git checkout main` from any folder in your local `reactjs.org` repository |
34 |
| -1. `git pull origin main` to ensure you have the latest main code |
35 |
| -1. `git checkout -b the-name-of-my-branch` (replacing `the-name-of-my-branch` with a suitable name) to create a branch |
36 |
| - |
37 |
| -### Make the change |
38 |
| - |
39 |
| -1. Follow the ["Running locally"](#running-locally) instructions |
40 |
| -1. Save the files and check in the browser |
41 |
| - 1. Changes to React components in `src` will hot-reload |
42 |
| - 1. Changes to markdown files in `content` will hot-reload |
43 |
| - 1. If working with plugins, you may need to remove the `.cache` directory and restart the server |
44 |
| - |
45 |
| -### Test the change |
46 |
| - |
47 |
| -1. If possible, test any visual changes in all latest versions of common browsers, on both desktop and mobile. |
48 |
| -1. Run `yarn check-all` from the project root. (This will run Prettier, ESLint, and Flow.) |
49 |
| - |
50 |
| -### Push it |
51 |
| - |
52 |
| -1. `git add -A && git commit -m "My message"` (replacing `My message` with a commit message, such as `Fix header logo on Android`) to stage and commit your changes |
53 |
| -1. `git push my-fork-name the-name-of-my-branch` |
54 |
| -1. Go to the [reactjs.org repo](https://github.com/reactjs/reactjs.org) and you should see recently pushed branches. |
55 |
| -1. Follow GitHub's instructions. |
56 |
| -1. If possible, include screenshots of visual changes. A preview build is triggered after your changes are pushed to GitHub. |
57 |
| - |
58 |
| -## Translation |
59 |
| - |
60 |
| -If you are interested in translating `reactjs.org`, please see the current translation efforts at [translations.reactjs.org](https://translations.reactjs.org/). |
61 |
| - |
62 |
| - |
63 |
| -If your language does not have a translation and you would like to create one, please follow the instructions at [reactjs.org Translations](https://github.com/reactjs/reactjs.org-translation#translating-reactjsorg). |
64 |
| - |
65 |
| -## Troubleshooting |
66 |
| - |
67 |
| -- `yarn reset` to clear the local cache |
68 |
| - |
69 | 19 | ## License
|
70 |
| -Content submitted to [reactjs.org](https://reactjs.org/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](LICENSE-DOCS.md) file. |
| 20 | +Content at [legacy.reactjs.org](https://legacy.reactjs.org/) is CC-BY-4.0 licensed, as found in the [LICENSE-DOCS.md](LICENSE-DOCS.md) file. |
0 commit comments