Quick start guide

Quick start guide

Content creation for web.dev has three phases: planning, writing, and publishing.

Planning #

  1. If you're a Googler or have access to a Googler, use the content proposal form to submit your new content request. If you don't have access to a Googler, use the content issue template.
  2. The web.dev team will take a look to see if the idea fits with the goals of the site. If the idea is approved, it will be assigned a reviewer.

Caution: If the piece you'd like to publish is time sensitive, make sure to submit the issue at least one month before the target publication date so there's enough time to move it through the writing process.

Writing #

  1. Read the Content guidelines to understand how to create high-quality content. The higher the quality of your content, the less time and energy you'll have to spend incorporating feedback.
  2. After your content proposal is approved, create a copy of the web.dev content template to draft your content.
  3. Self-review your content with the web.dev content checklist to find and fix common problems. The more of these problems you fix yourself, the faster your review will go.
  4. When your first draft is ready, leave a comment in your GitHub issue and ask for a review.

Publishing #

  1. After you get approval from a web.dev team member that your content can be published on the site, submit a GitHub pull request.
  2. Check out the web.dev markup section to learn how to make your markdown squeaky clean. In particular, check out the web.dev components guide to discover UI elements that can make your content more engaging or aesthetically pleasing.
  3. Once your PR is merged, the content will be deployed to the site immediately.

Organizing content #

Collections (learning paths) #

Posts in collections in the Learn section are organized thematically within learning paths. Each collection is defined in the site/_data/paths directory as a json object.

  1. To add a new collection, add a <collection_name>.json file to the site/_data/paths directory.

  2. In the collection's .json file, define fields like title, description, overview and topic titles as i18n paths, to allow their translation into many languages (e.g. i18n.paths.newpathname.title).

  3. Add the content of these fields to the site/_data/i18n/paths directory (under en key). If applicable, launch translation process for this content by emailing web.dev@.

Tags #

Tags are used to categorize articles and also to generate web.dev/tags pages. The canonical list of tags is published in tagsData.json on Github.

  • to add a new tag, add it first to tagsData.json
  • to use an existing tag, add it to your article's fromtmatter:
tags:
- accessibility
Last updated: Improve article