Skip to content

OSDOCS-4501: Breaks the TP table up by component#52611

Merged
opayne1 merged 1 commit intoopenshift:enterprise-4.12from
opayne1:OSDOCS-4501
Dec 6, 2022
Merged

OSDOCS-4501: Breaks the TP table up by component#52611
opayne1 merged 1 commit intoopenshift:enterprise-4.12from
opayne1:OSDOCS-4501

Conversation

@opayne1
Copy link
Contributor

@opayne1 opayne1 commented Nov 8, 2022

Breaks the TP table up by component

Version(s):
4.12 (can visit backporting at a later date if this format works)

Issue:
OSDOCS-4501

Link to docs preview:
https://52611--docspreview.netlify.app/openshift-enterprise/latest/release_notes/ocp-4-12-release-notes.html#ocp-4-12-technology-preview

QE review:

  • QE has approved this change.
  • QE will not be needed for this change.

Additional information:
Some components may not be 100%. Will need the help of the team to ensure the components listed are correct and they have the correct contents.

@opayne1 opayne1 added this to the Planned for 4.12 GA milestone Nov 8, 2022
@openshift-ci openshift-ci bot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Nov 8, 2022
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Nov 8, 2022

🤖 Updated build preview is available at:
https://52611--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/4726

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Using this first entry as an example.
Some feedback I received from the Accessibility open office hours.

  • We should spell out the abbreviations the first time they are mentioned in each table
  • We should maybe spell out TP GA etc. because the main concern is the "empty" cells with a -. We should replace the - with Not Available
Suggested change
|Pod-level bonding for secondary networks
|Technology Preview
|General Availability
|General Availability

Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

This is a HUGE improvement, thanks for taking initiative and even getting a11y involved

Throughout: Technology Preview capitalization should be made consistent

Copy link
Contributor

Choose a reason for hiding this comment

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

Is there a particular order for these tables? Just wondering if we should do a purposeful order... alphabetical is an option, but not sure if it's the best. However, I'm assuming that most, if not all, of these categories match categories in the new feature section. What if we mirrored that same order here with these?

Copy link
Contributor

@jeana-redhat jeana-redhat Nov 14, 2022

Choose a reason for hiding this comment

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

related: afaik there is not really rhyme or reason for the order of the new features (and bugfixes) sections either. I think I had on my RN enhancement wishlist to revisit these, figure out what order makes sense, and make sure they match. (just sharing my thoughts, that would def be out of scope for the PR imho)

Copy link
Contributor

Choose a reason for hiding this comment

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

Yeah def don't need to be worrying about that feature category order in this PR, more just to consider matching this table to that.

However I actually vaguely remember someone saying that they had tried to reorder the categories so that they were kind of in line with our topic map TOC on the left (maybe Cody?). And when I check just now, it actually does kind of follow that for a lot of them for the ones that match top-level books. (There might need to be a few adjustments, like moving the auth category up to below "Security" and some others). So maybe we could consider moving those around to be in line.

Can't speak to the bug fixes section though 😉

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Will revisit this comment later. I think it would be great to have them in an intentional order, just need to figure out what that would look like!

@bergerhoffer
Copy link
Contributor

Meant to leave a summary comment in the above review - love these changes. I think they're a huge improvement to the previous unwieldy table!

@openshift-ci openshift-ci bot added size/XL Denotes a PR that changes 500-999 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Dec 6, 2022
@opayne1 opayne1 added the peer-review-needed Signifies that the peer review team needs to review this PR label Dec 6, 2022
@jeana-redhat jeana-redhat added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Dec 6, 2022
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

Looks like just one missed at the end, very good! See Slack discussion of "OCP" and some suggestions, but otherwise this all LGTM 👍

@jeana-redhat jeana-redhat added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Dec 6, 2022
Copy link
Contributor

@abhatt-rh abhatt-rh left a comment

Choose a reason for hiding this comment

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

Hi @opayne1,
The new and improved table for TP looks great! I noticed two typos and suggested corrections.

@opayne1 opayne1 merged commit 04ded67 into openshift:enterprise-4.12 Dec 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.12 peer-review-done Signifies that the peer review team has reviewed this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants