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.

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

Resolve links within the standards to specific errors and other parts #222

Closed
ElizabethArnold-DSB opened this issue Aug 9, 2022 · 0 comments
Labels
enhancement New feature or request
Milestone

Comments

@ElizabethArnold-DSB
Copy link

The CDR Test Documentation includes references to specific sections of the Consumer Data Standards such as an error code, see example below. However, while these links work within the CDS, when copied and used in an external document, they resolve to the top level of the menu section where the specific reference appears.

It would be useful to enable these lower level links so that the CDR Test Documentation audience doesn't need to go looking for the specific error or other relevant references enabled via these links.

Example
When pasting this url (https://consumerdatastandardsaustralia.github.io/standards/#error-404-unavailable-energy-account) into a browser window it resolves at Error Codes rather than on the error itself.

@ElizabethArnold-DSB ElizabethArnold-DSB added the enhancement New feature or request label Aug 9, 2022
@JamesMBligh JamesMBligh added in progress Being worked on for the next version of the standards and removed in progress Being worked on for the next version of the standards labels Mar 14, 2023
nils-work added a commit that referenced this issue Nov 23, 2023
@nils-work nils-work added this to the v1.29.0 milestone Nov 23, 2023
nils-work added a commit that referenced this issue Nov 24, 2023
nils-work added a commit that referenced this issue Dec 12, 2023
@nils-work nils-work mentioned this issue Dec 20, 2023
JamesMBligh added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Dec 21, 2023
* Create clean version of release 1.29.0

* Added releasenotes file for 1.29.0

* Added redirect_uri

* Update CX Guidlines link

* Removed amending authz

* added RFC7636 to refs

* Updated Intro DSB link

* Differences in naming of Register endpoints

* Added obligation schedule to FDO

* Updated desc of minimumValue maximumValue unitOfMeasure

* Updated markdown of minimumValue maximumValue unitOfMeasure

* Added missing fields for PAID_OUT_AT_MATURITY ROLLED_OVER for maturityInstructions

* Updated definition of Number in common field types

* Updated descriptions on ErrorMetricsV2

* Modified URL in line with request example

* url encoded

* Retain Version Delta for Additional Standards

Re-added the 1.28.0 Version Delta comments for the Candidate and Draft Standards recently updated and still under consultation in 1.29.0.

* Added authorization_signed_response_alg & authorization_encrypted_response_alg as conditional

* Resolve link and navigation issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Switch tracking and add Standards category ribbon

Addresses: ConsumerDataStandardsAustralia/standards-staging#334, ConsumerDataStandardsAustralia/standards-staging#332

* Corrected minor typos only

Addresses typos: ConsumerDataStandardsAustralia/standards-staging#312

* Remove resource name to reduce length + complexity

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Added end &

* Removed FDO Obligation date from Amending authorisation

* Created a single link for [PKCE] / [RFC7636]

* Standards Maintenance Issue #587: Added new field measureUnit in EnergyBillingDemandTransaction

* Adjust heading levels and add navigation classes

Addresses: ConsumerDataStandardsAustralia/standards-staging#338

* Identifying superseded versions in obsolete path

Addresses: ConsumerDataStandardsAustralia/standards-staging#334

* Business Consumer Provisions

Addresses: #333

* Added link to change description

* Added link to change description

* Standards Maintenance Issue #587: Fixed typos. Re-arranged order of api versions for consistency

* Add style to override class for CX submenu items

* Added Data Holder Dashboards section

Addresses: #334

* Added link to issue

* Added issue link to description

* Added issue link to description

* Updated with data attribute to apply CSS

* Updated with data attribute

* Added FDO details

* Standards Maintenance Issue #613: Changed type of time fields in energy plan data to ExternalRef referring to ISO 8601 Times specification

* Standards Maintenance Issue #613: Changed description of affected time fields for clarity.

* Standards Maintenance Issue #587: Fixed typos

* Standards Maintenance Issue #587: Fixed typo in FDO table

* Retaining majority of useful original anchors

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Display the x-cds-type for array items

Addresses: ConsumerDataStandardsAustralia/standards-staging#348

* Show format of request parameter enums correctly

Addresses: ConsumerDataStandardsAustralia/standards-staging#349

* Adding release notes and delta comments

Update for: ConsumerDataStandardsAustralia/standards-staging#348

* Update to release notes and NBL version delta

* Remove last diffs

* Moving NBL Draft to Candidate Standards

Addresses: #318

* Rebuild

* Add FDO diff statement for 587

* Add diff statements and release notes

* Add diff and release notes

* Add release note reference to CR620

* Add release notes

* Add santa hat

* Update release date

* Fix release notes
Update obligation date counts

* Corrected typo

* Add MI 17 DP to release notes

Addresses: #328

* Updated links

* Updated dates

* Added deprecation dates

* Corrected typo

* Rebuild

* Update change log with DP328

---------

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: kirkycdr <[email protected]>
Co-authored-by: Nils Berge <[email protected]>
JamesMBligh added a commit to ConsumerDataStandardsAustralia/standards that referenced this issue Jan 18, 2024
* Create clean version of release 1.29.0

* Added releasenotes file for 1.29.0

* Added redirect_uri

* Update CX Guidlines link

* Removed amending authz

* added RFC7636 to refs

* Updated Intro DSB link

* Differences in naming of Register endpoints

* Added obligation schedule to FDO

* Updated desc of minimumValue maximumValue unitOfMeasure

* Updated markdown of minimumValue maximumValue unitOfMeasure

* Added missing fields for PAID_OUT_AT_MATURITY ROLLED_OVER for maturityInstructions

* Updated definition of Number in common field types

* Updated descriptions on ErrorMetricsV2

* Modified URL in line with request example

* url encoded

* Retain Version Delta for Additional Standards

Re-added the 1.28.0 Version Delta comments for the Candidate and Draft Standards recently updated and still under consultation in 1.29.0.

* Added authorization_signed_response_alg & authorization_encrypted_response_alg as conditional

* Resolve link and navigation issues

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Switch tracking and add Standards category ribbon

Addresses: ConsumerDataStandardsAustralia/standards-staging#334, ConsumerDataStandardsAustralia/standards-staging#332

* Corrected minor typos only

Addresses typos: ConsumerDataStandardsAustralia/standards-staging#312

* Remove resource name to reduce length + complexity

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Added end &

* Removed FDO Obligation date from Amending authorisation

* Created a single link for [PKCE] / [RFC7636]

* Standards Maintenance Issue #587: Added new field measureUnit in EnergyBillingDemandTransaction

* Adjust heading levels and add navigation classes

Addresses: ConsumerDataStandardsAustralia/standards-staging#338

* Identifying superseded versions in obsolete path

Addresses: ConsumerDataStandardsAustralia/standards-staging#334

* Business Consumer Provisions

Addresses: #333

* Added link to change description

* Added link to change description

* Standards Maintenance Issue #587: Fixed typos. Re-arranged order of api versions for consistency

* Add style to override class for CX submenu items

* Added Data Holder Dashboards section

Addresses: #334

* Added link to issue

* Added issue link to description

* Added issue link to description

* Updated with data attribute to apply CSS

* Updated with data attribute

* Added FDO details

* Standards Maintenance Issue #613: Changed type of time fields in energy plan data to ExternalRef referring to ISO 8601 Times specification

* Standards Maintenance Issue #613: Changed description of affected time fields for clarity.

* Standards Maintenance Issue #587: Fixed typos

* Standards Maintenance Issue #587: Fixed typo in FDO table

* Retaining majority of useful original anchors

Addresses: ConsumerDataStandardsAustralia/standards-staging#222

* Display the x-cds-type for array items

Addresses: ConsumerDataStandardsAustralia/standards-staging#348

* Show format of request parameter enums correctly

Addresses: ConsumerDataStandardsAustralia/standards-staging#349

* Adding release notes and delta comments

Update for: ConsumerDataStandardsAustralia/standards-staging#348

* Update to release notes and NBL version delta

* Remove last diffs

* Moving NBL Draft to Candidate Standards

Addresses: #318

* Rebuild

* Add FDO diff statement for 587

* Add diff statements and release notes

* Add diff and release notes

* Add release note reference to CR620

* Add release notes

* Add santa hat

* Update release date

* Fix release notes
Update obligation date counts

* Corrected typo

* Add MI 17 DP to release notes

Addresses: #328

* Updated links

* Updated dates

* Added deprecation dates

* Corrected typo

* Rebuild

* Update change log with DP328

* Standards Staging Issue #359: Known Issues table updated noting incorrect version of Energy Billing APIs

* Updated to known issues

---------

Co-authored-by: Hemang Rathod <[email protected]>
Co-authored-by: kirkycdr <[email protected]>
Co-authored-by: Nils Berge <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

3 participants