Skip to content

Commit 1c55b8f

Browse files
authored
Merge pull request #1172 from ethereum/gatsby-readme
Update README for Gatsby [Fixes #1157]
2 parents 7fb320f + ae01c22 commit 1c55b8f

File tree

1 file changed

+25
-59
lines changed

1 file changed

+25
-59
lines changed

README.md

Lines changed: 25 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
11
<!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->
2+
23
[![All Contributors](https://img.shields.io/badge/all_contributors-190-orange.svg?style=flat-square)](#contributors)
3-
<!-- ALL-CONTRIBUTORS-BADGE:END -->
4-
[![Discord](https://img.shields.io/discord/714888181740339261?color=1C1CE1&label=ethereum.org%20%7C%20Discord%20%F0%9F%91%8B%20&style=flat-square)](https://discord.gg/CetY6Y4)
54

5+
<!-- ALL-CONTRIBUTORS-BADGE:END -->
6+
7+
[![Discord](https://img.shields.io/discord/714888181740339261?color=1C1CE1&label=ethereum.org%20%7C%20Discord%20%F0%9F%91%8B%20&style=flat-square)](https://discord.gg/CetY6Y4)
68

79
<h1 align="center" style="margin-top: 1em; margin-bottom: 3em;">
810
<p><a href="https://ethereum.org"><img alt="ethereum logo" src="./eth.png" alt="ethereum.org" width="125"></a></p>
@@ -42,12 +44,13 @@ Ethereum.org’s design and content is guided by three core principles:
4244
Keeping in mind the above core principles, there are many ways you can get involved in improving the website!
4345

4446
- Check out our [open issues](https://github.com/ethereum/ethereum-org-website/issues) and see if there are any you can help with
45-
- Join our [Translation Program](#translation-program)
47+
- Join our [Translation Program](https://ethereum.org/en/languages/#ethereum-org-translation-program)
4648
- Add information or links to specific sections that are incomplete, by submitting a pull request
4749
- Identify out-of-date information on ethereum.org (or linked to from ethereum.org) and submit a pull request
48-
- Submit new designs for the front-page HERO image - find the specs [here](https://github.com/ethereum/ethereum-org-website/blob/master/ethereum.org-hero-image-specs.pdf) and contact us at website@ethereum.org
50+
- Submit new designs for the front-page HERO image - contact us at website@ethereum.org
4951
- Suggest improvements to our [user persona research](https://www.notion.so/efdn/Ethereum-org-User-Persona-Memo-b44dc1e89152457a87ba872b0dfa366c)
5052
- Suggest ideas for new pages, new content, or other ways to improve ethereum.org by [opening an issue](https://github.com/ethereum/ethereum-org-website/issues/new/choose)
53+
- Follow progress and collaborate with our team on new features with us in our [Discord server](https://discord.gg/CetY6Y4)
5154

5255
Learn how to submit a pull request in the [Development Lifecycle](#deployment-lifecycle) section.
5356

@@ -128,43 +131,35 @@ This team currently includes:
128131
- Evan Van Ness (ConsenSys & Ethereum Foundation)
129132
- Alan Woo (Independent designer & developer)
130133

131-
## Development
134+
## Local development
132135

133-
### Unix/Mac
136+
1. [Set up your development environment](https://www.gatsbyjs.org/tutorial/part-zero/)
137+
138+
2. Clone this project
134139

135140
```
136-
# In the root folder:
137-
yarn global add vuepress
138-
yarn
139-
yarn dev
141+
$ git clone git@github.com:ethereum/ethereum-org-website.git && cd ethereum-org-website
140142
```
141143

142-
### Windows
143-
144-
- Download [node.js & npm](https://nodejs.org/en/download/)
145-
- Download [Yarn](https://yarnpkg.com/en/docs/install#windows-stable)
146-
- Download [Git Bash](https://git-scm.com/downloads)
147-
- Download the `master` branch
148-
- Navigate to the `/ethereum-org-website` folder
149-
- Right click and select `Git Bash Here`
150-
151-
Run the following commands:
144+
3. Install dependencies
152145

153146
```
154-
npm install -g yarn
155-
npm install -g vuepress
156-
yarn
157-
yarn dev
147+
$ yarn
158148
```
159149

160-
### Build
150+
4. Start developing!
161151

162152
```
163-
# In the root folder:
164-
yarn build
153+
yarn start
165154
```
166155

167-
The build should be exported to `/docs/.vuepress/dist` which can be deployed to a static host. We are hosting the site on Netlify, which handles this for us.
156+
### Learning Gatsby
157+
158+
Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start:
159+
160+
- **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process.
161+
162+
- **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar.
168163

169164
## Deployment Lifecycle
170165

@@ -191,37 +186,7 @@ How updates are made to ethereum.org
191186

192187
- `master` is continually synced to Netlify and will automatically deploy new commits to etheruem.org
193188
- The [website team](https://github.com/ethereum/ethereum-org-website#-how-are-decisions-about-the-site-made) will periodically merge `dev` into `master` (typically multiple times per week)
194-
- You can [view the history of releases](https://github.com/ethereum/ethereum-org-website/releases), with PR highlights
195-
196-
## Website Structure
197-
198-
Site content is in `/docs` folder. Everything else in `/docs/.vuepress`
199-
200-
## Testing
201-
202-
We use [Jest](https://jestjs.io/) to create unit test for Vue components under `/docs/.vuepress/component` and `/dosc/.vuepress/theme/components`.
203-
204-
The unit tests are placed next to the Vue components under `/docs/.vuepress/component/__tests__` and `/dosc/.vuepress/theme/components/__tests__`. And module mocks are created under `/dosc/.vuepress/theme/utils/__mocks__` for @theme/utils module.
205-
206-
Below commands will be helpful when you develop or test the Vue components.
207-
208-
1. Run all the Jest unit tests,
209-
210-
```bash
211-
yarn test
212-
```
213-
214-
2. Run unit tests for the changed file,
215-
216-
```bash
217-
yarn test -o
218-
```
219-
220-
3. Update the snapshot if you're sure the old results are obselete,
221-
222-
```bash
223-
yarn test --update-snapshot
224-
```
189+
- You can [view the history of releases](https://github.com/ethereum/ethereum-org-website/releases), which include PR highlights
225190

226191
## Contributors
227192

@@ -481,6 +446,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
481446

482447
<!-- markdownlint-enable -->
483448
<!-- prettier-ignore-end -->
449+
484450
<!-- ALL-CONTRIBUTORS-LIST:END -->
485451

486452
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!

0 commit comments

Comments
 (0)