Skip to content

Add change tagging #67

@JamesMBligh

Description

@JamesMBligh

Description
To allow for greater ability to review the changes in a specific version of the standards compared to the previous version there is a need to introduce greater granularity in the changes applied to a specific version of the standards.

Related Work Items
There are two suggested options for achieving this outcome:

  1. Produce an automated diff script that can generate more detailed release notes that can then be published in the release notes section
  2. Add tagging to the raw files so that changes can be tagged an inline highlighting can show the changes that have been made

Option 2 would appear to be a much better experience but may be very difficult to achieve for the parts of the standards that are generated from swagger using widdershins. The best solution may be a combination of tagging for hand written markdown and a list of specific changes preceding swagger generated markdown sections.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions