Technical Committee AdministrationIcon indicating the project type

Technical Committee Administration

Uploaded image for project: 'Technical Committee Administration'
  1. Technical Committee Administration
  2. TCADMIN-4132

Publish OSLC Core Version 3.0: Link Guidance from OSLC Open Project as a Project Note

    Details

    • Type: Task
    • Status: Closed
    • Priority: Major
    • Resolution: Fixed
    • Component/s: Document Upload Request
    • Labels:
      None
    • Environment:

      OSLC

      Description

      Your name:
        Andrii Berezovskyi
      Project name:
        OSLC Open Project
      Project email address:
        [1]oslc-op@lists.oasis-open-projects.org
      Title and version number:
        OSLC Core Version 3.0: Link Guidance
      Approval:
        [2]https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/210
      ----------------------------------------------------------------------------------------
      [1] oslc-op@lists.oasis-open-projects.org
      [2] https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/210

        Attachments

          Activity

          Ascending order - Click to sort in descending order
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Source documents are listed in the announcement of intent to publish: https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/204
          Ballot results are listed in the ballot: https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/209

          Closing date of the ballot (approval date) is 16 December 2021.

          This is one of a set of five Project Notes which we expect to publish and announce together. The titles and approved source documents (individual HTML files) are:

          Show
          paul.knight1 Paul Knight added a comment - Source documents are listed in the announcement of intent to publish: https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/204 Ballot results are listed in the ballot: https://lists.oasis-open-projects.org/g/oslc-op-pgb/message/209 Closing date of the ballot (approval date) is 16 December 2021. This is one of a set of five Project Notes which we expect to publish and announce together. The titles and approved source documents (individual HTML files) are: OSLC Core Version 3.0: Link Guidance ( TCADMIN-4132 ) https://lists.oasis-open-projects.org/g/oslc-op-pgb/attachment/204/2/oslc-link-guidance.html Configuration Management 1.0 Primer ( TCADMIN-4134 ) https://lists.oasis-open-projects.org/g/oslc-op-pgb/attachment/204/0/config-primer.html Summary of changes in OSLC Core 3.0 ( TCADMIN-4135 ) https://lists.oasis-open-projects.org/g/oslc-op-pgb/attachment/204/1/core-3.0-changes.html OSLC Tracked Resource Set Guidance ( TCADMIN-4136 ) https://lists.oasis-open-projects.org/g/oslc-op-pgb/attachment/204/3/trs-guidance.html Tracked Resource Set 1.0 Primer ( TCADMIN-4137 ) https://lists.oasis-open-projects.org/g/oslc-op-pgb/attachment/204/4/trs-primer.html
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Quick review shows that some changes for the title and URIs will be needed.
          I'll assemble a list of the expected changes - likely for all of the PNs together.

          Show
          paul.knight1 Paul Knight added a comment - Quick review shows that some changes for the title and URIs will be needed. I'll assemble a list of the expected changes - likely for all of the PNs together.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          I'm attaching a Word document listing the changes needed for all five of these Project Notes: project-notes-changes.docx

          The entire list of OSLC OP Project Notes with the TCADMIN ticket numbers is:

          Show
          paul.knight1 Paul Knight added a comment - I'm attaching a Word document listing the changes needed for all five of these Project Notes: project-notes-changes.docx The entire list of OSLC OP Project Notes with the TCADMIN ticket numbers is: Link Guidance - https://issues.oasis-open.org/browse/TCADMIN-4132 Config Mgt. Primer - https://issues.oasis-open.org/browse/TCADMIN-4134 Summary of changes in OSLC Core v3.0 - https://issues.oasis-open.org/browse/TCADMIN-4135 Tracked Resource Set Guidance - https://issues.oasis-open.org/browse/TCADMIN-4136 Tracked Resource Set Primer - https://issues.oasis-open.org/browse/TCADMIN-4137
          Hide
          Permalink
          berezovskyi Andrii Berezovskyi added a comment -

          Paul, please find the updated document attached.

          Show
          berezovskyi Andrii Berezovskyi added a comment - Paul, please find the updated document attached.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Quick review of the updated document:

          • The front page needs to have a link for the PDF in addition to the HTML for "This stage". I'll add that.
          • Also needs Previous stage" and "Latest stage" URIs. I'll add those.
          • Two references to OSLC Core v3.0 point to https://open-services.net/spec/core/latest instead of the expected URI https://docs.oasis-open-projects.org/oslc-op/core/v3.0/oslc-core.html. Currently, the open-services.net URI redirects to the docs,oasis-open-projects.org URI. I will leave this as is.
          • stray characters "-->" appear on a line above the Notices section. I'll remove them.
          • noted apparent unfinished text just before Appendix A - "Feedback should be directed to the OSLC Core Workgroup mailing-list. TBD - put link here." I'll leave this as is.
          • no Acknowledgments section
          Show
          paul.knight1 Paul Knight added a comment - Quick review of the updated document: The front page needs to have a link for the PDF in addition to the HTML for "This stage". I'll add that. Also needs Previous stage" and "Latest stage" URIs. I'll add those. Two references to OSLC Core v3.0 point to https://open-services.net/spec/core/latest instead of the expected URI https://docs.oasis-open-projects.org/oslc-op/core/v3.0/oslc-core.html . Currently, the open-services.net URI redirects to the docs,oasis-open-projects.org URI. I will leave this as is. stray characters "-->" appear on a line above the Notices section. I'll remove them. noted apparent unfinished text just before Appendix A - "Feedback should be directed to the OSLC Core Workgroup mailing-list. TBD - put link here." I'll leave this as is. no Acknowledgments section
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment - - edited

          NOTE: actual filename is "link-guidance.html", but the URI listed on the front page is:

          I think the "oslc-" should be removed from the URI in two places, so the main HTML URI will be:

          Show
          paul.knight1 Paul Knight added a comment - - edited NOTE: actual filename is "link-guidance.html", but the URI listed on the front page is: https://docs.oasis-open-projects.org/oslc-op/oslc-link-guidance/v1.0/pn01/oslc-link-guidance.html I think the "oslc-" should be removed from the URI in two places, so the main HTML URI will be: https://docs.oasis-open-projects.org/oslc-op/link-guidance/v1.0/pn01/link-guidance.html This also matches the github "Latest Editor's draft" filename - https://oslc-op.github.io/oslc-specs/notes/link-guidance.html
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          There are five similar Project Notes being published, with modifications required for each.
          As of 17 February, the OSLC OP team is focusing on "Summary of changes in OSLC Core 3.0", TCADMIN-4135. (see note there)
          Once that PN is published, will replicate the outstanding changes to the rest of the PNs and check the document with the feedback again.

          I will set this issue to "Stop Progress" until the updates are ready.

          Show
          paul.knight1 Paul Knight added a comment - There are five similar Project Notes being published, with modifications required for each. As of 17 February, the OSLC OP team is focusing on "Summary of changes in OSLC Core 3.0", TCADMIN-4135 . (see note there) Once that PN is published, will replicate the outstanding changes to the rest of the PNs and check the document with the feedback again. I will set this issue to "Stop Progress" until the updates are ready.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Status update:

          This is one of five OSLC OP Project Notes which are in development:

          The OSLC OP has prepared an updated draft which appears to meet the requirements for publication. (see TCADMIN-4135)
          I provided a few comments, primarily on updating some boilerplate links to OASIS resources, which will apply to all publications.
          See these comments at https://issues.oasis-open.org/browse/TCADMIN-4135?focusedCommentId=81121&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-81121

          The OSLC OP Editors will prepare an updated draft for this Project Note.

          Show
          paul.knight1 Paul Knight added a comment - Status update: This is one of five OSLC OP Project Notes which are in development: Link Guidance - https://issues.oasis-open.org/browse/TCADMIN-4132 Config Mgt. Primer - https://issues.oasis-open.org/browse/TCADMIN-4134 Summary of changes in OSLC Core v3.0 - https://issues.oasis-open.org/browse/TCADMIN-4135 Tracked Resource Set Guidance - https://issues.oasis-open.org/browse/TCADMIN-4136 Tracked Resource Set Primer - https://issues.oasis-open.org/browse/TCADMIN-4137 The OSLC OP has prepared an updated draft which appears to meet the requirements for publication. (see TCADMIN-4135 ) I provided a few comments, primarily on updating some boilerplate links to OASIS resources, which will apply to all publications. See these comments at https://issues.oasis-open.org/browse/TCADMIN-4135?focusedCommentId=81121&page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#comment-81121 The OSLC OP Editors will prepare an updated draft for this Project Note.
          Hide
          Permalink
          berezovskyi Andrii Berezovskyi added a comment -

          Paul, please find the new PN package attached.

          Show
          berezovskyi Andrii Berezovskyi added a comment - Paul, please find the new PN package attached.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment - - edited

          Downloaded new PN package (https://issues.oasis-open.org/secure/attachment/11944/link-guidance.html_2022-05-19.zip).
          Initial review:

          • Title "OSLC Core Version 3.0: Link Guidance Version 1.0" was not updated as suggested in my earlier review project-notes-changes.docx (to "OSLC Core v3.0 Link Guidance Version 1.0"). That would have aligned better with the similar title "OSLC Core v3.0 Changes Version 1.0". However, the big initial problem, omission of "Version 1.0", is corrected, and this title is allowable, so it can remain.
          • no other significant issues noted.

          Later, noted that the HTML file did not contain a "description" element, so I added text taken from the Abstract.

          Show
          paul.knight1 Paul Knight added a comment - - edited Downloaded new PN package ( https://issues.oasis-open.org/secure/attachment/11944/link-guidance.html_2022-05-19.zip ). Initial review: Title "OSLC Core Version 3.0: Link Guidance Version 1.0" was not updated as suggested in my earlier review project-notes-changes.docx (to "OSLC Core v3.0 Link Guidance Version 1.0"). That would have aligned better with the similar title "OSLC Core v3.0 Changes Version 1.0". However, the big initial problem, omission of "Version 1.0", is corrected, and this title is allowable, so it can remain. no other significant issues noted. Later, noted that the HTML file did not contain a "description" element, so I added text taken from the Abstract.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Generated PDF - ready for staging operations.

          Show
          paul.knight1 Paul Knight added a comment - Generated PDF - ready for staging operations.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Installed files for staging review:

          • prepared files with timestamps, ZIP, and manifest in personal directory
          • staging directory already in place in /ztest for other concurrent OSLC OP docs
          • created new WP, Version and stage directories
          • copied files into stage directory
          • added new symlinks
          • installed README warning file
          • set timestamps for directory and symlinks, also for version directory.
          • checked installation - looks okay
          • will request OASIS staff staging review along with other remaining PNs
          Show
          paul.knight1 Paul Knight added a comment - Installed files for staging review: prepared files with timestamps, ZIP, and manifest in personal directory staging directory already in place in /ztest for other concurrent OSLC OP docs created new WP, Version and stage directories copied files into stage directory added new symlinks installed README warning file set timestamps for directory and symlinks, also for version directory. checked installation - looks okay will request OASIS staff staging review along with other remaining PNs
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Requested OASIS staff staging review for four PNs:

          Please review the staging server installation of the remaining four Project Notes from the OSLC OP.
          These are all fairly short.

          The files are:

          OSLC Core Version 3.0: Link Guidance Version 1.0
          Project Note 01
          16 December 2021

          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/link-guidance/v1.0/pn01/link-guidance.html
          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/link-guidance/v1.0/pn01/link-guidance.pdf

          ***************************************************

          Configuration Management Primer Version 1.0
          Project Note 01
          16 December 2021

          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/config-primer/v1.0/pn01/config-primer.html
          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/config-primer/v1.0/pn01/config-primer.pdf

          ***************************************************

          OSLC Tracked Resource Set Guidance Version 1.0
          Project Note 01
          16 December 2021

          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.html
          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.pdf

          ***************************************************
          Tracked Resource Set Primer Version 1.0
          Project Note 01
          16 December 2021

          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-primer/v1.0/pn01/trs-primer.html
          https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-primer/v1.0/pn01/trs-primer.pdf

          Show
          paul.knight1 Paul Knight added a comment - Requested OASIS staff staging review for four PNs: Please review the staging server installation of the remaining four Project Notes from the OSLC OP. These are all fairly short. The files are: OSLC Core Version 3.0: Link Guidance Version 1.0 Project Note 01 16 December 2021 https://docs-staging.oasis-open-projects.org/ztest/oslc-op/link-guidance/v1.0/pn01/link-guidance.html https://docs-staging.oasis-open-projects.org/ztest/oslc-op/link-guidance/v1.0/pn01/link-guidance.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4132 . *************************************************** Configuration Management Primer Version 1.0 Project Note 01 16 December 2021 https://docs-staging.oasis-open-projects.org/ztest/oslc-op/config-primer/v1.0/pn01/config-primer.html https://docs-staging.oasis-open-projects.org/ztest/oslc-op/config-primer/v1.0/pn01/config-primer.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4134 . *************************************************** OSLC Tracked Resource Set Guidance Version 1.0 Project Note 01 16 December 2021 https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.html https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4136 . *************************************************** Tracked Resource Set Primer Version 1.0 Project Note 01 16 December 2021 https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-primer/v1.0/pn01/trs-primer.html https://docs-staging.oasis-open-projects.org/ztest/oslc-op/trs-primer/v1.0/pn01/trs-primer.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4137 .
          Hide
          Permalink
          chet-oasis Chet Ensign added a comment -

          The files look good. I approve to promote to docs.oasis-open-projects.org

          Show
          chet-oasis Chet Ensign added a comment - The files look good. I approve to promote to docs.oasis-open-projects.org
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Promoted approved files to OASIS Library (docs.oasis-open-projects.org) for final reviews

          • Synced files from /ztest to canonical directory (/htdocs)
          • Synced to OASIS OP Library (docs.oasis-open-projects.org)
          • checked links, etc.
            • no link issues found in any of the five PNs
          • requested sanity check:

          Please review the OASIS Library installation of the files for five OSLC PN01s.
          I did not find any broken links or other issues.

          Configuration Management Primer Version 1.0
          Project Note 01
          16 December 2021

          https://docs.oasis-open-projects.org/oslc-op/config-primer/v1.0/pn01/config-primer.html
          https://docs.oasis-open-projects.org/oslc-op/config-primer/v1.0/pn01/config-primer.pdf

          OSLC Core v3.0 Changes Version 1.0
          Project Note 01
          16 December 2021

          https://docs.oasis-open-projects.org/oslc-op/core-3.0-changes/v1.0/pn01/core-3.0-changes.html
          https://docs.oasis-open-projects.org/oslc-op/core-3.0-changes/v1.0/pn01/core-3.0-changes.pdf

          OSLC Core Version 3.0: Link Guidance Version 1.0
          Project Note 01
          16 December 2021

          https://docs.oasis-open-projects.org/oslc-op/link-guidance/v1.0/pn01/link-guidance.html
          https://docs.oasis-open-projects.org/oslc-op/link-guidance/v1.0/pn01/link-guidance.pdf

          OSLC Tracked Resource Set Guidance Version 1.0
          Project Note 01
          16 December 2021

          https://docs.oasis-open-projects.org/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.html
          https://docs.oasis-open-projects.org/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.pdf

          Tracked Resource Set Primer Version 1.0
          Project Note 01
          16 December 2021

          https://docs.oasis-open-projects.org/oslc-op/trs-primer/v1.0/pn01/trs-primer.html
          https://docs.oasis-open-projects.org/oslc-op/trs-primer/v1.0/pn01/trs-primer.pdf

          Show
          paul.knight1 Paul Knight added a comment - Promoted approved files to OASIS Library (docs.oasis-open-projects.org) for final reviews Synced files from /ztest to canonical directory (/htdocs) Synced to OASIS OP Library (docs.oasis-open-projects.org) checked links, etc. no link issues found in any of the five PNs requested sanity check: Please review the OASIS Library installation of the files for five OSLC PN01s. I did not find any broken links or other issues. Configuration Management Primer Version 1.0 Project Note 01 16 December 2021 https://docs.oasis-open-projects.org/oslc-op/config-primer/v1.0/pn01/config-primer.html https://docs.oasis-open-projects.org/oslc-op/config-primer/v1.0/pn01/config-primer.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4134 . *************************************** OSLC Core v3.0 Changes Version 1.0 Project Note 01 16 December 2021 https://docs.oasis-open-projects.org/oslc-op/core-3.0-changes/v1.0/pn01/core-3.0-changes.html https://docs.oasis-open-projects.org/oslc-op/core-3.0-changes/v1.0/pn01/core-3.0-changes.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4135 . *************************************** OSLC Core Version 3.0: Link Guidance Version 1.0 Project Note 01 16 December 2021 https://docs.oasis-open-projects.org/oslc-op/link-guidance/v1.0/pn01/link-guidance.html https://docs.oasis-open-projects.org/oslc-op/link-guidance/v1.0/pn01/link-guidance.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4132 . *************************************** OSLC Tracked Resource Set Guidance Version 1.0 Project Note 01 16 December 2021 https://docs.oasis-open-projects.org/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.html https://docs.oasis-open-projects.org/oslc-op/trs-guidance/v1.0/pn01/trs-guidance.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4136 . *************************************** Tracked Resource Set Primer Version 1.0 Project Note 01 16 December 2021 https://docs.oasis-open-projects.org/oslc-op/trs-primer/v1.0/pn01/trs-primer.html https://docs.oasis-open-projects.org/oslc-op/trs-primer/v1.0/pn01/trs-primer.pdf Please add comments to https://issues.oasis-open.org/browse/TCADMIN-4137 .
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -
          • Removed README warning file and reset directory timestamp in canonical directory on staging server.
          • synced to OASIS OP Library (docs.oasis-open-projects.org)
          • Ready for announcements.
          Show
          paul.knight1 Paul Knight added a comment - Removed README warning file and reset directory timestamp in canonical directory on staging server. synced to OASIS OP Library (docs.oasis-open-projects.org) Ready for announcements.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Sent out announcement message to:

          Submitted announcement to OASIS website for review.

          Assigning to Chet to review and complete announcement, etc.

          Show
          paul.knight1 Paul Knight added a comment - Sent out announcement message to: project-announce@lists.oasis-open.org, members@lists.oasis-open.org, oslc-op@lists.oasis-open-projects.org, oslc-op-pgb@lists.oasis-open-projects.org emails: https://lists.oasis-open.org/archives/members/202205/msg00006.html https://lists.oasis-open-projects.org/g/oslc-op/message/835 Submitted announcement to OASIS website for review. Assigning to Chet to review and complete announcement, etc.
          Hide
          Permalink
          chet-oasis Chet Ensign added a comment -

          The article is published on the website and announced on social media. I'm closing this ticket. 

          Show
          chet-oasis Chet Ensign added a comment - The article is published on the website and announced on social media. I'm closing this ticket. 

            People

            • Assignee:
              chet-oasis Chet Ensign
              Reporter:
              berezovskyi Andrii Berezovskyi
            • Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved: