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.

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

Edit 2020 Chapters #1432

Closed
22 tasks done
tunetheweb opened this issue Nov 6, 2020 · 11 comments
Closed
22 tasks done

Edit 2020 Chapters #1432

tunetheweb opened this issue Nov 6, 2020 · 11 comments
Assignees
Labels
ASAP This issue is blocking progress editing Content excellence

Comments

@tunetheweb
Copy link
Member

tunetheweb commented Nov 6, 2020

Part I. Page Content

Part II. User Experience

Part III. Content Publishing

Part IV. Content Distribution

@tunetheweb tunetheweb added this to the 2020 Content Writing milestone Nov 6, 2020
@tunetheweb tunetheweb added the editing Content excellence label Nov 6, 2020
@tunetheweb
Copy link
Member Author

Same rules as last time @HTTPArchive/editors - grab a chapter when you see one free and claim it by tagging your name next to the first issue and then submit a PR with the original authors. Links to chapters available in our issue tracker

@rviscomi
Copy link
Member

rviscomi commented Nov 6, 2020

Pro tip for editors who spot something that should be changed but the fix isn't ready yet (for example a link to an unlaunched chapter), use a Jinja comment starting with TODO so it's annotated in the markdown file, easily discoverable, and not included in the HTML output.

{# TODO: Link directly to the relevant Accessibility section. #}
We identified 2,863 different values for the `lang` attribute on the `html` start tag (compare that to the [7,117 spoken languages](https://www.ethnologue.com/guides/how-many-languages) as per Ethnologue). Almost all of them, [according to the Accessibility chapter](./accessibility), seem valid.

I've added this to the Editor's Guide wiki

@rviscomi rviscomi self-assigned this Nov 7, 2020
@tunetheweb
Copy link
Member Author

tunetheweb commented Nov 9, 2020

Tagging those that expressed an interest in editing in #922 (👋 again @rachellcostello ). If anyone else is interested (@HTTPArchive/editors ?) then feel free to add your self to Assignees.

The Capabilities chapter is good to go for editing if anyone wants to grab it?

@tunetheweb
Copy link
Member Author

Added two new suggestions to Editors Guide:

  • Check previous years chapters table of contents and flag to authors if any messing pieces, to ensure they didn't accidentally leave out an important section
  • Check print version (add ?print to URL) to ensure all images load (check for console errors is the easiest way of checking this).

@rviscomi
Copy link
Member

rviscomi commented Dec 1, 2020

@bazzadp @rachellcostello CMS is ready for editing, would either of you like to take that one?

@tunetheweb
Copy link
Member Author

HTTP/2 is ready for editing.

I'll have a look at CMS in next day or two if no one else grabs it.

@rviscomi
Copy link
Member

rviscomi commented Dec 2, 2020

@HTTPArchive/editors Resource Hints is now ready for editing

@tunetheweb
Copy link
Member Author

@HTTPArchive/editors HTTP/2 and SEO is ready for editing

This was referenced Dec 3, 2020
@rviscomi
Copy link
Member

rviscomi commented Dec 3, 2020

Added a note to the editors' wiki about using the numeric class on tabular figures. See this before and after:

image
image

It's a minor change but right-aligning makes the decimal points line up and is easier to read.

To make this conversion, I'll "copy outer HTML" of the rendered table in DevTools, replace the markdown table with it, and add the class="numeric" to each td that needs it. Don't forget to remove the markdown class from the figure!

image

Before:

<figure markdown>
| Protocol | Desktop | Mobile |
| -------- | ------- | ------ |
| HTTP/1.1 | 36.05%  | 34.04% |
| HTTP/2   | 63.95%  | 65.96% |
<figcaption>...</figcaption>
</figure>

After

<figure>
  <table>
    <thead>
      <tr>
        <th>Protocol</th>
        <th>Desktop</th>
        <th>Mobile</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td>HTTP/1.1</td>
        <td class="numeric">36.05%</td>
        <td class="numeric">34.04%</td>
      </tr>
      <tr>
        <td>HTTP/2</td>
        <td class="numeric">63.95%</td>
        <td class="numeric">65.96%</td>
      </tr>
    </tbody>
  </table>
  <figcaption>...</figcaption>
</figure>

@tunetheweb
Copy link
Member Author

@HTTPArchive/editors PWA and Jamstack are ready for editing.

@tunetheweb
Copy link
Member Author

Compression and Caching ready for editing.

@rviscomi rviscomi pinned this issue Dec 8, 2020
@exterkamp exterkamp mentioned this issue Dec 9, 2020
25 tasks
@rviscomi rviscomi added the ASAP This issue is blocking progress label Dec 10, 2020
@exterkamp exterkamp mentioned this issue Dec 13, 2020
25 tasks
@tunetheweb tunetheweb unpinned this issue Jan 31, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ASAP This issue is blocking progress editing Content excellence
Projects
None yet
Development

No branches or pull requests

5 participants