ethereum / ethereum-org-website

Ethereum.org is a primary online resource for the Ethereum community.
https://ethereum.org/
MIT License
5.08k stars 4.83k forks source link

Q4 2022 ethereum.org product roadmap #8399

Closed minimalsm closed 1 year ago

minimalsm commented 2 years ago

To make our work more accessible and to foster more community collaboration, our team publishes an overview of our quarterly roadmap goals. See last quarter's roadmap here: #7166.

Greetings fellow Ethereans!

Our vision with ethereum.org continues to be to create the best portal for Ethereum's growing community. We’re an educational resource focused on helping onboard millions of visitors to Ethereum each month. Here's a look at our major Q4 initiatives to advance this vision.

Quick point of clarification: this is the roadmap for ethereum.org the website, not the Ethereum protocol. If you’re looking for the Ethereum roadmap, check out information on Ethereum history, network upgrades and learn more about Ethereum governance.

With that out of the way, let’s dive in.

The must-haves

The epics our core team is committing to shipping this quarter.

🎨 Open design system

The design system (#6284) will have an important update this quarter 🏎.

Our goals Q4:

The secondary goal is to prepare the implementation of the design system, aiming to start coding in Q1 2023.

Want to get involved? Follow along in Figma and join the conversation in our #design Discord channel.

🖥 Implement UI library

We’ll continue to push forward the UI library migration that we kicked off in Q3 (#6374).

This epic is closely tied to the design system (#6284) - to improve our code quality, productivity, website accessibility and overall UX. In Q3, we began migrating our styling from styled-components to Chakra UI components. We are close to completing the first wave of the migration (66 components). Our goal for Q4 is to complete the migration of the remaining 62 components.

Community contributors have largely driven this initiative 🎉 massive thanks to everyone who contributed, and thank you in advance if you’re considering doing so in Q4 🙏

Want to get involved? Join the conversation in our #ui-library-migration Discord channel.

🦔 Build a new Geth website

The current Geth site has served its purpose for a long while but the website contains some incomplete information, lacks modern features like built-in search, and the overall aesthetics undersells what Geth has become: a core piece of Ethereum infrastructure and public good for the ecosystem.

This is another carryover initiative from Q3, where we created fresh designs and began implementation. Our Q4 plans are to finish development and ship the new Geth site 🚀

💖 HEART framework action items

This epic’s goal is to explore the sixty-five action items identified during the HEART framework analysis in Q3 (#7205). At a high level, these include UX improvements, process changes, and improved communication with contributors that will improve the translator experience.

Got a suggestion about how to improve the contributor experience? Let us know on Discord.

💯 Learning quizzes

The goal of learning quizzes is to ensure that readers can grasp the essential concepts of Ethereum more easily by gamifying the process. In Q3, we created a minimum viable product (#8094) and tested it with real-life users at Devcon. In Q4, we plan to make iterative improvements to the quiz component, quiz content, and to get this live on the website!

Along with our feedback surveys, we expect these quizzes to drive insights into how to improve our content resources further. Over the long term, we envision this will set the foundation for more structured, sequential learning resources (perhaps with Web3 gamification 👀?) on ethereum.org.

🌐 Upgrade i18n library

This epic covers tackling some technical debt on the codebase. We need a solution that solves the two main issues we have detected in recent investigations:

We’ll refactor our codebase from our current Gatsby i18n plugin (gatsby-theme-i18n) to one that scales well with large websites like ethereum.org. This change will improve developer productivity and improve page load times for visitors.

Follow along on GitHub.

🔮Launch KZG Ceremony Site

The KZG Ceremony is a prerequisite for Ethereum's current scaling path. The Ceremony is unprecedented in Ethereum's history; it requires thousands of community members to participate by adding their 'secret' to a pool. As long as one person destroys their secret (or loses, forgets, or doesn't save it), the Ceremony will be secure and successful.

We'll be helping with a historic moment on Ethereum by:

The goal is to have the site ready to launch by the end of November.

Want to learn more about the KZG Ceremony? Check out the KZG Ceremony Resources GitHub repo. or the #kzg-ceremony channel in the Eth R&D Discord.

🔭 Real-world case studies

When analyzing feedback gathered from ethereum.org users, one pattern emerged: users find the use cases of Ethereum too abstract and, therefore, the implications of real-life benefits of Ethereum intangible.

We’ll outline several case studies that demonstrate the significant real-world impact using Ethereum has had on people’s lives and create a plan of how to best fit content of this nature into our current site architecture and design.

Heard a story you think would be empowering to share? Let us know on Discord.

🔌 Revisit energy consumption pages

Since The Merge, Ethereum’s energy consumption figures have been carefully examined. We believe the current energy consumption content on ethereum.org is good, but there is potential to go deeper into this information than we currently do. As part of this epic, we will:

Want to get involved? Weigh in on the GitHub issue.

🏗 Revamp tutorials - https://github.com/ethereum/ethereum-org-website/issues/8491

Since launching in 2021, our developer tutorials have been a huge success. Our tutorials are purely driven by community contributions and 5% of all traffic to the website 🎉.

However, there are a few growing pains. It isn’t easy to sort through tutorials with the unwieldy (and growing) list of tags. In Q4, we plan to design a better structure for our tutorials section, such as categorizing different learning paths (e.g. frontend dapp development vs smart contract development). This may take the form of tutorial “playlists”, landing pages for tags, or a combination of features.

The maintenance of tutorials is also crucial to ensure they stay relevant (e.g. ensuring Solidity & library versions stay up to date). We’re seeking creative ways to collaborate with the community on this.

Additionally, a significant insight gathered from our user insights epic (#7226) is that many non-developers seek step-by-step guides on becoming successful users of Ethereum. We see the potential to broaden tutorials outside of mere developer tutorials to create non-technical guides.

Have thoughts on how to improve this? We’d love to chat. Please hop in our Discord 😀

The nice-to-haves

These epics are up next on our priority list. We’re not committing to shipping anything this quarter, but we plan to make progress on these and want to share these publicly so the community can give input and get involved!

🌎 Translation quality

We’re constantly thinking about how we can improve the quality of our non-English resources on ethereum.org. Improving translation quality involves collecting and categorizing feedback from professional linguists and our translation community and creating a list of typical inconsistencies in translations. Following this, we’ll create an action plan to follow up on the feedback and an approach to address the inconsistent translations.

Want to get involved? Come chat with us in the #translate channel on Discord.

👀 Research Dune API

In 2022, we started adding more statistics to the website. Through our user insights, we saw many users reporting that information supported by data was easier for them to grasp.

However, we've struggled with finding reliable APIs to consume and, in many places, need to hardcode stats for which we couldn't find an API. Recently, Dune Analytics announced that they are releasing an API for their dashboards. This creates many opportunities to consume a range of real-time data that would supplement content and allow us to move away from the hard-coded values, which quickly go out of date.

In Q4, we will explore the potential of being able to use Dune API and replace the API for hard-coded Dune stats that already exist on ethereum.org. This exploration will allow us to expand stats on the website further in the future.

Got a suggestion for an alternative data source we could use? Let us know on our Discord.

🌎 Clean up the EF blog

In Q3, we internationalized the Ethereum Foundation blog to support translations in many languages! A handful of clean-up tasks remain that were cut from the scope to get the blog into the hands of non-English speakers more quickly.

This epic consolidates the remaining items that were not critical for the initial launch but will help continue improving the user experience for blog visitors and writers. The epic primarily includes:

📢 External marketing

ethereum.org is the entryway into Ethereum for many new users. For others, they discover it much later and wish they had found it sooner. By being more thoughtful about promoting ethereum.org content, we will increase awareness of ethereum.org as a valuable public good in Ethereum education and help more people start their Ethereum journey.

This epic will include creating and tracking processes around how we are promoting new ethereum.org content and collaborating with strategic partners to spread our content's reach.

Close post-Merge gaps

The Merge is complete and was a success 🎉!

From our pre-Merge and post-Merge updates, there are a few additional tasks and ideas we’d like to implement over the next Q4 to more thoroughly cover Ethereum in a post-Merge world. We will fill specific gaps in the current technical documentation, specifically on:

Additionally, we’ll be auditing the site to remove links to external content no longer relevant in the post-Merge era.

Want to get involved? Join the conversation on GitHub or in our #merge Discord channel.

How does that sound?

We always appreciate feedback on our roadmap - if there's something you think we should work on, please let us know! We welcome ideas and PRs from anyone in the community.

Get involved: Learn more about contributing, hit us up on Twitter, or join the community discussions in our Discord.

Habibullah-Sahan commented 2 years ago

Is there any opportunity for a paid position after proving oneself by contributing?

samajammin commented 2 years ago

Hey @Habibullah-Sahan! Thanks for your interest.

Is there any opportunity for a paid position after proving oneself by contributing?

In short, potentially! Unfortunately, we can't provide any guarantees at the moment. Our team doesn't have any open paid roles at the moment. That said, whenever we do hire, we first look to our open-source community. Half of our 10-person team started out as community contributors on the project.

Again, I can't make any guarantees, but I suspect there's a solid chance our team makes additional hires in 2023.

malik672 commented 2 years ago

interested in this

yash251 commented 2 years ago

Would love to contribute to this @samajammin @minimalsm

samajammin commented 2 years ago

Great @malik672 @yash251 - please let us know how you'd like to get involved! Most epics have standalone issues, so feel free to join the discussion there or hop in our Discord if you want to chat with our team.

Gandalf-Dust-Wizard commented 2 years ago

@samajammin I'd like to chat with the team as there are a few different epics I think our team might be able to help with! I'm already in your discord, will I reach out there to one of the team? If so, who?

corwintines commented 2 years ago

Hey, @Gandalf-Dust-Wizard!

How would you like to get involved? Happy to chat about this either here or on discord.

github-actions[bot] commented 1 year ago

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

minimalsm commented 1 year ago

Happy New Year!

Closing out this issue with a progress update on our Q4 initiatives.

Our Q1 roadmap is cooking and will be out within the next few days.

🎨 Open design system

We've finished the markdown page layouts, added composed components to the design system, and prepared the design system for implementation.

In Q1, we'll put the finishing touches on the current design system ahead of its implementation.

Want to get involved? Follow along in Figma and join the conversation in our #design Discord channel.

🖥 Implement UI library

After our Q4 push on the chakra migration, we have now migrated roughly 75% of the components to Chakra. We'll continue this migration into Q1 with the goal of finishing all components.

Community contributors have largely driven this initiative 🎉 massive thanks to everyone who contributed 🙏.

Want to get involved? Join the conversation in our #ui-library-migration Discord channel.

🦔 Build a new Geth website

We shipped it 🚀! Geth is a core piece of infrastructure and public good for the Ethereum ecosystem. The new website delivers a fresh look and huge improvements to the website's user experience.

In Q1, we will have a small clean-up epic to tackle the remaining issues and bugs we discovered post-launch.

💖 HEART framework action items

We executed roughly 75% of the sixty-five actions identified during the HEART framework analysis (#7205) to improve the experience of contributors to our translation program.

In Q1, we'll finish the remaining action items to improve our contributor experience further.

Got a suggestion about how to improve the contributor experience? Let us know on Discord.

💯 Learning quizzes

We shipped learning quizzes to eight pages on ethereum.org. Initial feedback indicates users are benefitting from the quizzes, with users answering over 100,000 quiz questions since launch 🤯

We expect to return to this later in 2023 to iterate on the feature and add more content.

🌐 Upgrade i18n library

The i18n library migration is code complete and awaiting final review. We expect to ship this improvement the first week in January 🚀👀

Follow along on GitHub.

🔮Launch KZG Ceremony Site

The KZG Ceremony site is live! Check it out to participate in a testnet ceremony in preparation for the Mainnet Ceremony. We assisted the people working on this by helping with internationalization and some front-end development.

Want to learn more about the KZG Ceremony? Check out the KZG Ceremony Resources GitHub repo. or the #kzg-ceremony channel in the Eth R&D Discord.

🔭 Real-world case studies

We've identified the main case studies we'd like to cover, and an external contributor agreed to help us write this content. We're at the stage of drafting this content and will be delivering on these pages in Q1 👀.

Heard a story you think would be empowering to share? Let us know on Discord.

🔌 Revisit energy consumption page

We updated our energy consumption page to be more comprehensive and holistically consider Ethereum's energy and carbon impact.

Checkout the improved energy consumption page 🌳

🏗 Revamp tutorials

In Q4, we wrote five step-by-step non-technical tutorials/guides. To improve the UX of our existing tutorials, we worked on reducing the number of tutorial tags and delisting some outdated tutorials.

Unfortunately, we ran out of time and didn't get the guide content fully reviewed/live in Q4. Early in January, we plan to review this content and get it live on ethereum.org

Have thoughts on how to improve this? We'd love to chat. Please hop in our Discord 😀

The nice-to-haves

These epics are up next on our priority list. We're not committing to shipping anything this quarter, but we plan to make progress on these and want to share these publicly so the community can give input and get involved!

🌎 Translation quality

In Q4, we performed several rounds of quality assurance, collected feedback from translators, and identified inconsistencies within translations of specific languages, creating a plan to address them.

Have thoughts on how we can improve further? Come chat with us in the #translate channel on Discord.

👀 Research Dune API

Unfortunately, we weren't able to kick off this initiative this quarter. If you're interested in helping out with this initiative, please let us know!

Got a suggestion for an alternative data source we could use? Let us know on our Discord.

🌎 Clean up the EF blog

With some unforeseen delays in our development-heavy epics (mostly the Geth website), we didn't manage to get to the clean-up tasks on the EF blog.

We'll begin work on this in early Q1.

📢 External marketing

Unfortunately, we weren't able to kick off this initiative this quarter. Please let us know if you're interested in helping with this initiative!

📖 Close post-Merge gaps

In Q4, we successfully closed the post-Merge content gaps by shipping five new pages (see #8285 for full details) and making many small tweaks to other pages.

See something we missed? Let us know by creating an issue.

Get involved

Get involved: Learn more about contributing, hit us up on Twitter, or join the community discussions in our Discord.

Thanks again to every contributor who helped us in 2022 ❤️ Here's to an awesome 2023 on ethereum.org 😎🍻