mdn / mdn/mdn

List HTTP headers "tdm-reservation" and "tdm-policy"

Open
#408 11 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

needs implementation proposal type: add content
Dominant language
No language data
Stars
1.4k
Forks
204
PR merge metrics
No merged PRs in 30d

Description

Proposal

Create the following two pages describing Text and Data Mining (TDM) reservation via HTTP headers:

Task list
  • Create page https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/tdm-reservation, explain its syntax and reference https://www.w3.org/2022/tdmrep/#sec-tdm-header.
  • Create page https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/tdm-policy and possibly another page detailing the intricacies and implications of a TDM policy.
Additional information

Cf. https://www.w3.org/2022/tdmrep/#sec-tdm-header

Are you willing to support this work?

Yes; I would be happy to create a PR for both pages.

Depends on

Possibly an article discussing TDM reservation more broadly; HTTP headers are only one of three currently defined "techniques" (cf. https://www.w3.org/2022/tdmrep/#sec-processing-priority) to state TDM reservation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the W3C TDM Reservation Protocol section 3.2, linked in the issue, and review the existing MDN HTTP header documentation conventions. Create the tdm-reservation and tdm-policy pages at the specified URLs, documenting syntax and the relevant policy implications, with the required W3C reference. Resolve whether the broader TDM article is needed before considering the work complete.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, web-dev
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.