openshift-docs icon indicating copy to clipboard operation
openshift-docs copied to clipboard

Service Mesh docs fixes during ROSA review

Open mburke5678 opened this issue 2 years ago • 3 comments

Fixing various errors in the Applications docs as I find them during the ROSA content port. Mostly formatting, wording, and such.

Previews: Understanding Service Mesh -- Updated topic map to match the assembly name. Current docs. Configuring distributed tracing security for service mesh from the command line -- Updated step 3 and 5 based on experienced. Current docs. Configuring distributed tracing security for service mesh from the web console -- Formatting changes. Managing certificates with Elasticsearch -- Removed version-specific prereqs. Adding or removing projects from the mesh using ServiceMeshMemberRoll resource with the CLI -- Formatting changes. Adding or removing projects from the mesh using the ServiceMeshMemberRoll resource with the web console -- Formatting changes. Adding a project to the mesh using the ServiceMeshMember resource with the CLI -- Moved verification steps into a new verification section. Adding a project to the mesh using the ServiceMeshMember resource with the web console -- Moved verification steps into a new verification section. Service Mesh architecture -- Fixed typo in third paragraph. Configuring the Service Mesh Operator to run on infrastructure nodes -- Added metadata to code block in step 3. Deploying the Service Mesh control plane from the web console -- Split Step 6 into substeps. Moved verification steps into a new verification section. Current docs. 3scale configuration -- Assembly doesn't seem to appear in docs. Added metadata to code block. Configuring the control plane for cluster-wide deployment with the CLI -- Added new prereq (Needs QE), swapped period for a colon, moved verify steps to new section. Configuring the control plane for cluster-wide deployment with the web console -- Added new prereq (Needs QE), swapped period for a colon, moved verify steps to new section. Deploying the distributed tracing platform -- Fixed [source] in Production distributed tracing platform (Jaeger) deployment, Control plane with linked Jaeger production CR, Control plane with linked Jaeger streaming CR examples. Installing the Operators -- Split Step 6, bullet 3 into separate bullets. Moved verification steps into a new verification section. Operator overview -- Added parenthesis to Kiali Operator (provided by Red Hat) for searchability in the console. Creating the member roll from the web console -- Removed unneeded bolding on one in Step 8. Creating the member roll from the CLI -- Removed unneeded bolding on one in Step 3. Adding or removing projects from the service mesh (v1) -- Removed unneeded bolding on one in second bullet Adding or removing projects from the member roll using the web console (v1) -- Removed unneeded bolding on one in Step 8. Adding or removing projects from the member roll using the CLI (v1)

mburke5678 avatar Nov 14 '23 21:11 mburke5678

🤖 Thu Mar 28 18:16:40 - Prow CI generated the docs preview: https://67896--ocpdocs-pr.netlify.app

ocpdocs-previewbot avatar Nov 20 '23 15:11 ocpdocs-previewbot

@mburke5678 : I have started reviewing this from the ServiceMesh QE team.

If, I have any questions, I will let you know.

Thanks for the changes in the docs.

pbajjuri20 avatar Mar 22 '24 21:03 pbajjuri20

/label peer-review-in-progress /remove-label peer-review-needed /assign GroceryBoyJr

GroceryBoyJr avatar Mar 28 '24 15:03 GroceryBoyJr

@mburke5678 I put a question in this peer review but still, I believe an LGTM is appropriate.

GroceryBoyJr avatar Mar 28 '24 15:03 GroceryBoyJr

/label peer-review-done /remove-label peer-review-in-progress /unassign GroceryBoyJr

GroceryBoyJr avatar Mar 28 '24 15:03 GroceryBoyJr

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

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. I understand the commands that are listed here.

openshift-ci[bot] avatar Mar 28 '24 18:03 openshift-ci[bot]

/cherrypick enterprise-4.12

mburke5678 avatar Mar 28 '24 19:03 mburke5678

/cherrypick enterprise-4.12

mburke5678 avatar Mar 28 '24 19:03 mburke5678

/cherrypick enterprise-4.13

mburke5678 avatar Mar 28 '24 19:03 mburke5678

/cherrypick enterprise-4.14

mburke5678 avatar Mar 28 '24 19:03 mburke5678

/cherrypick enterprise-4.15

mburke5678 avatar Mar 28 '24 19:03 mburke5678

/cherrypick enterprise-4.16

mburke5678 avatar Mar 28 '24 19:03 mburke5678

@mburke5678: new pull request created: #73919

In response to this:

/cherrypick enterprise-4.12

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.

@mburke5678: new pull request created: #73920

In response to this:

/cherrypick enterprise-4.13

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.

@mburke5678: new pull request created: #73921

In response to this:

/cherrypick enterprise-4.14

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.

@mburke5678: new pull request created: #73922

In response to this:

/cherrypick enterprise-4.15

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.

@mburke5678: new pull request created: #73923

In response to this:

/cherrypick enterprise-4.16

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.