[OBSDOCS-3179] Release notes for Logging 6.5.0#108830
[OBSDOCS-3179] Release notes for Logging 6.5.0#108830ochromy wants to merge 1 commit intoopenshift:standalone-logging-docs-6.5from
Conversation
openshift-ci
bot
added
the
size/XXL
|
🤖 Sun Mar 22 14:25:59 - Prow CI generated the docs preview: https://108830--ocpdocs-pr.netlify.app/ |
| [id="attribute-files"] | ||
| == Attribute files | ||
|
|
||
| All attribute files must be placed in the `_attributes` directory. In most cases involving OpenShift Container Platform or OKD, add attributes to the `common-attributes.adoc` file instead of creating or using a separate attributes file. Before you add an attribute, review the contents of the `common-attributes.adoc` file to ensure that it is not already defined. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| Most modules cannot contain xrefs. If you must include a link in a module, use the `link` attribute type and treat it as an external reference. The only exception is release notes modules, which may contain xrefs as long as the module is included in only one location. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'if' or 'provided that' rather than 'as long as'. For more information, see RedHat.TermsErrors.
|
|
||
| Example: | ||
|
|
||
| You could write the following paragraph once and include it in each assembly that explains how to install a cluster using the installer-provisioned default values: |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'installation program' rather than 'the installer'. For more information, see RedHat.TermsErrors.
| * 4 for the `latest/` build from the `main` branch | ||
|
|
||
| |`openshift-enterprise` | ||
| |OpenShift Container Platform |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| `openshift-enterprise` distro (for any of the distro-defined branches), this | ||
| would render as: | ||
|
|
||
| > You can deploy applications on OpenShift Container Platform. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| Considering that we use distinct branches to keep content for product versions separated, global use of `{product-version}` across all branches is probably less useful, but it is available if you come across a requirement for it. Just consider how it will render across any branches that the content appears in. | ||
|
|
||
| If it makes more sense in context to refer to the major version of the product instead of a specific minor version (for example, if comparing how something in OpenShift Container Platform 4 differs from OpenShift Container Platform 3), just use the major version number. Do not prepend with a `v`, as in `v3` or `v4`. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| Considering that we use distinct branches to keep content for product versions separated, global use of `{product-version}` across all branches is probably less useful, but it is available if you come across a requirement for it. Just consider how it will render across any branches that the content appears in. | ||
|
|
||
| If it makes more sense in context to refer to the major version of the product instead of a specific minor version (for example, if comparing how something in OpenShift Container Platform 4 differs from OpenShift Container Platform 3), just use the major version number. Do not prepend with a `v`, as in `v3` or `v4`. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| NOTE: You can nest conditional statements that involve distribution and assembly context, but you must ensure that you close the if statements correctly. | ||
|
|
||
| Because we maintain separate branches for each OpenShift Container Platform version, do not use if statements that are based on product version to vary content. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| [id="conditionals-for-distributions"] | ||
| === Conditionals for distributions | ||
|
|
||
| Use ifdef and ifndef statements to control content based on distribution, as described in the previous section. For example, the following example renders differently in (`openshift-origin`) and OpenShift Container Platform (`openshift-enterprise`): |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| > You can link:https://www.keycloak.org/docs/latest/server_admin/index.html#openshift[configure a Keycloak] server as an OpenID | ||
| Connect identity provider for OKD. | ||
|
|
||
| In OpenShift Container Platform, this section renders as the following text: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| > You can | ||
| link:https://access.redhat.com/documentation/en-us/red_hat_single_sign-on/[configure Red Hat Single Sign-On] | ||
| as an OpenID Connect identity provider for OpenShift Container Platform. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| [id="node-names"] | ||
| === Node names | ||
|
|
||
| Do not use internal company server names in commands or example output. Provide generic OpenShift Container Platform node name examples that are not provider-specific, unless required. Where possible, use the example.com domain name when providing fully qualified domain names (FQDNs). |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| Do not use internal company server names in commands or example output. Provide generic OpenShift Container Platform node name examples that are not provider-specific, unless required. Where possible, use the example.com domain name when providing fully qualified domain names (FQDNs). | ||
|
|
||
| The following table includes example OpenShift Container Platform 4 node names and their corresponding role types: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| [NOTE] | ||
| ==== | ||
| Some provider-formatted hostnames include IPv4 addresses. An OpenShift Container Platform node name typically reflects the hostname of a node. If node names in your output need to be provider-specific and require this format, use private IPv4 addresses. For example, you could use `ip-10-0-48-9.example.com` as a node name that includes a private IPv4 address. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| == Links, hyperlinks, and cross references | ||
| Links can be used to cross-reference internal assemblies or send readers to external information resources for further reading. | ||
|
|
||
| In OpenShift Container Platform docs: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| Exception: You may use cross-references (`xref`) in modules only for release notes. The module must only ever be included once from one assembly. | ||
| ==== | ||
| * All links to external websites are created by using the `link` attribute. | ||
| * Links between different distributions, or _distros_, such as from ROSA to OpenShift Container Platform, are external links and not cross-references. These external links use `link` instead of `xref` and must be in distro-specific files or a conditionalized state to apply to the relevant distros. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| [id="lead-in-link-sentences"] | ||
| === Lead-in link sentences | ||
|
|
||
| Using a lead-in link sentence that adheres to guidelines maintains consistency across OpenShift Container Platform documentation. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| * xref:../../../installing/installing_vsphere/installation-config-parameters-vsphere.adoc#installation-config-parameters-vsphere[Installation configuration parameters] | ||
| ---- | ||
|
|
||
| * When pointing to a link in a section (module) that exists in another OpenShift Container Platform document (assembly), use the following format: |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| In OpenShift docs, you can normally only use `xref` in assemblies, not in modules. The only exception is release notes modules, which may contain xrefs as long as the module is included in only one location. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'if' or 'provided that' rather than 'as long as'. For more information, see RedHat.TermsErrors.
| For more information on how this is applied, see link:https://github.com/openshift/openshift-docs/pull/31776/files[this example PR]. | ||
|
|
||
| == Verification of your content | ||
| All documentation changes that update or add technical content must be verified by a QE team associate before merging. This QE verification process includes executing all procedures, confirming expected results, and confirming the accuracy of conceptual and reference content. The only exceptions are for typo-level changes, formatting-only changes, and other negotiated documentation sets and distributions. |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'typing error' or 'typographical error' rather than 'typo'. For more information, see RedHat.TermsErrors.
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| In core OpenShift Container Platform documentation, do not italicize user-replaced values. This guideline is an exception to the link:https://redhat-documentation.github.io/supplementary-style-guide/#user-replaced-values[_Red Hat supplementary style guide for product documentation_]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| The total number of persistent volume claims in a project. | ||
| .... | ||
|
|
||
| Note that if an object uses an acronym or other special capitalization, then its general reference should honor that. For example, general references to `APIService` should be written as "API service", not "api service". Any other exceptions or special guidance are noted in the xref:../contributing_to_docs/term_glossary.adoc[glossary]. |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.XrefContainsAnchorID: The xref is missing an anchor ID.
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.ModuleContainsContentType: Module is missing the '_mod-docs-content-type' variable.
| • composite content view: Updated glossary entry to use lowercase spelling | ||
| • content view: Updated glossary entry to use lowercase spelling | ||
| • Nmstate: Added glossary entry | ||
| • on-premise: Updated glossary entry to include Red Hat OpenShift Container Platform definition |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| • Network Time Configuration: Added glossary entry | ||
| • n-way replication: Added glossary entry | ||
| • object storage: Added glossary entry | ||
| • OpenShift Container Platform cluster: Added glossary entry |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{product-title}' rather than the plain text product term 'OpenShift Container Platform', unless your use case is an exception.
| 2023 | ||
| December 2023 | ||
| Glossary entries | ||
| • IBM Cloud®: Added glossary entry |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-cloud-title}' rather than the plain text product term 'IBM Cloud', unless your use case is an exception.
| Glossary entries | ||
| • AWS Local Zone: Added glossary entry | ||
| • AWS opt-in Region: Added glossary entry | ||
| • IBM Cloud® Bare Metal (Classic): Added glossary entry |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-cloud-title}' rather than the plain text product term 'IBM Cloud', unless your use case is an exception.
| • DNF Automatic: Added glossary entry | ||
| • domain controller: Updated glossary entry to include IdM-specific information | ||
| • file trigger directive: Added glossary entry | ||
| • IBM eServer System p: Updated to "do not use"; use "IBM Power" instead |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-power-title}' rather than the plain text product term 'IBM Power', unless your use case is an exception.
| • domain controller: Updated glossary entry to include IdM-specific information | ||
| • file trigger directive: Added glossary entry | ||
| • IBM eServer System p: Updated to "do not use"; use "IBM Power" instead | ||
| • IBM S/390: Updated to "do not use"; use "IBM Z" instead |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-z-title}' rather than the plain text product term 'IBM Z', unless your use case is an exception.
| • IBM eServer System p: Updated to "do not use"; use "IBM Power" instead | ||
| • IBM S/390: Updated to "do not use"; use "IBM Z" instead | ||
| • interpreted code: Added glossary entry | ||
| • ISeries: Updated to "do not use"; use "IBM Power" instead |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-power-title}' rather than the plain text product term 'IBM Power', unless your use case is an exception.
| • module profile: Added glossary entry | ||
| • module stream: Added glossary entry | ||
| • natively compiled code: Added glossary entry | ||
| • pSeries: Updated to "do not use"; use "IBM Power" instead |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-power-title}' rather than the plain text product term 'IBM Power', unless your use case is an exception.
| Glossary entries | ||
| • Elastic Load Balancing: Added glossary entry | ||
| • IBM® LinuxONE: Added glossary entry | ||
| • IBM Power®: Added glossary entry |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-power-title}' rather than the plain text product term 'IBM Power', unless your use case is an exception.
| • Elastic Load Balancing: Added glossary entry | ||
| • IBM® LinuxONE: Added glossary entry | ||
| • IBM Power®: Added glossary entry | ||
| • IBM Z®: Updated glossary entry |
There was a problem hiding this comment.
🤖 [error] OpenShiftAsciiDoc.SuggestAttribute: Use the AsciiDoc attribute '{ibm-z-title}' rather than the plain text product term 'IBM Z', unless your use case is an exception.
| • IBM Power®: Added glossary entry | ||
| • IBM Z®: Updated glossary entry | ||
| • Red Hat build of OpenJDK: Added glossary entry | ||
| • Red Hat Java: Added glossary entry |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'Red Hat build of OpenJDK' rather than 'Red Hat Java'. For more information, see RedHat.TermsErrors.
| • Red Hat build of OpenJDK: Added glossary entry | ||
| • Red Hat Java: Added glossary entry | ||
| 11 | Red Hat supplementary style guide for product documentation | ||
| • Red Hat OpenJDK: Added glossary entry |
There was a problem hiding this comment.
🤖 [error] RedHat.TermsErrors: Use 'Red Hat build of OpenJDK' rather than 'Red Hat OpenJDK'. For more information, see RedHat.TermsErrors.
| • Removing blacklist | ||
| Heat blacklists any servers in the list from receiving updated heat deployments. After the stack | ||
| operation completes, any blacklisted servers remain unchanged. You can also power off or stop | ||
| the os-collect-config agents during the operation. |
There was a problem hiding this comment.
🤖 [error] RedHat.Spacing: Keep one space between words in 'operation. Heat'. For more information, see RedHat.Spacing.
| os-collect-config agents during the operation. | ||
| 15 | Red Hat supplementary style guide for product documentation | ||
| • Removing whitelist | ||
| The following steps demonstrate adding a new rule to whitelist a custom binary. |
There was a problem hiding this comment.
🤖 [error] RedHat.Spacing: Keep one space between words in 'binary. The'. For more information, see RedHat.Spacing.
| A Ceph Monitor maintains the main copy of the Red Hat Ceph Storage cluster map with the | ||
| current state of the Red Hat Ceph Storage cluster. | ||
| • Removing slave | ||
| Use the following command to copy the public key to the slave node. |
There was a problem hiding this comment.
🤖 [error] RedHat.Spacing: Keep one space between words in 'node. Use'. For more information, see RedHat.Spacing.
|
@ochromy: all tests passed! Full PR test history. Your PR dashboard. DetailsInstructions 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-sigs/prow repository. I understand the commands that are listed here. |
3 participants
Version(s):
Issue:
Link to docs preview:
FIXME
QE review: