You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- Add information or links to specific sections that are incomplete, by submitting a pull request
47
49
- 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
49
51
- Suggest improvements to our [user persona research](https://www.notion.so/efdn/Ethereum-org-User-Persona-Memo-b44dc1e89152457a87ba872b0dfa366c)
50
52
- 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)
51
54
52
55
Learn how to submit a pull request in the [Development Lifecycle](#deployment-lifecycle) section.
53
56
@@ -128,43 +131,35 @@ This team currently includes:
128
131
- Evan Van Ness (ConsenSys & Ethereum Foundation)
129
132
- Alan Woo (Independent designer & developer)
130
133
131
-
## Development
134
+
## Local development
132
135
133
-
### Unix/Mac
136
+
1.[Set up your development environment](https://www.gatsbyjs.org/tutorial/part-zero/)
137
+
138
+
2. Clone this project
134
139
135
140
```
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
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.
168
163
169
164
## Deployment Lifecycle
170
165
@@ -191,37 +186,7 @@ How updates are made to ethereum.org
191
186
192
187
-`master` is continually synced to Netlify and will automatically deploy new commits to etheruem.org
193
188
- 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
225
190
226
191
## Contributors
227
192
@@ -481,6 +446,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
481
446
482
447
<!-- markdownlint-enable -->
483
448
<!-- prettier-ignore-end -->
449
+
484
450
<!-- ALL-CONTRIBUTORS-LIST:END -->
485
451
486
452
This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!
0 commit comments