Remove Summary Table Schema #407
Conversation
Fixes #405 As per the linked issue, the 360-giving-summary-table-schema.json file does not appear to be used for anything and has not been updated since 2018. Discussion indicates that it is an artefact from early standard development (possibly pre flatten-tool days) to define the tabular serialization. Tabular serialization is now done directly from the schema via flatten-tool, and the documentation build pipeline generates this template from the schema for each new version. This indicates that the summary table schema is now defunct. The Governance page of the standard docs does not specify which files are covered by Governance processes: * https://standard.threesixtygiving.org/en/latest/about/governance/#versioning-and-upgrade-process However this file is stated to be normative content by the Normative and non-normative content policy: * https://www.360giving.org/wp-content/uploads/360Giving-Standard-Policy-Normative-and-non-normative-content_final_2020-02-28.pdf I think we are within grounds to remove it for the following reasons: * it is not the schema which defines the Standard * further, it directly contradicts the schema (and thus the Standard) * it is not used for validation or for deriving documentation * removing this file therefore does not introduce any changes to the Standard, normative sections of the docs, or tooling
|
The docs appear to be building fine: |
|
@mrshll1001 Is the normative and non-normative content policy itself normative? |
Good question! I don't see it referenced anywhere on in the docs, and it exists as a PDF that was uploaded to the 360Giving Wordpress site. Further, we've had internal discussions about how this policy needs updating or replacing. The policy itself states that the SC approved it for adoption on 2019-11-22, so I think the policy is considered normative in that way. I'm unaware of any subsequent action by the SC to remove or update this status. |
|
Discussed and agreed this should be handled as a PATCH |
mariongalley
left a comment
mariongalley
left a comment
There was a problem hiding this comment.
A week has passed since the PATCH was proposed in the forum and by email to the Stewardship Committee, with no objections received, so this PATCH is now considered approved.
2 participants
Fixes #405
As per the linked issue, the 360-giving-summary-table-schema.json file does not appear to be used for anything and has not been updated since 2018.
Discussion indicates that it is an artefact from early standard development (possibly pre flatten-tool days) to define the tabular serialization.
Tabular serialization is now done directly from the schema via flatten-tool, and the documentation build pipeline generates this template from the schema for each new version. This indicates that the summary table schema is now defunct.
The Governance page of the standard docs does not specify which files are covered by Governance processes:
However this file is stated to be normative content by the Normative and non-normative content policy:
I think we are within grounds to remove it for the following reasons: