Skip to content

Commit 6c9432e

Browse files
authored
Merge pull request #12041 from ethereum/updateReadme
Update readme for Netlify and NextJS
2 parents 95d9989 + 1742367 commit 6c9432e

File tree

2 files changed

+9
-27
lines changed

2 files changed

+9
-27
lines changed

README.md

Lines changed: 9 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -46,9 +46,7 @@ More information on the issue creation process, and expectations around creating
4646

4747
If you're ready to contribute and create your PR, it will help to set up a local environment so you can see your changes.
4848

49-
1. [Set up your development environment](https://www.gatsbyjs.com/docs/tutorial/part-zero/)
50-
51-
2. Clone your fork
49+
1. Clone your fork
5250

5351
If this is your first time forking our repo, this is all you need to do for this step:
5452

@@ -72,7 +70,7 @@ git fetch upstream
7270
git merge upstream/dev
7371
```
7472

75-
3. Install dependencies
73+
2. Install dependencies
7674

7775
We recommend using a node manager to use multiple node versions in your system. We use [Volta](https://volta.sh/). In case you don't use a manager or you use `nvm`, you can check the currently supported versions under the `"volta"` section on our `package.json` file.
7876

@@ -97,9 +95,9 @@ yarn dev
9795
- Open this directory in your favorite text editor / IDE, and see your changes live by visiting `localhost:3000` from your browser
9896
- Pro Tip:
9997
- Explore scripts within `package.json` for more build options
100-
- Get **faster** local builds by building only one language. E.g. in your `.env` file, set `BUILD_LOCALES=en` to build the content only in English
98+
- Get **faster** production builds by building only one language. E.g. in your `.env` file, set `BUILD_LOCALES=en` to build the content only in English
10199

102-
By default the script will build all the languages (complete list in `i18n.config.json`) and will ignore the `/docs` and `/tutorials` folders. To control this behavior you can play with the `BUILD_LOCALES` and `IGNORE_CONTENT` env variables. Check out `.env.example` to read more about them.
100+
By default the script will build all the languages (complete list in `i18n.config.json`).
103101

104102
3. Commit and prepare for pull request (PR). In your PR commit message, reference the issue it resolves (see [how to link a commit message to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword)).
105103

@@ -113,40 +111,24 @@ git commit -m "brief description of changes [Fixes #1234]"
113111
git push
114112
```
115113

116-
### 5. Local development with lambda functions
117-
118-
There may be times where you develop features that make external API requests to other services. For these we write lambda functions to obfuscate API keys.
119-
120-
To use an existing function locally you don't need to do anything. Just check that you have set the necessary ENV variables in the `.env` file.
121-
122-
To create a new function, you will need to create two files:
123-
124-
- One in `src/lambda` where the logic will live. These are the ones that will be deployed to Netlify. These functions follow [this format](https://docs.netlify.com/functions/build-with-javascript/#synchronous-function-format).
125-
- One in `src/api` that will be just a wrapper around the previous one in order to be compatible with Gatsby functions. More on the [Gatsby docs](https://www.gatsbyjs.com/docs/reference/functions/getting-started/) for the format they follow.
126-
127-
Typically, you will develop and test functions in the Gatsby context, by running `yarn start`.
128-
129-
In case you want to test them as if you were in a Netlify env, you can install the [Netlify CLI](https://docs.netlify.com/cli/get-started/) and run `netlify dev --framework=gatsby`.
130-
131-
### 6. Submit your PR
114+
### 5. Submit your PR
132115

133116
- After your changes are committed to your GitHub fork, submit a pull request (PR) to the `dev` branch of the `ethereum/ethereum-org-website` repo
134117
- In your PR description, reference the issue it resolves (see [linking a pull request to an issue using a keyword](https://docs.github.com/en/free-pro-team@latest/github/managing-your-work-on-github/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword))
135118
- ex. `Updates out of date content [Fixes #1234]`
136-
- Gatsby Cloud (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.:
137-
![Gatsby Cloud deploy preview](./GC-preview-deploy.png)
138-
- _Confirm your GC preview deploy looks & functions as expected_
119+
- Netlify (our hosting service for build previews) deploys all PRs to a publicly accessible preview URL, e.g.: ![Netlify deploy preview](public/preview-deploy.png)
120+
- _Confirm your Netlify preview deploy looks & functions as expected_
139121
- Why not say hi and draw attention to your PR in [our discord server](https://discord.gg/ethereum-org)?
140122

141-
### 7. Wait for review
123+
### 6. Wait for review
142124

143125
- The website team reviews every PR
144126
- See [how decisions are made on content changes](https://ethereum.org/en/contributing/#how-decisions-about-the-site-are-made)
145127
- Acceptable PRs will be approved & merged into the `dev` branch
146128

147129
Learn more about how we review pull requests [here](docs/review-process.md).
148130

149-
### 8. Release
131+
### 7. Release
150132

151133
- `master` is continually synced to Netlify and will automatically deploy new commits to ethereum.org
152134
- Learn more about how we deploy the site [here](docs/deploy-process.md)

public/preview-deploy.png

53 KB
Loading

0 commit comments

Comments
 (0)