Technical Committee AdministrationIcon indicating the project type

Technical Committee Administration

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

Publish Tracked Resource Set 1.0 Primer 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:
        Tracked Resource Set 1.0 Primer
      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 (PNs) which we expect to publish and announce together. The titles and approved source documents (individual HTML files) are:

          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 - 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 (PNs) 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 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 -

          List of expected changes (Word document) has been attached to https://issues.oasis-open.org/browse/TCADMIN-4132.

          Link to Word document:

          Show
          paul.knight1 Paul Knight added a comment - List of expected changes (Word document) has been attached to https://issues.oasis-open.org/browse/TCADMIN-4132 . Link to Word document: https://issues.oasis-open.org/secure/attachment/11898/11898_project-notes-changes.docx
          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 -

          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 check the updated PN under trs-primer.html_2022-05-18.zip

          Show
          berezovskyi Andrii Berezovskyi added a comment - Paul, please check the updated PN under trs-primer.html_2022-05-18.zip
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment - - edited

          Downloaded updated PN:

          Initial inspection:

          • ALL of the internal cross-references are broken. I fixed them.
          • In Section 2, there is a broken link to "9-change-log-truncation-and-rebase". It should be "#change-log-truncation-and-rebase". I fixed this. This should be fixed in the source.
          • In Section 3, there is a broken link to "#-handling-a-large-trs-base". The problem is the hyphen following #. It should be "#handling-a-large-trs-base". I fixed this. This should be fixed in the source.
          • Also in Section 3, there is a broken link to "#-change-log-truncation-and-rebase". The problem is the hyphen following #. It should be "#change-log-truncation-and-rebase". I fixed this. This should be fixed in the source.
          • In Section 4, there is a bad link to Section 10. (#-making-clients-tolerant-of-server-restore-from-backup). The problem is the hyphen following #. I removed this, so it is fixed. This should be fixed in the source.
          • At the end of Section 6, there is a broken link to Section 7 Patch events. The hyperlink is "5-patch-events". It should be "#patch-events". I fixed this. This should be fixed in the source.
          • Section 9 contains two identical broken links to "#-incremental-update-procedure". Again, the leading hyphen is incorrect. I fixed this. This should be fixed in the source.
            -Section 11 has a broken link for "71-initial-consumption-of-a-trs". This should be "#initial-consumption-of-a-trs". I fixed this. This should be fixed in the source.
          • Otherwise, looks okay.
          Show
          paul.knight1 Paul Knight added a comment - - edited Downloaded updated PN: Initial inspection: ALL of the internal cross-references are broken. I fixed them. In Section 2, there is a broken link to "9-change-log-truncation-and-rebase". It should be "#change-log-truncation-and-rebase". I fixed this. This should be fixed in the source. In Section 3, there is a broken link to "#-handling-a-large-trs-base". The problem is the hyphen following #. It should be "#handling-a-large-trs-base". I fixed this. This should be fixed in the source. Also in Section 3, there is a broken link to "#-change-log-truncation-and-rebase". The problem is the hyphen following #. It should be "#change-log-truncation-and-rebase". I fixed this. This should be fixed in the source. In Section 4, there is a bad link to Section 10. (#-making-clients-tolerant-of-server-restore-from-backup). The problem is the hyphen following #. I removed this, so it is fixed. This should be fixed in the source. At the end of Section 6, there is a broken link to Section 7 Patch events. The hyperlink is "5-patch-events". It should be "#patch-events". I fixed this. This should be fixed in the source. Section 9 contains two identical broken links to "#-incremental-update-procedure". Again, the leading hyphen is incorrect. I fixed this. This should be fixed in the source. -Section 11 has a broken link for "71-initial-consumption-of-a-trs". This should be "#initial-consumption-of-a-trs". I fixed this. This should be fixed in the source. Otherwise, looks okay.
          Hide
          Permalink
          paul.knight1 Paul Knight added a comment -

          Generated PDF.

          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 - Generated PDF. 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 -

          These files look fine to me. I approve to promote. 

          Show
          chet-oasis Chet Ensign added a comment - These files look fine to me. I approve to promote. 
          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
          chet-oasis Chet Ensign added a comment -

          ok - they look good. I approve to release

          Show
          chet-oasis Chet Ensign added a comment - ok - they look good. I approve to release
          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: