Skip to content

WIP: Dummy content for a new peer reviewer to practice #63087

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

Closed
wants to merge 2 commits into from
Closed

WIP: Dummy content for a new peer reviewer to practice #63087

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
89d3e44
Dummy content for a new peer reviewer to practice
abhatt-rh Aug 2, 2023
cc0fce0
testing a CI failure
abhatt-rh Oct 18, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion _topic_maps/_topic_map.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Name: About
Dir: welcome
Distros: openshift-enterprise,openshift-webscale,openshift-origin,openshift-online,openshift-dpu
Topics:
- Name: Welcome

File: index
- Name: Learn more about OpenShift Container Platform
File: learn_more_about_openshift
Expand Down
59 changes: 59 additions & 0 deletions modules/dummy-module-abc.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
// Module included in the following assemblies:
// Epic CNF-792 (4.8)

Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

add a comment about the assembly where this module is used

= Gathering data about your cluster using the must-gather command

The Performance Profile Creator (PPC) tool requires `must-gather` data. As a cluster administrator, run the must-gather command to capture information about your cluster.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
The Performance Profile Creator (PPC) tool requires `must-gather` data. As a cluster administrator, run the must-gather command to capture information about your cluster.
The Performance Profile Creator (PPC) tool requires the `must-gather` data. As a cluster administrator, run the `must-gather` command to capture information about your {product-title} cluster.


.Prerequisites

* Access to the cluster as a user with the `cluster-admin` role.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
* Access to the cluster as a user with the `cluster-admin` role.
* You must have access to a {product-title} cluster as a user with the `cluster-admin` role.

* The OpenShift CLI installed.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
* The OpenShift CLI installed.
* You must have the OpenShift CLI (`oc`) installed.


.Procedure

. Optional: Verify that a matching machine config pool exists with a label:
+
[source,terminal]
----
oc describe mcp/worker-rt
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
oc describe mcp/worker-rt
$ oc describe mcp/worker-rt

Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

At the start of the command, the $ sign must be used if a command is being run by a user instead of a root.

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#code-blocks-command-syntax-and-example-output

Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
oc describe mcp/worker-rt
$ oc describe mcp/worker-rt

----
+
[source,bash]
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
[source,bash]
[source,terminal]

----
Name: worker-rt
Namespace:
Labels: machineconfiguration.openshift.io/role=worker-rt
----

. If a matching label does not exist add a label for a machine config pool (MCP) that matches with the MCP name:
+
[source,terminal,subs="+quotes"]
----
$ oc label mcp _<mcp-name>_ _<mcp_name>_=""
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
$ oc label mcp _<mcp-name>_ _<mcp_name>_=""
$ oc label mcp <mcp_name> <mcp_name>=""

----

. Navigate to the directory where you want to store the `must-gather` data.

. Collect cluster information by running the following command.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
. Collect cluster information by running the following command.
. Collect cluster information by running the following command:

+
[source,terminal]
----
oc adm must-gather
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
oc adm must-gather
$ oc adm must-gather

----

. (Optional)- Create a compressed file from the must-gather directory:
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
. (Optional)- Create a compressed file from the must-gather directory:
. Create a compressed file from the `must-gather` directory:

Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
. (Optional)- Create a compressed file from the must-gather directory:
. Optional: Create a compressed file from the must-gather directory:

+
[source,terminal]
----
$ tar cvaf must-gather.tar.gz must-gather/
----
+
[NOTE]
====
Compressed output is required if you are running the Performance Profile Creator wrapper script.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
Compressed output is required if you are running the Performance Profile Creator wrapper script.
Compressed output is required if you are running the Performance Profile Creator wrapper (PPC) script.

Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

When using the term for the first time in the module use the abbreviation in parenthesis.

====

xref:/machine_management/manually-scaling-machineset.adoc#machineset-manually-scaling_manually-scaling-machineset[test]

xref:modules/about-administrator-perspective.adoc
16 changes: 16 additions & 0 deletions modules/dummy-module-xyz.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
// Module included in the following assemblies:
// Epic CNF-792 (4.8)
// * scalability_and_performance/cnf-create-performance-profiles.adoc

:_content-type: CONCEPT
[id="cnf-about-the-profile-creator-tool"]
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
[id="cnf-about-the-profile-creator-tool"]
[id="cnf-about-the-profile-creator-tool_{context}"]

Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

{context} is missing
Context used for identifying headers in modules that is the same as the anchor ID. Example: cli-developer-commands.

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#assembly-file-metadata

= About the Performance Profile Creator

The PPC is a command-line tool, delivered with the Node Tuning Operator, used to create the performance profile.
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
The PPC is a command-line tool, delivered with the Node Tuning Operator, used to create the performance profile.
The Performance Profile Creator (PPC) is a command-line tool, delivered with the Node Tuning Operator (NTO), used to create the performance profile.

The tool consumes `must-gather` data from the cluster and several user-supplied profile arguments. The PPC generates a performance profile that is appropriate for your hardware and topology.

The tool is executed by one of the following methods:

* Invoking `podman`.
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
* Invoking `podman`.
* Invoking `podman`

See IBM Style for https://www.ibm.com/docs/en/ibm-style?topic=format-lists#punctuation-in-lists

Write lists so that all or none of the items start with complete sentences. If list items comprise only complete sentences, include a period after each sentence.


* Calling a wrapper script.
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
* Calling a wrapper script.
* Calling a wrapper script

23 changes: 23 additions & 0 deletions scalability_and_performance/dummy-assembly.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
[id="cnf-create-performance-profiles]
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
[id="cnf-create-performance-profiles]
:_content-type: ASSEMBLY
[id="cnf-create-performance-profiles]

Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

The content type for the file. Replace with the actual type of the module, CONCEPT, REFERENCE, or PROCEDURE. Place this attribute before the anchor ID or, if present, the conditional that contains the anchor ID.

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#module-file-metadata

Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
[id="cnf-create-performance-profiles]
[id="cnf-create-performance-profiles"]

ID is missing closing quote

= Creating a performance profile
include::_attributes/common-attributes.adoc



Learn about the PPC and how you can use it to create a performance profile.
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Suggested change
Learn about the PPC and how you can use it to create a performance profile.
Learn about the Performance Profile Creator (PPC) and how you can use it to create a performance profile.

Expand on first use


[NOTE]
====
Currently, disabling CPU load balancing is not supported by cgroup v2. As a result,
you might not get the desired behavior from performance profiles if you have cgroup v2 enabeld. Enabling cgroup v2 is not recommended if you are using performace profiles.
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

remove hard wrapping

====

include::modules/dummy-module-xyz.adoc[leveloffset=+1]

include::modules/dummy-module-abc.adoc[leveloffset=]


[role="_additional-resources"]
= Additional Resources
Copy link
Contributor

@xenolinux xenolinux Aug 3, 2023

Choose a reason for hiding this comment

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

Suggested change
= Additional Resources
[id="additional-resources_dumy-assembly"]
= Additional Resources

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#additional-resources-sections

You must provide id for additional resources section

Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

use h2. each module should have only a single h1

* For more information about the `must-gather` tool,
Copy link
Contributor Author

@abhatt-rh abhatt-rh Aug 4, 2023

Choose a reason for hiding this comment

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

Remove hard wrapping and see OCP doc guidelines for https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#additional-resources-sections

You must not include paragraphs in the section. Use an unordered list.

see xref:../support/gathering-cluster-data.adoc#nodes-nodes-managing[Gathering data about your cluster].