Skip to content

A curated, digital, interactive book outlining a course of study with curated notes and exercises. Helping you build a web accessible by all through best practices, ethics, compassion and sustainability.

License

The-Mycelium-Network/webworkbook

Repository files navigation

web://workbook

A curated, digital, interactive book outlining a course of study with curated notes and exercises. Helping you build a web accessible by all through best practices, ethics, compassion and sustainability.

What are we trying to achieve?

The Mycelium Network community of contributors will define and lead the project. Outside collaboration is welcomed and encouraged, but final decisions will be made by the members of the Mycelium Network.

Why

After conversations with various individuals at different stages of their web developer careers, a clear need has been identified. There is no lack of learning material available on the web. The real problem is finding a path through the forest. web://workbook aims to be a curated, digital, interactive book outlining a course of study with curated notes and exercises.

What

The web://workbook will be a website freely available to all. The deliverables are as follows:

  • A public roadmap
  • Design of a logo
  • Registration of a domain name
  • A basic design system that includes a color palette, typography, and individual page components such as buttons, navigation, and page layout
  • A statically generated website backed by Hugo, Contentful, GitHub, and Netlify

The site's content will be arranged around three verticals with some overlap. These are:

  • Topics: A topic-based approach such as "What is the Internet?", "What is open source?", "How do I create a responsive webpage header?"
  • Technology: This will cover open web technologies such as HTML, CSS, and JavaScript.
  • Pathways: Community-curated pathways for specific career paths. Examples include: front-end engineers, full-stack engineers, UX engineers, and technical writers.

How

We will use an Agile process and a RACI (Responsible, Accountable, Consulted, Informed) model to ensure everyone understands their responsibilities, timeline, and deliverables. We will use GitHub projects, issues, and a pull request model for all work. All work will be done in the open using a remote-first approach.

Open-source software should be our first choice unless a paid product will ease contribution or productivity. This project should give back to those open-source projects we rely on. This can be monetary, but as an open-source project, it can also take the form of contributions back to the upstream projects.

The core team members will meet weekly to discuss blockers and clear the path for others. As a remote-first project, attendance is encouraged but not mandatory. We acknowledge team members are spread across the globe, and trust among all members is key to the project's success.

Above all, the happiness of team members and our readers is paramount.

Contributing

Please refer to our contributing guidelines for more information.

NOTE: This project uses conventional commits

We are open-source enthusiasts! 🌱 Feel free to get contribute to any aspect of this project. While doing so, be reasonable: do not just copy content from elsewhere. Like academic writing, your work can incorporate the ideas of others but should reflect your original approach to the problem.

Hugo

This site uses Hugo. To develop locally, you’ll need to install Hugo. You can find the installation instructions here.

Once installed, run the following command in your terminal:

hugo server

Once the server starts, point your browser to http://localhost:1313 to view the site.

You can refer to the Hugo documentation on the Hugo website.

Quick reference

About

A curated, digital, interactive book outlining a course of study with curated notes and exercises. Helping you build a web accessible by all through best practices, ethics, compassion and sustainability.

Topics

Resources

License

Stars

Watchers

Forks