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

Conflict in Document identifier information ordering, between pubrules and sample document #1422

Open
svgeesus opened this issue Nov 9, 2021 · 4 comments

Comments

@svgeesus
Copy link
Contributor

svgeesus commented Nov 9, 2021

The sample CRD document does not follow pubrules.

It has

<details>
        <summary>More details about this document</summary>
      <dl>
        <dt>This version:</dt><dd>
                <a class="u-url" href="https://www.w3.org/TR/2021/CRD-hr-time-2-20210915/">https://www.w3.org/TR/2021/CRD-hr-time-2-20210915/</a>
              </dd><dt>Latest published version: (@@note that version is not required in the latest version)</dt><dd>
                <a href="https://www.w3.org/TR/hr-time/">https://www.w3.org/TR/hr-time/</a>
              </dd>
        <dt>Latest editor's draft:</dt><dd><a href="https://w3c.github.io/hr-time/">https://w3c.github.io/hr-time/</a></dd>
        <dt>History:</dt><dd><a href="https://www.w3.org/standards/history/hr-time-2">https://www.w3.org/standards/history/hr-time-2</a></dd>
        <dt>Test suite:</dt><dd><a href="https://wpt.fyi/hr-time/">https://wpt.fyi/hr-time/</a></dd>
        <dt>Implementation report:</dt>(@@required, or indicate no implementation report in SOTD)<dd>
                <a href="https://wpt.fyi/hr-time/">https://wpt.fyi/hr-time/</a>
              </dd>

              <dt>Editor:</dt>
              <dd class="p-author h-card vcard" data-editor-id="56102">George Herald
                  (WebFoo)
                </dd>
              <dt>
                      Former editors:
                    </dt><dd class="p-author h-card vcard" data-editor-id="45726">James Hector
                  (BAR Inc.)
                 (Until January 2015)</dd><dd class="p-author h-card vcard" data-editor-id="44357">Joe Smith (Iron Corp.)
                 (Until February 2014)</dd>

           <dt>Feedback:</dt>
           <dd><a href="https://github.com/w3c/hr-time/issues">https://github.com/w3c/hr-time/issues</a></dd>
           <dd><a href="mailto:[email protected]?subject=%5Bhr-time%5D%20YOUR%20TOPIC%20HERE">[email protected]</a> with subject line “<kbd>[hr-time] <var>… message topic …</var></kbd>” (<a href="http://lists.w3.org/Archives/Public/public-web-perf/" rel="discussion">archives</a>)</dd>
     </dl>
      </details>

while pubrules says

 Document identifier information **must** be present in this order:

    'This version' - URI to that version
    'Latest version' - URI to the latest version. See also the (non-normative) Version Management in W3C Technical Reports for information about "latest version" URI and version management.
    'History' - URI to the history of the specification
    Editor(s)
    Feedback - GitHub repository issue links are required in the <dl>after <dt>Feedback:</dt> in the headers (<div class="head">) of the document. Links are expected to be of the form https://github.com/<USER_OR_ORG>/<REPO_NAME>/[issues|labels][/…].)

Notice that pubrules does not give a location for the Editors Draft, Implementation report nor Test Suite.

@jennyliang220
Copy link
Contributor

Hi @svgeesus, Pubrules currently doesn't check the location of 'Editors Draft, Implementation report nor Test Suite' links. You could put them in any order, or consider using the order of the mockup

@plehegar, is there any specific order preferred for these links?

@plehegar
Copy link
Member

plehegar commented Jan 4, 2022

@plehegar, is there any specific order preferred for these links?

"This Version", "Latest version" should appear first.
"History" could appear 3 or 4, depending on whether the editor's draft link is there or not.
Beyond that, I'm not sure if we want to impose an order.

@svgeesus
Copy link
Contributor Author

svgeesus commented Jan 9, 2022

Beyond that, I'm not sure if we want to impose an order.

Ok, so the fix is to clarify pubrules which claims there is a required order

Document identifier information must be present in this order:

@svgeesus
Copy link
Contributor Author

svgeesus commented Jan 9, 2022

Also note the sample CRD document cited above does not have a "Latest version:" link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants