Smaller "Difference from previous editions" chapter, one file per one version pair #13
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
bact
changed the title
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Also use capital V for version as in ISO spec Signed-off-by: Arthit Suriyawongkul <arthit@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Current differences from previous editions document is very long (around a thousand), make it difficult to maintain, read, and reference to.
This PR breaks down the doc to smaller files, each of them deal with specific pair of versions (v3.0-v2.3, v2.3-v2.2.2, etc)
There's no change in the content, except rerunning of two Table numbers in "V2.2.1 and V2.2" and "V2.2.2 and V2.2.1" (from "Table A.1" and "Table A.2" to "Table 1" and "Table 1", since they're now in separate files).
A TOC is provided for all version pairs in diff.md.
--
This can also benefit two other separated things:
preparation for ISO diff from prev version chapter -- it should be a diff between two ISO versions (v3.0.1 and v2.2.1, see Annex A (diffs from previous) should be about the previous ISO version spdx-spec#999 ), which means anything pre-v2.2.1 does not relevant.
preparation for SPDX Using website, if we like to use MkDocs (as proposed in Set up mkdocs #4). A smaller doc, with smaller number of headings, make it easier to manage the MkDocs navigation bar.
--
See demo of smaller diffs at https://bact.github.io/using/diff/v3.0-v2.3/