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 updates on column IDs and Display Names #582

Merged
merged 9 commits into from
Oct 17, 2024

Conversation

jpradocueva
Copy link
Contributor

These changes won't affect the content in Release V1.1. They are actually editorial guidelines according to the working group agreement.

@jpradocueva jpradocueva added repo maintenance Issues related to maintenance tasks on the repo editorial Items that address editorial and minor changes labels Oct 2, 2024
@jpradocueva jpradocueva requested a review from a team as a code owner October 2, 2024 00:44
@jpradocueva
Copy link
Contributor Author

This issue was originated during the discussion of #469

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

Action Items from TF-2 call on October 3rd:

  • [TF2-#582] Members: Coordinate with the editorial team to finalize minor changes by Monday.

@jpradocueva jpradocueva modified the milestones: v1.1, v1.2 Oct 9, 2024
@jpradocueva
Copy link
Contributor Author

jpradocueva commented Oct 16, 2024

Action Items assigned during TF-2 call on Oct 15:

  • [TF-1-#582] Joaquin, @jpradocueva: Fix double colon issues in Column IDs and obtain final approval.

@ijurica
Copy link
Contributor

ijurica commented Oct 16, 2024

In this PR, I’m unable to add a comment/suggestion directly in the appropriate place in the table, so I’m suggesting here that we add the following row.

<tr>
    <td><strong>Column Values:</strong></td>
    <td>		   
        - "Usage"<br> 
        - "Tax"<br> 
        - "TB"<br>
    </td>
    <td>
        This column:
        * MUST be null when ChargeCategory is "Tax"... 
    </td>
    <td>
        - Enclosed in double quotation marks<br>
        - Normal text without bold or italics
    </td>
</tr>

Note:
Note: We have consistently formatted normalized column values as normal text without bold or italics, enclosed in double quotation marks. On the other hand, for non-normalized column values, we've been using various formatting, such as:

  • "TB"
  • Hours
  • Compute Usage

I suggest we keep it simple and use normal text without bold or italics, enclosed in double quotation marks for all column values, both normalized and non-normalized. However, I don't have a strong preference.

If we plan to distinguish the formatting for normalized and non-normalized columns, do we need to clarify what those terms mean? We internally use "normalized" and "non-normalized" columns but haven't specified their definitions.

@jpradocueva
Copy link
Contributor Author

@ijurica, I suggest that you add this extra row to the table so it is easy to review. If the group disagrees with the change, it can be removed.

@ijurica
Copy link
Contributor

ijurica commented Oct 16, 2024

Nit: add <br> in line 60

@jpradocueva jpradocueva added this to the v1.2 milestone Oct 17, 2024
@jpradocueva
Copy link
Contributor Author

Approved during the Members' call on Oct 17.

@jpradocueva jpradocueva merged commit fbb9ddf into working_draft Oct 17, 2024
2 checks passed
@jpradocueva jpradocueva deleted the editorial-updates branch October 17, 2024 23:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
editorial Items that address editorial and minor changes repo maintenance Issues related to maintenance tasks on the repo
Projects
Status: W.I.P
Development

Successfully merging this pull request may close these issues.

2 participants