Skip to content

Update readme and create more flushed out contributing documentation #11131

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 26 commits into from

Conversation

corwintines
Copy link
Member

@corwintines corwintines commented Sep 12, 2023

@gatsby-cloud
Copy link

gatsby-cloud bot commented Sep 12, 2023

✅ ethereum-org-website-dev deploy preview ready

@corwintines corwintines marked this pull request as draft September 13, 2023 01:33
@github-actions github-actions bot added content 🖋️ This involves copy additions or edits review needed 👀 labels Sep 14, 2023
@corwintines corwintines marked this pull request as ready for review September 15, 2023 05:16
@corwintines corwintines changed the title [DRAFT] Update readme Update readme and create more flushed out contributing documentation Sep 15, 2023
@rohan9024
Copy link
Contributor

Hey @corwintines ! Just noticed some extra spacing on this url --> https://ethereumorgwebsitedev01-readmeupdate.gatsbyjs.io/en/contributing/testing/#user-experience

image

  1. Is there any image to be rendered which is not being rendering ?
  2. On this link--> https://ethereumorgwebsitedev01-readmeupdate.gatsbyjs.io/en/contributing/code/#1.-submit-an-issue
    The links on the right side are not functional

For reference,
https://github.com/ethereum/ethereum-org-website/assets/64919642/2424fc75-9c92-4456-a5ef-ea1041132701

In the above video, I'm trying to click the links which should navigate me to that part.

  1. Feature Request: We can link the open issues on the contributing.md itself or have a separate page for it. Additionally, in order to let the developers gain confidence, we can have simple good first issues.

For reference: https://appwrite.io/community

  1. Adding New "Require Guidance Issue Template" and also label: When I click on create new issue, there are several templates like this-->
    image

We can add require guidance which can be helpful for developers who require assistance. Assistance can be related to setting up the project , problems related to codebase, structure, etc.

Lastly, I would love to work on these issues. Feel free to assign me.
Have a Great Day!😊

@konopkja
Copy link
Contributor

Screenshot 2023-09-25 at 19 48 51
can this just be a link to the folder in our GH repo?
https://github.com/ethereum/ethereum-org-website/tree/dev/src/content

@konopkja
Copy link
Contributor

Screenshot 2023-09-25 at 19 52 30

@corwintines this should have been simple bullet points, not a lengthy paragraph :P

@konopkja
Copy link
Contributor

Screenshot 2023-09-25 at 19 53 45

this should be under the headline, not at the end


---

If you would like to get involved in testing release candidates, please say hi in the `👾 | website-code` channel of the Discord. We also host bi-weekly community testing events held in Discord and [gather.town](https://www.gather.town/) where we all hop on together to test the release candidate. Come join and say hi!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you would like to get involved in testing release candidates, please say hi in the `👾 | website-code` channel of the Discord. We also host bi-weekly community testing events held in Discord and [gather.town](https://www.gather.town/) where we all hop on together to test the release candidate. Come join and say hi!

Comment on lines 13 to 15
## How to get involved

There are a number of ways to get involved with testing. We are looking for any content, design, or user experience bugs or regressions that may have been introduced in the release candidate.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
## How to get involved
There are a number of ways to get involved with testing. We are looking for any content, design, or user experience bugs or regressions that may have been introduced in the release candidate.
## How to get involved
We are looking for any content, design, or user experience bugs or regressions that may have been introduced in the release candidate.
If you would like to get involved, please say hi in the `👾 | website-code` channel of the Discord.
We also host bi-weekly community testing events held in Discord and [gather.town](https://www.gather.town/) where we all hop on together to test the release candidate. Come join and say hi!

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@corwintines have you thought about poap rewards for QA testing?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A bit. We currently don't offer anything, but I would like to see this as something we do for 2024.


The QA testing contributions is an initiative to test release candidates for ethereum.org before they are deployed into production. Testing is a vital part in a products release cycle to catch bugs and regressions that may have been introduced before a release.

On Tuesdays we create a release candidate that goes into the staging branch. Information about the release candidate will be posted in the `👾 | website-code` channel in our [Discord](https://discord.gg/ethereum-org). You can also find the release notes for the release candidate on the [releases page](https://github.com/ethereum/ethereum-org-website/releases) in the GitHub repository. The release candidate will be tagged as a `pre-release` until it has been merged into master. After QA testing, we deploy the release candidate into production if there are no release blocking bugs found on Thursday. More info on the deploy process for ethereum.org can be found [here](https://github.com/ethereum/ethereum-org-website/blob/dev/docs/deploy-process.md).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
On Tuesdays we create a release candidate that goes into the staging branch. Information about the release candidate will be posted in the `👾 | website-code` channel in our [Discord](https://discord.gg/ethereum-org). You can also find the release notes for the release candidate on the [releases page](https://github.com/ethereum/ethereum-org-website/releases) in the GitHub repository. The release candidate will be tagged as a `pre-release` until it has been merged into master. After QA testing, we deploy the release candidate into production if there are no release blocking bugs found on Thursday. More info on the deploy process for ethereum.org can be found [here](https://github.com/ethereum/ethereum-org-website/blob/dev/docs/deploy-process.md).
in the GitHub repository. The release candidate will be tagged as a `pre-release` until it has been merged into master. After QA testing, we deploy the release candidate into production if there are no release blocking bugs found on Thursday. More info on the deploy process for ethereum.org can be found [here](https://github.com/ethereum/ethereum-org-website/blob/dev/docs/deploy-process.md).
- **Every Tuesday** we create a release candidate that goes into the staging branch.
- Info about the release candidate is posted in the `👾 | website-code` channel in our [Discord](https://discord.gg/ethereum-org).
- Find the release notes for the release candidate on the [releases page](https://github.com/ethereum/ethereum-org-website/releases)
- The release candidate will be tagged as a `pre-release`
- **On Thursday** the release candidate is published on production.
- More info on the deploy process for ethereum.org can be found [here](https://github.com/ethereum/ethereum-org-website/blob/dev/docs/deploy-process.md).

Copy link

netlify bot commented Jan 24, 2024

Deploy Preview for ethereumorg ready!

Name Link
🔨 Latest commit 71174c1
🔍 Latest deploy log https://app.netlify.com/sites/ethereumorg/deploys/65ce59782dc9e1000836a990
😎 Deploy Preview https://deploy-preview-11131--ethereumorg.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@wackerow
Copy link
Member

Just updated with latest from dev... Just noting this PR does not address the removal of Gatsby information; this is handled in #12041

Copy link
Member

@wackerow wackerow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice, left a few comments and suggestions

@wackerow wackerow marked this pull request as draft March 25, 2024 18:27
@wackerow wackerow added documentation 📖 Change or add documentation and removed documentation 📖 labels Apr 3, 2024
Copy link
Contributor

github-actions bot commented May 9, 2024

This issue is stale because it has been open 30 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label May 9, 2024
@wackerow wackerow removed needs review 👀 Status: Stale This issue is stale because it has been open 30 days with no activity. labels May 22, 2024
Copy link
Contributor

This issue is stale because it has been open 30 days with no activity.

@github-actions github-actions bot added the Status: Stale This issue is stale because it has been open 30 days with no activity. label Jun 24, 2024
@github-actions github-actions bot added the abandoned This has been abandoned or will not be implemented label Sep 16, 2024
@corwintines corwintines deleted the readmeUpdate branch October 4, 2024 03:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
abandoned This has been abandoned or will not be implemented content 🖋️ This involves copy additions or edits documentation 📖 Change or add documentation Status: Stale This issue is stale because it has been open 30 days with no activity.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add documentation on how to create a new page
4 participants