Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Merge Change Log and Archives sections #413

Closed
nils-work opened this issue Jul 12, 2024 · 2 comments
Closed

Merge Change Log and Archives sections #413

nils-work opened this issue Jul 12, 2024 · 2 comments
Assignees
@nils-work
Labels
enhancement New feature or request
Milestone
v1.32.0

Comments

@nils-work
Copy link
Member

The Standards Change Log and Archives sections contain tables of mostly repeated information with different links to their respective detail. These tables could be merged to simplify and improve the user experience and reduce maintenance.

As the Change Log generally contains more detail, the proposal is to retain it and add the current and archived version links to the Version column. Where there is a mismatch in detail, the fields will be corrected and merged if necessary. The Archives section could then be removed once all detail is collated into a single table.

Change proposed

  1. Change the Change Log heading to Change log and archives.
  2. Change the introductory text to:

    The following table lists the changes made to these standards in reverse date order (most recent change and current version is at the top). Archived versions are prior versions of the standards that are available for reference only and not considered binding.

  3. Transfer the respective version links from the Archives table (currently applied to the Release Date and Description fields) to the Version column in the Change log and archives table.
  4. Two rows in the Archives table ('November 2018 Working Draft' and 'Christmas 2018 Working Draft - InfoSec Profile') are not present in the current Change Log and these should be inserted into the updated table in the appropriate sequence.
  5. There are currently minor differences between the Change Date and Release Date values for some versions. Where there is a conflict, the date from the Change Log will be retained.
  6. Change the Change Date column name to just Date.
  7. Where there is a difference between the two sets of Description values (~11 versions prior to 2022), the Archives text will be appended to the Change Log text for completeness.

For reference

Current Change Log:
image

Current Archives:
image

Proposed combined Change log and archives:
image
@nils-work nils-work added the enhancement New feature or request label Jul 12, 2024
@nils-work nils-work mentioned this issue Jul 24, 2024
Closed
nils-work added a commit that referenced this issue Jul 29, 2024
@nils-work
Merged the Change Log and Archives sections
feb86ca 
Addresses: #413
@nils-work nils-work mentioned this issue Jul 29, 2024
Merged
@nils-work nils-work added this to the v1.32.0 milestone Jul 29, 2024
@nils-work
Copy link
Member Author

Changes staged here including renaming the section to Changelog and archives

@nils-work nils-work self-assigned this Aug 29, 2024
nils-work added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Oct 21, 2024
@nils-work @markverstege @HemangCDR
Release/1.32.0 (#358)
2a69040 
* Created 1.32.0 branch base

* Updated to newer openapi-generator-cli

Added new jar and removed older jars

* Merged the Change Log and Archives sections

Addresses: ConsumerDataStandardsAustralia/standards-staging#413

* Retaining original anchors

* Fixed spelling mistake for authorization_code reference. Addresses issue comment ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Removed redundant statement regarding client ID. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Corrected field description for tariffUType. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Updated URIString example to use HTTPS scheme rather than HTTP. Addresses issue ConsumerDataStandardsAustralia/standards-maintenance#647 (comment)

* Update details in Common Field Types section

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Clarified the format of adjustment rate values

Addresses: ConsumerDataStandardsAustralia/standards-maintenance#641

* Fixed typos

Addresses: ConsumerDataStandardsAustralia/standards-staging#411

* Endpoint as one word

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment) and ConsumerDataStandardsAustralia/standards-maintenance#527 (comment)

* Corrected required properties

Addresses: ConsumerDataStandardsAustralia/standards-staging#417

* Add version delta comment and removed line breaks

* #418 - Add CX guidelines link to footer

Addresses: ConsumerDataStandardsAustralia/standards-staging#418

* Update Common and Admin APIs descriptions

* Staging #419 - Update field name styling

Addresses: ConsumerDataStandardsAustralia/standards-staging#419

* Update description of Product Categories section

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Staging #426 - Corrected OAS, moved files

Addresses: ConsumerDataStandardsAustralia/standards-staging#426

* Fixed typos

* Standards Maintenance Issue #652: Updated description of AmountString field clarifying the currency format and noting it defaults to AUD

* adding 'and'

for one hundred 'and' twenty-three dollars

* Minor update to styling and wording

* Fix link for local build testing

* Added x-version-notes and x-diff custom extension keys. x-version-notes allows capturing API version notes. x-diff allows capturing diff statements against specific API or schemas

* Standards Maintenance Issue #653: Amended description of dailySupplyChargeType field

* Standards Maintenance Issue #653: Fixed incorrect diff statement

* Staging #438 - Improve code samples

Addresses: ConsumerDataStandardsAustralia/standards-staging#438

* Version delta and release notes

* Staging #437 - Remove Known Issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#437

* Corrected error title

Addresses: ConsumerDataStandardsAustralia/standards-staging#411 (comment)

* Update _errors.md

* Corrected quotes in JSON samples

* Added Register Base URLs to spec

* Updated links

* Added TLS changes to align with BCP 195 and FAPI 2.0. Addresses issue: ConsumerDataStandardsAustralia/standards-maintenance#648

* Removed x-diff custom key from json swagger. Moved diff statement into energy erb file

* BCP195 as one word, bolded key words

* Update "account id" to "accountId"

* Removed bold styling

* Update to validation version only

Clearly distinguishing the specific JAR versions used in each step of the build process and updated to the newer JAR for validation only.

* Reverted non-RateString changes

* Updated notes

* Update issue title

* Resolve release notes and change log

* 1.32.0 build for Staging

* Build 1.32.0

---------

Co-authored-by: Mark Verstege <[email protected]>
Co-authored-by: Hemang Rathod <[email protected]>
@nils-work
Copy link
Member Author

Incorporated into Standards v1.32.0

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

@nils-work nils-work

Labels
enhancement New feature or request
Projects
None yet
Milestone
v1.32.0
Development

No branches or pull requests
1 participant
@nils-work