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

Editorial changes to appendix - links to columns and glossary terms #590

Merged
merged 3 commits into from
Oct 8, 2024

Conversation

ijurica
Copy link
Contributor

@ijurica ijurica commented Oct 5, 2024

Editorial changes:

  • Commitment Discounts
    • Replaced column names previously formatted as code with links to columns
    • Addressed several missing and broken links to glossary terms
  • Grouping Constructs for Resources or Services
    • Added links to billing account, sub account, resource and service glossary terms
  • Origination of Cost Data
    • Added links to Provider, Publisher and Invoice Issuer columns
    • Added links to resource and service glossary terms

The changes in this PR are in accordance with the agreement that we will continue to use the previous version of the editorial guidelines in FOCUS version 1.1 (for details, see the table below).

Component Markdown (examples) Editorial Guidelines
Column Names: Column Names:
Pricing Quantity
Pricing Unit
Provider
  • Normal text without bold or italics.
  • Use the display name in the introductory (non-normative) section and description.
  • The first occurrence in a section is linked to the section, except when referring to itself.
Attribute Names: Attribute Names:
Currency Code Format
Date/Time Format
  • Normal text without bold or italics.
  • Use the attribute display name in the introductory (non-normative) section, description, normative section, and content constraints table.
  • The first occurrence in a section is linked to the section, except when referring to itself.
Column IDs: Column IDs:
PricingQuantity
PricingUnit
ProviderName
  • Normal text without bold or italics.
  • Use the column ID in the normative section and when referencing column values.
  • For column IDs, use PascalCase (the first letter of every word is capitalized).
  • The first occurrence in a section is linked to the corresponding column, except when referring to itself.
Glossary [*SKU*](#glossary:sku)
[*resource*](#glossary:resource)
[*service*](#glossary:service)
  • Italic.
  • The first occurrence in a section is linked to the glossary term.

@ijurica ijurica requested a review from a team as a code owner October 5, 2024 17:47
@ijurica ijurica added consistency/review Consistency Review editorial Items that address editorial and minor changes labels Oct 5, 2024
@ijurica ijurica self-assigned this Oct 5, 2024
@jpradocueva
Copy link
Contributor

Action Items from Maintainers' call on Oct 7:

  • [Maintainers-#590]: Review PRs for consistency in column IDs and links. Ensure that they only reflect editorial changes.
  • [Maintainers-#590]: Address broken references and check the editorial overview for a solution to inconsistencies found during the process.

@jpradocueva jpradocueva added this to the v1.1 milestone Oct 8, 2024
Copy link
Contributor

@jpradocueva jpradocueva left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ready to merge.

@tobrien tobrien self-requested a review October 8, 2024 15:17
@jpradocueva
Copy link
Contributor

Approved during the Members' call on Oct 8.

@jpradocueva jpradocueva merged commit 7971283 into working_draft Oct 8, 2024
2 checks passed
@jpradocueva jpradocueva deleted the editorial-appendix-link-columns branch October 8, 2024 22:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
consistency/review Consistency Review editorial Items that address editorial and minor changes
Projects
Status: W.I.P
Development

Successfully merging this pull request may close these issues.

5 participants