Skip to content

refactor: #499 rename sdpi-supplement to sdpi-standard in directory a…#522

Draft
d-gregorczyk wants to merge 3 commits intomasterfrom
499-refactor-sdpi-specification-to-be-a-standalone-standard
Draft

refactor: #499 rename sdpi-supplement to sdpi-standard in directory a…#522
d-gregorczyk wants to merge 3 commits intomasterfrom
499-refactor-sdpi-specification-to-be-a-standalone-standard

Conversation

@d-gregorczyk
Copy link
Copy Markdown
Collaborator

☑ Mandatory Tasks

The following aspects have been respected by the pull request assignee and at least one reviewer:

  • Changelog update (necessity checked and entry added or not added respectively)
    • Pull Request Assignee
    • Reviewer

SDPi-Standard - only changed the name of the document on the title page
sdpi-supplement.adoc
     - commented out most of the inclusion files
     - added section definitions that are required in the two include files
asciidoc\ sdpi-supplement-....adoc
     - Moved the mandatory include files to this subdirectory
     - No changes to the files other than they were copied to this subdirectory & renamed back to "supplement"
Initial updates to Standalone content, mainly cover page and Forward.
@ToddCooper
Copy link
Copy Markdown
Collaborator

@JavierEspina & @d-gregorczyk -- Moving comment thread from Issue #499 ...

Notes from initial refactoring:

Comment: Jetlag is a bear ...

  1. Bifurcating SDPi to Supplement & Standards

    • Duplicated sdpi-supplement.adoc to sdpi-standard.adoc
    • Updated sdpi-supplement to include only -intro & -issues + defined the section labels currently required to resolve references from these two includes
    • Editorial comments added to document (both source - not rendered, using "STANDALONE SDPi:" - search for this for refactoring notes
    • Review ballot comments - rendered - using "Standalone SDPi" for review
    • PRIMARY CHANGES will be made to the front matter, including the -issues and -intro files, but "supplement" is included randomly throughout the other files and will need to be updated to "standard" or "document" (neutral) when other major changes have been completed.
  2. Deferred until integration of other PRs:

    • Retained "supplement" use in the sdpi-standard files until other PRs have been merged, due to the significant changes that this will result in throughout most files! THIS IS A HUGE CHANGE, since many labels include "supplement" somewhere!
    • TF Volumes - keep? For this version, I kept the TF-1 to TF-3 designations; however, since this will NEVER be integrated into a Mothership Final Text Technical Framework "document", should we keep the "volume" designations or make them "Sections"? I'd favor keeping them Volumes but am open to other approaches.

The latest PR content builds - but much work remains!

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

Labels

None yet

Projects

Status: No status

Development

Successfully merging this pull request may close these issues.

Refactor SDPi Specification to be a Standalone Standard

3 participants