Skip to content
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.

Sign up for GitHub

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

Update project README for 2020 #879

Merged
merged 2 commits into from
Jun 18, 2020
Merged

Update project README for 2020 #879

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
04f3be9
Update README.md
rviscomi Jun 18, 2020
816f2b3
Update README.md
rviscomi Jun 18, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
55 changes: 38 additions & 17 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,32 +1,53 @@
# 📕 Web Almanac

The Web Almanac is HTTP Archive's annual "state of the web" report. Our mission is to combine the powerful analytics of HTTP Archive with the expertise of the web community. The Almanac is made up of four primary sections: page content, user experience, content delivery, and content distribution. Each section is comprised of chapters that explore the state of specific areas like JavaScript usage, accessibility, content management systems, and compression.
The Web Almanac is HTTP Archive's annual **state of the web** report.

Our mission is to combine the raw stats and trends of the HTTP Archive with the expertise of the web community. The Web Almanac is a comprehensive report on the state of the web, backed by real data and trusted web experts. It is comprised of 20 chapters spanning aspects of page content, user experience, publishing, and distribution.

The 2019 Web Almanac is available in:
- [English](https://almanac.httparchive.org/en/2019/)
- [Spanish](https://almanac.httparchive.org/es/2019/)
- [French](https://almanac.httparchive.org/fr/2019/)
- [Japanese](https://almanac.httparchive.org/ja/2019/)

## Contributing

We are currently developing the inaugural 2019 edition of the Almanac and looking for contributors to help in the following areas:
There are several ways to contribute to the Web Almanac:

**[Authors](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Authors'-Guide)** are subject matter experts and lead the content direction for each chapter. Chapters typically have one or two authors. Authors are responsible for planning the outline of the chapter, analyzing stats and trends, and writing the annual report.

**[Revewiers](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Reviewers'-Guide)** are also subject matter experts and assist authors with technical reviews during the planning, analyzing, and writing phases.

**[Analysts](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Analysts'-Guide)** are responsible for researching the stats and trends used throughout the Almanac. Analysts work closely with authors and reviewers during the planning phase to give direction on the types of stats that are possible from the dataset, and during the analyzing/writing phases to ensure that the stats are used correctly.

**[Developers](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Developers'-Guide)** are responsible for the technical infrastructure of the website and solve complex problems about accessibility, performance, internationalization, SEO, and more.

**[Editors](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Editors'-Wiki)** are technical writers who have a penchant for both technical and non-technical content correctness. Editors have a mastery of the English language and work closely with authors to help wordsmith content and ensure that everything fits together as a cohesive unit.

**[Translators](https://github.com/HTTPArchive/almanac.httparchive.org/wiki/Translators'-Guide)** are technical writers who help internationalize the Almanac and make it globally accessible to the web community.

### Diversity and inclusion

We strive to make the Web Almanac a diverse and inclusive project. If you bring a unique perspective, we want to hear from you. Members of the web community that bring a valuable set of diverse perspectives from underrepresented groups or those with unique experiences like standards work or browser/framework development are highly encouraged to participate, especially as content authors and reviewers.

- [Subject matter experts](https://github.com/HTTPArchive/almanac.httparchive.org/issues/2) to lead each chapter and provide a written interpretation of the dataset.
- [Peer reviewers](https://github.com/HTTPArchive/almanac.httparchive.org/issues/2) to assist the chapter authors with planning and editing.
- [Data analysts](https://github.com/HTTPArchive/almanac.httparchive.org/issues/23) to query the HTTP Archive dataset for metrics used by each chapter.
- [Web designers and developers](https://github.com/HTTPArchive/almanac.httparchive.org/issues/24) to help build the UX of the Almanac itself.
- [Translators](https://github.com/HTTPArchive/almanac.httparchive.org/issues/29) to bring the Almanac content to as many popular languages as possible
If you're interested in contributing to the project, please follow the links above.

We strive to make the Web Almanac an inclusive and diverse project. If you bring a unique perspective, we want to hear from you. For example, members of the web community from underrepresented groups or those with unique experiences like standards work, browser development, framework development, etc bring a valuable set of diverse perspectives and are highly encouraged to participate.
## Timeline

If you're interested in joining the project, please follow the links above.
- June 2020: Nominating and selecting authors for chapters
- July 2020: Selecting peer reviewers and analysts for chapters, planning content
- August 2020: Gathering HTTP Archive data
- September 2020: Analyzing data
- October 2020: Writing, editing, and translating content
- November 2020: Publishing the 2020 edition

## [Timeline](https://docs.google.com/spreadsheets/d/1LR29JpI2XJSjan_z6uP1YpRy4EYYivYZPqCIG-9sfFY/edit?usp=sharing)
## Where to find us

![Almanac timeline](https://user-images.githubusercontent.com/1120896/58134221-21c05400-7bf4-11e9-8f47-31b585c964a8.png)
We do almost all of our project planning here on GitHub. Browse the open [issues](https://github.com/HTTPArchive/almanac.httparchive.org/issues) to see what we're working on and what may be [suitable for new contributors](https://github.com/HTTPArchive/almanac.httparchive.org/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).

The expected release date for the 2019 edition of the Web Almanac is November 4, coinciding with the [Chrome Dev Summit](https://developer.chrome.com/devsummit/). To get there, we have several milestones:
We also have a [`#web-almanac`](https://join.slack.com/t/httparchive/shared_invite/zt-45sgwmnb-eDEatOhqssqNAKxxOSLAaA) channel on the HTTP Archive Slack where we chat about project updates.

- June 3: All chapters have subject matter experts assigned, reviewers assigned, and metrics finalized.
- July 1: Queries written for all metrics, designers hired/assigned, and the development environment built.
- September 9: Design completed and all chapters written and reviewed.
- October 7: Website built and content integrated.
- November 4: Website translated, QA tested, and deployed.
For news and announcements, follow [@HTTPArchive](https://twitter.com/HTTPArchive) on Twitter.

## [License](https://github.com/HTTPArchive/almanac.httparchive.org/blob/master/LICENSE)

Expand Down