Skip to content

Commit 3a1ce17

Browse files
committed
feat: create adding resource guide
1 parent 915065e commit 3a1ce17

File tree

1 file changed

+55
-0
lines changed
  • public/content/contributing/adding-resources

1 file changed

+55
-0
lines changed
Lines changed: 55 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,55 @@
1+
---
2+
title: Adding Resources
3+
description: The policy we use when adding resources to ethereum.org
4+
lang: en
5+
---
6+
7+
# Adding Resources {#adding-resources}
8+
9+
We want to make sure we list the best resources possible while keeping users safe and confident.
10+
11+
Anyone is free to suggest new resources to add to the resource dashboard on ethereum.org, currently found at [ethereum.org/resources](/resources/).
12+
13+
**Please only suggest new additions for this page.**
14+
15+
Although we welcome new additions, the current resources were chosen based on an experience we're trying to create for our users. These are based on some of our design principles:
16+
17+
- _Inspirational_: anything on ethereum.org should offer something new to users
18+
- _A good story_: what's listed should provide an "aha" moment
19+
- _Credible_: everything should be legitimate businesses/projects to minimize risk to users
20+
21+
Overall **ethereum.org aims to provide a seamless onboarding experience for new users**. For that reason, we add resources based on their:
22+
23+
- ease of use
24+
- accuracy
25+
- maintenance
26+
27+
## The decision framework {#decision-framework}
28+
29+
### Criteria {#criteria}
30+
31+
- **Honest and accurate listing information** - Any suggested listings must come with honest and accurate information. Products that falsify information will be removed.
32+
- **Active project** – The resource should be maintained by an active team to ensure quality and support for users. Outdated resources are subject to removal.
33+
34+
### Product Ordering {#product-ordering}
35+
36+
We reserve the right to order products based on their impact. New products will generally be added to the bottom of the list unless otherwise specified.
37+
38+
## Maintenance {#maintenance}
39+
40+
As the Ethereum ecosystem evolves, we will routinely check our content to:
41+
42+
- Ensure that all resources listed still fulfill our criteria
43+
- Verify there aren't products that have been suggested that meet more of our criteria than the ones currently listed
44+
45+
You can help with this by checking and letting us know. [Create an issue](https://github.com/ethereum/ethereum-org-website/issues/new?template=bug_report.yaml) or send an email to [[email protected]](mailto:[email protected]).
46+
47+
---
48+
49+
## Add your resource {#add-your-resource}
50+
51+
If you want to add a resource to ethereum.org and it meets the criteria, create an issue on GitHub.
52+
53+
<ButtonLink href="https://github.com/ethereum/ethereum-org-website/issues/new?assignees=&labels=resource+📚&template=suggest_resource.yaml">
54+
Create an issue
55+
</ButtonLink>

0 commit comments

Comments
 (0)