Skip to content

Service Mesh docs fixes during ROSA review#67896

Merged
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:service-mesh-fix-errors
Mar 28, 2024
Merged

Service Mesh docs fixes during ROSA review#67896
mburke5678 merged 1 commit intoopenshift:mainfrom
mburke5678:service-mesh-fix-errors

Conversation

@mburke5678
Copy link
Contributor

@mburke5678 mburke5678 commented Nov 14, 2023

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)

QE review:

  • QE has approved this change.

@openshift-ci openshift-ci bot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 14, 2023
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Nov 20, 2023

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

@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 Nov 20, 2023
@openshift-merge-robot openshift-merge-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 28, 2023
@mburke5678 mburke5678 force-pushed the service-mesh-fix-errors branch from 7a72959 to 53b469e Compare November 28, 2023 17:03
@openshift-merge-robot openshift-merge-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Nov 28, 2023
@mburke5678 mburke5678 force-pushed the service-mesh-fix-errors branch from 3aad910 to e6a9507 Compare December 7, 2023 23:16
@mburke5678 mburke5678 closed this Jan 10, 2024
@mburke5678 mburke5678 reopened this Jan 10, 2024
@openshift-ci openshift-ci bot added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Mar 28, 2024
Copy link
Contributor

@GroceryBoyJr GroceryBoyJr left a comment

Choose a reason for hiding this comment

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

LGTM.

////
This module is included in the following assemblies:
* service_mesh/v2x/ossm-create-smcp.adoc
////
Copy link
Contributor

Choose a reason for hiding this comment

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

Luv ya man, meenit. :-D

. Click the YAML tab.

. Modify the YAML to add projects as members (or delete them to remove existing members). You can add any number of projects, but a project can only belong to *one* `ServiceMeshMemberRoll` resource.
. Modify the YAML to add projects as members (or delete them to remove existing members). You can add any number of projects, but a project can only belong to one `ServiceMeshMemberRoll` resource.
Copy link
Contributor

Choose a reason for hiding this comment

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

Someone got WILD with the word "one". :-D

- Name: Service Mesh 2.x release notes
File: servicemesh-release-notes
- Name: Service Mesh architecture
- Name: Understanding Service Mesh
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
- Name: Understanding Service Mesh
- Name: Understanding Service Mesh

Copy link
Contributor

Choose a reason for hiding this comment

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

This adds the title "Understanding Service Mesh" twice: One at the "top level" menu item and one immediately underneath. The adjacent repetition looks a little odd. I'd suggest the 2nd level title be "A network of microservices", but honestly, I am not at all sure that's an improvement.

@GroceryBoyJr
Copy link
Contributor

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

@GroceryBoyJr
Copy link
Contributor

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

@openshift-ci openshift-ci bot 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 labels Mar 28, 2024
@mburke5678 mburke5678 force-pushed the service-mesh-fix-errors branch from 7af1968 to a0e90ac Compare March 28, 2024 18:10
@openshift-ci
Copy link

openshift-ci bot commented Mar 28, 2024

@mburke5678: all tests passed!

Full PR test history. Your PR dashboard.

Details

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.

@mburke5678 mburke5678 merged commit 83bd2dc into openshift:main Mar 28, 2024
@mburke5678 mburke5678 deleted the service-mesh-fix-errors branch March 28, 2024 19:09
@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.12

1 similar comment
@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.12

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.13

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.14

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.15

@mburke5678
Copy link
Contributor Author

/cherrypick enterprise-4.16

@openshift-cherrypick-robot

@mburke5678: new pull request created: #73919

Details

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.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #73920

Details

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.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #73921

Details

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.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #73922

Details

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.

@openshift-cherrypick-robot

@mburke5678: new pull request created: #73923

Details

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 branch/enterprise-4.15 branch/enterprise-4.16 peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants