Publish Core 3.0 PS 02 & promote to OS

[berezovskyi]

WORKING DRAFT: https://oslc-op.github.io/oslc-specs/specs/core/oslc-core.html
OASIS issue: https://issues.oasis-open.org/projects/TCADMIN/issues/TCADMIN-4056?filter=allopenissues

Preflight

• Read the guidelines
• Create a milestone for this stage (link)
• Add this issue to the newly created milestone and tag it "Kind: EPIC"
• Search for all open issues and add the relevant ones to the milestone

ReSpec & ShapeChecker

• CicleCI has ShapeChecker configuration to check shapes and vocabs (NB! make sure -C flag is enabled to check shapes metadata)
• Ensure latest ReSpec is used (link)
• Ensure no critical ReSpec errors are present (see the ReSpec button in the top right corner)
  • run a local http server as instructed under https://github.com/oslc-op/oslc-specs#getting-started
  • browse to the html documents
  • press the Respec button on the top right of each document to check.

Editorial

• Make sure all URIs in the Additional components are fully qualified (ref, added 2020-09-09)
• RDF files (if any) have the license headers set correctly. NB! Do not put XML comments before the 2nd line; the first line must always be the XML declaration.
• head section contains a meta element with name="description" and content="{same text as in the abstract}"
• Remove Part #: from the titles of the Additional components for the vocabulary and shapes Turtle files. (ref, added 2020-09-09)
• Update references to obsolete PSDs to point to the latest revisions. See https://open-services.net/specifications/ for a list of obsolete publications.
• All issues in the milestone are resolved

OASIS

• specStatus set to the desired stage (PSD or higher)
• publishDate set to the date of the PGB vote + 7 days (e.g. if you plan to open the vote on Mar 12, set it to Mar 19).
• dcterms:issued in .ttl shapes and vocab files, set to same date as publishDate
• dcterms:hasVersion in .ttl shapes and vocab files, set to specStatus+revision e.g,PSD01
• dcterms:source and dcterms:isPartOf need to be changed to point to their future locations on open-services. See https://github.com/oslc-op/oslc-specs/pull/407/files, e.g., https://docs.oasis-open-projects.org/oslc-op/rm/v2.1/ps01/requirements-management-spec.html
• Create a snapshot from the specs and ZIP em up (instructions
• No broken links other than the stage-to-be-published
• Ensure no HTML errors are present in the saved snapshot of every part of the spec (check via File Upload option of the W3C checker). An exception has been made not to fix HTML5 errors that relate to dropped HTML table attributes.
• Release Draft created (TODO add a hyperlink here to the Release Draft once created, create one here)
• Release ZIP uploaded, TODO add a hyperlink to the Release ZIP once created)
• Notify the PGB of the intent to publish (template, ask a PGB member if you are not on the board). The vote can be initiated at least 14 days after this letter has been sent.
• PGB vote initiated (template, TODO add date)
• PGB vote passed (TODO add hyperlink to the announcement email)
• OASIS publication request filed under oasis-open-projects/administration (TODO add link)
• OASIS feedback addressed
• The spec is published to the OASIS staging archive
• OASIS review passed
• The spec is published to the OASIS archive

After PS with COS changes

• Tag the commit that was used to produce published snapshots with %shortname%-v%version%-%STAGE%%REVISION%.
• Promote the draft (pre-)release to a (pre-)release. PSDs are pre-releases.
• open-services.net redirects resolve to the current published specs/drafts (Andrew)
• Add a new row to the https://github.com/oslc-op/website/edit/master/content/specifications/_index.md under Active publications with the link to the published spec
• Move the old row (of the same version only) in the https://github.com/oslc-op/website/edit/master/content/specifications/_index.md from the Active publications to the Obsolete Publications table (DO NOT JUST DELETE AN OBSOLETE SPEC ROW!)

After OS

• Submit a permanent IANA application
• Update the NS publication
• Tag the commit that was used to produce published snapshots with %shortname%-v%version%-%STAGE%%REVISION%.
• Promote the draft (pre-)release to a (pre-)release. PSDs are pre-releases.
• open-services.net redirects resolve to the current published specs/drafts (Andrew)
• Add a new row to the https://github.com/oslc-op/website/edit/master/content/specifications/_index.md under Active publications with the link to the published spec
• Move the old row (of the same version only) in the https://github.com/oslc-op/website/edit/master/content/specifications/_index.md from the Active publications to the Obsolete Publications table (DO NOT JUST DELETE AN OBSOLETE SPEC ROW!)
• open-services.net blog announcement (spec editor prepares a blog post, see here and there, Andrew will do the deployment). The announcement will automatically appear on the forum.
• LinkedIn announcement (Axel)
• Twitter announcement (Andrew)

Kitchensink (for the first-time publication under the Open Project)

If this is the first PSD of the spec in the open project, there are many possible issues (accumulated from previous OASIS reviews). Please make a quick check to avoid having them and to speed up the review.

• [ReSpec] latestVersion updated to point to the one for the OP, not the TC (only for the first PSD)
• [ReSpec] additionalArtifacts links are relative
• [OASIS/RM] in "Notices", the copyright year is missing - between "OASIS Open" and the period
• [OASIS/RM] the links to the "Previous stage" should use http instead of https in this case, since the earlier files were installed with http links. When the HTML is retrieved using https, it is unable to load the associated .css file, so the document is poorly presented.
• [OASIS/RM] add HTTPS to the image references
• [OASIS/RM] in Vocabulary, I would expect that the first two definition should be placed under 2.1.1, since they are Classes rather than Properties. See Group vocab details by category as well as the synopsis oasis-tcs/tab-respec#17 (resolved by ReSpec 2.1.10)
• [OASIS] make sure the WG name is "OASIS Open Services for Lifecycle Collaboration (OSLC) OP" (see Spell out the full name of the WG #221)

[berezovskyi]

ReSpec warnings:

• part 2 / 8 warnings
• part 3 / 34 warnings
• part 5 / 1 warning
• part 6 / 1 warning
• part 7 / 19 warnings
• part 8 / 20 warnings

Vocab warnings:

• Update spec metadata to pass common checks #343

[berezovskyi]

@jamsden I need your confirmation that "contexts" and "schema" directories under https://github.com/oslc-op/oslc-specs/tree/master/specs/core should be in the OS package, please.

[berezovskyi]

My preliminary analysis is that those files are both used to generate resource-preview.html but are not part of the package for publication.

[jamsden]

Yes, these are referenced in the document. They're separate files for convenience of creating and editing the content.

[berezovskyi]

Package uploaded to https://issues.oasis-open.org/projects/TCADMIN/issues/TCADMIN-4056?filter=allopenissues

[berezovskyi]

Tagged 49ed35d as core-v3.0-ps02

[berezovskyi]

Core is OS now