OSSMDOC-525: Preliminary Jupiter updates, first half Service Mesh files. #45897
Conversation
JStickler
added
branch/enterprise-4.6
service-mesh
openshift-ci
bot
added
the
size/L
There was a problem hiding this comment.
@JStickler hi! I have completed my review of this PR. Please let me know if you have any questions.
Please provide a link to a locally-generated preview after you have addressed my suggestions. The changes in this PR do make a difference to the preview build and as such I cloned your fork locally and generated a preview in order to complete my review.
Please also squash the commits into one.
Thanks!
| :_content-type: PROCEDURE | ||
| [id="ossm-security-mtls-sidecars-outgoing_{context}"] | ||
| == Configuring sidecars for outgoing connections | ||
| = Configuring sidecars for outgoing connections |
There was a problem hiding this comment.
Just to highlight that with this line change, the section heading is rendered visible in the TOC in the ../service_mesh/v2x/ossm-security.html assembly. In the live version is an H3 heading embedded within the H2 "Enabling strict mTLS across the service mesh" heading. But, with this change, in the preview it becomes an H2 heading that is parallel with "Enabling strict mTLS across the service mesh", not embedded within it.
Please create a local preview and review all of the heading changes that you have made in this PR to see if the indentations are changed. If they are, you might need to increment the level offset in the corresponding include statements in the assemblies that include the modules so that the headings remain at the same indentation that they are in the live documentation.
Essentially, as it stands this change moves the heading up one indentation because the corresponding include has not been incremented to allow for the adjustment from == to =. This is the case for several of these in this PR, but I will not mention them all here.
Please also check your other Jupiter update PRs for similar occurrences.
| @@ -0,0 +1,11 @@ | |||
| // Module included in the following assemblies: | |||
| // | |||
| // * service_mesh/v2x/customizing-installation-ossm.adoc | |||
There was a problem hiding this comment.
I can't see the assembly mentioned in this line in the file structure in this PR. This module also does not appear to be added anywhere else either. Are you intending to include it in this PR or in a later one?
|
|
||
|
|
||
| [id="ossm-specifying-jaeger-configuration_{context}"] | ||
| = Specifying Jaeger configuration in the SMCP |
There was a problem hiding this comment.
You could update "Jaeger configuration" to "a Jaeger configuration" or something similar.
| // | ||
| // * service_mesh/v2x/customizing-installation-ossm.adoc | ||
|
|
||
|
|
There was a problem hiding this comment.
Each .adoc file must contain a :_content-type: attribute in its metadata that indicates its file type. Please add one in this file. Please see https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#content-type-attributes for more details.
| [id="ossm-specifying-jaeger-configuration_{context}"] | ||
| = Specifying Jaeger configuration in the SMCP | ||
|
|
||
| You configure Jaeger under the `addons` section of the `ServiceMeshControlPlane` resource. However, there are limitations to what you can configure in the SMCP. |
There was a problem hiding this comment.
You could define the full description of "SMCP" directly before the first use of this acronym in this file.
| == Additional resources | ||
|
|
||
| * For more information about tuning {SMProductShortName} for performance, see xref:../../service_mesh/v2x/ossm-performance-scalability.adoc#ossm-performance-scalability[Performance and scalability]. | ||
| * xref:../../service_mesh/v2x/ossm-performance-scalability.adoc#ossm-performance-scalability[Performance and scalability]. |
There was a problem hiding this comment.
You could remove the full stop from this bullet point, since it is not a full sentence.
|
|
||
| * Install and configure {SMProductName}. | ||
| * Test your configuration in a staging environment. | ||
There was a problem hiding this comment.
The TOC is not rendered for this page in the preview. Please add a blank link prior to the toc::[] line at line 6 and check if that then resolves the issue. I am unable to comment directly in that line in this PR.
| include::modules/ossm-config-sec-mtls-mesh.adoc[leveloffset=+2] | ||
|
|
||
| include::modules/ossm-config-sidecar-mtls.adoc[leveloffset=+3] | ||
| include::modules/ossm-config-sidecar-mtls.adoc[leveloffset=+2] |
There was a problem hiding this comment.
In the live build, the first heading in the target module is H3 in the assembly and it is subsequently not rendered in the TOC. Are you intending to increase it by one level? In the preview, the "Configuring sidecars for incoming connections for specific services" heading is parallel to the "Enabling strict mTLS across the service mesh" heading, whereas in the live build it is nested within it.
| ==== Additional resources | ||
|
|
||
| [role="_additional-resources"] | ||
| == Additional resources |
There was a problem hiding this comment.
You could update this to .Additional resources, since there are subsequent module includes and this seems specific to the preceding module.
|
|
||
| [role="_additional-resources"] | ||
| .Additional resources | ||
| == Additional resources |
There was a problem hiding this comment.
You could keep this as .Additional resources, since there are subsequent module includes and this seems specific to the preceding module.
pneedle-rh
added
the
peer-review-done
openshift-ci
bot
added
the
needs-rebase
|
@JStickler: PR needs rebase. 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. |
|
The enterprise-4.12 label has been added to this PR. This is because your PR targets the If the update in your PR does NOT apply to version 4.12 onward, please re-target this PR to go directly into the appropriate version branch or branches (enterprise-4.x) instead of main. |
|
Closing - outdated. |
4 participants
Version(s): 4.6 - 4.11
Issue: OSSMDOC-525
Link to docs preview: No visible changes in output?
This PR is not intended to address all required Jupiter changes, it only includes some preliminary cleanup done while scoping Jupiter work for the Epic OSSMDOC-523. This PR may include: