Skip to content

OSDOCS-3390: ROSA documentation restructure updates #43807

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
Merged
merged 1 commit into from
Apr 14, 2022
Merged

OSDOCS-3390: ROSA documentation restructure updates #43807

merged 1 commit into from
Apr 14, 2022

Conversation

@bmcelvee
Copy link
Contributor

@bmcelvee bmcelvee commented Mar 24, 2022 •
edited
Loading

https://issues.redhat.com/browse/OSDOCS-3390

Original restructure PR for reference: #41923

Acks required
QE: @yuwang-RH
Eng/PM: @okashi18, @arendej
Product Experience: @davemulford
Docs: @AndrewJones-RH

Preview: https://deploy-preview-43807--osdocs.netlify.app/openshift-rosa/latest/welcome/index.html

Would you all mind giving the new ROSA docs structure a review and ack, please?

@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Mar 24, 2022
@netlify
Copy link

netlify bot commented Mar 24, 2022 •
edited
Loading

✅ Deploy Preview for osdocs ready!

Name Link
🔨 Latest commit 84daf50
🔍 Latest deploy log https://app.netlify.com/sites/osdocs/deploys/6257362c3c052100093edb1c
😎 Deploy Preview https://deploy-preview-43807--osdocs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch from ef3db56 to f9b81ac Compare April 1, 2022 20:40
@openshift-ci openshift-ci bot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Apr 1, 2022
bmcelvee
bmcelvee commented Apr 1, 2022
View reviewed changes
rosa_install_access_delete_clusters/rosa_getting_started_iam/rosa-getting-started-workflow.adoc Outdated
Copy link
Contributor Author

@bmcelvee bmcelvee Apr 1, 2022

Choose a reason for hiding this comment

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

This file fell out of sync in the first phase of the restructure. It was my fault. Are the links still correct?

@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch 3 times, most recently from a6713ce to 6d2e942 Compare April 7, 2022 14:00
@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 Apr 7, 2022
@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch 2 times, most recently from 4440da4 to c57aa49 Compare April 7, 2022 17:57
bmcelvee
bmcelvee commented Apr 7, 2022
View reviewed changes
_topic_maps/_topic_map_rosa.yml Outdated
Copy link
Contributor Author

@bmcelvee bmcelvee Apr 7, 2022

Choose a reason for hiding this comment

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

I commented out Accessing a ROSA cluster and Configuring identity providers using the Red Hat OpenShift Cluster Manager because they are duplicates of the assemblies in the Installing, accessing, and deleting ROSA clusters directory. If everyone is okay with me removing those files, I will do so.

bmcelvee
bmcelvee commented Apr 7, 2022
View reviewed changes
_topic_maps/_topic_map_rosa.yml Outdated
Copy link
Contributor Author

@bmcelvee bmcelvee Apr 7, 2022

Choose a reason for hiding this comment

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

Does the Command quick reference for creating clusters and users apply to STS as well? If so, should it be moved up a directory level?

@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch from c57aa49 to 1ab3686 Compare April 7, 2022 18:08
@bmcelvee bmcelvee changed the title [WIP] OSDOCS-3390: ROSA documentation restructure updates OSDOCS-3390: ROSA documentation restructure updates Apr 7, 2022
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Apr 7, 2022
@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch from 1ab3686 to 4398f34 Compare April 7, 2022 18:16
@pneedle-rh
Copy link
Contributor

pneedle-rh commented Apr 8, 2022 •
edited
Loading

@bmcelvee hi! This restructuring looks really great!

I have one small suggestion, but I can't access the relevant area of the topic map for comment in the Files changed tab. So, I'll add it here. In the topic map, you could move "Upgrading ROSA with STS" to be before "Upgrading ROSA", given that STS deployments have primary focus elsewhere in the library. For example:

Name: Upgrading
Dir: upgrading
Distros: openshift-rosa
Topics:
#- Name: Preparing to upgrade ROSA to 4.9
#  File: rosa-upgrading-cluster-prepare
#  Distros: openshift-rosa
- Name: Upgrading ROSA with STS
  File: rosa-upgrading-sts
- Name: Upgrading ROSA
  File: rosa-upgrading

@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch from 4398f34 to 670e0e7 Compare April 8, 2022 14:05
@bmcelvee
Copy link
Contributor Author

bmcelvee commented Apr 11, 2022

Acks required
QE: @yuwang-RH
Eng/PM: @okashi18, @arendej
Product Experience: @davemulford
Docs: @AndrewJones-RH

Preview: https://deploy-preview-43807--osdocs.netlify.app/openshift-rosa/latest/welcome/index.html

Hi! Would you all mind giving this restructure update a review and ack, please? Thanks!

@pneedle-rh pneedle-rh mentioned this pull request Apr 12, 2022
Merged
@davemulford
Copy link

davemulford commented Apr 13, 2022

This looks great!
/label px-approved

@openshift-ci openshift-ci bot added the px-approved Signifies that Product Support has signed off on this PR label Apr 13, 2022
@bmcelvee bmcelvee force-pushed the OSDOCS-3390-restructure-2 branch from 670e0e7 to 84daf50 Compare April 13, 2022 20:44
@0kashi
Copy link
Contributor

0kashi commented Apr 14, 2022

lgtm

@bmcelvee bmcelvee added the peer-review-done Signifies that the peer review team has reviewed this PR label Apr 14, 2022
@bmcelvee bmcelvee merged commit 14cb7c4 into openshift:main Apr 14, 2022
@bmcelvee
Copy link
Contributor Author

bmcelvee commented Apr 14, 2022

/cherrypick enterprise-4.10

@bmcelvee
Copy link
Contributor Author

bmcelvee commented Apr 14, 2022

/cherrypick enterprise-4.11

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Apr 14, 2022
Merged
@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Apr 14, 2022

@bmcelvee: new pull request created: #44581

In response to this:

/cherrypick enterprise-4.10

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@openshift-cherrypick-robot openshift-cherrypick-robot mentioned this pull request Apr 14, 2022
Merged
@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Apr 14, 2022

@bmcelvee: new pull request created: #44582

In response to this:

/cherrypick enterprise-4.11

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@EricPonvelle EricPonvelle mentioned this pull request May 6, 2022
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

branch/enterprise-4.10 branch/enterprise-4.11 peer-review-done Signifies that the peer review team has reviewed this PR px-approved Signifies that Product Support has signed off on this PR size/XL Denotes a PR that changes 500-999 lines, ignoring generated files.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@bmcelvee @pneedle-rh @davemulford @0kashi @openshift-cherrypick-robot