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

abhatt-rh · 2023-08-02T22:35:13Z

Dummy content for a onboarding peer reviewer

Version: main

QE review:

QE has approved this change.

abhatt-rh · 2023-08-02T22:36:44Z

Hi @xenolinux,
Requesting your review for this PR :)

ocpdocs-previewbot · 2023-08-02T22:44:39Z

🤖 Updated build preview is available at:
https://63087--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/28570

xenolinux · 2023-08-03T11:08:08Z

modules/dummy-module-abc.adoc

+[id="gathering-data-about-your-cluster-using-must-gather_{context}"]
+= 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.


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.

xenolinux · 2023-08-03T11:09:08Z

modules/dummy-module-abc.adoc

+
+.Prerequisites
+
+* Access to the cluster as a user with the `cluster-admin` role.


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.

xenolinux · 2023-08-03T11:10:30Z

modules/dummy-module-abc.adoc

+.Prerequisites
+
+* Access to the cluster as a user with the `cluster-admin` role.
+* The OpenShift CLI installed.


Suggested change

* The OpenShift CLI installed.

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

xenolinux · 2023-08-03T11:11:44Z

modules/dummy-module-abc.adoc

+
+[source,terminal]
+----
+oc describe mcp/worker-rt


Suggested change

oc describe mcp/worker-rt

$ oc describe mcp/worker-rt

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

xenolinux · 2023-08-03T11:14:34Z

modules/dummy-module-abc.adoc

+
+[source,terminal,subs="+quotes"]
+----
+$ oc label mcp _<mcp-name>_ _<mcp_name>_=""


Suggested change

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

$ oc label mcp <mcp_name> <mcp_name>=""

xenolinux · 2023-08-03T11:22:23Z

modules/dummy-module-xyz.adoc

+// * scalability_and_performance/cnf-create-performance-profiles.adoc
+
+:_content-type: CONCEPT
+[id="cnf-about-the-profile-creator-tool"]


Suggested change

[id="cnf-about-the-profile-creator-tool"]

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

{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

xenolinux · 2023-08-03T11:23:08Z

modules/dummy-module-xyz.adoc

+[id="cnf-about-the-profile-creator-tool"]
+= About the Performance Profile Creator
+
+The PPC is a command-line tool, delivered with the Node Tuning Operator, used to create the performance profile.


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.

xenolinux · 2023-08-03T11:25:51Z

scalability_and_performance/dummy-assembly.adoc

+= Creating a performance profile
+include::_attributes/common-attributes.adoc[]
+:context: cnf-create-performance-profiles
+toc::[]


Suggested change

toc::[]

toc::[]

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

You must have a blank line here before the toc.

xenolinux · 2023-08-03T11:26:11Z

scalability_and_performance/dummy-assembly.adoc

@@ -0,0 +1,23 @@
+[id="cnf-create-performance-profiles]


Suggested change

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

:_content-type: ASSEMBLY

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

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

xenolinux · 2023-08-03T11:30:48Z

scalability_and_performance/dummy-assembly.adoc

+
+
+[role="_additional-resources"]
+= Additional Resources


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

abhatt-rh

Added follow-up comments

abhatt-rh · 2023-08-04T10:04:46Z

modules/dummy-module-abc.adoc

@@ -0,0 +1,57 @@
+// Module included in the following assemblies:
+// Epic CNF-792 (4.8)
+


add a comment about the assembly where this module is used

abhatt-rh · 2023-08-04T10:12:42Z

modules/dummy-module-abc.adoc

+
+[source,terminal]
+----
+oc describe mcp/worker-rt


Suggested change

oc describe mcp/worker-rt

$ oc describe mcp/worker-rt

abhatt-rh · 2023-08-04T10:13:14Z

modules/dummy-module-abc.adoc

+oc describe mcp/worker-rt
+----
+
+[source,bash]


Suggested change

[source,bash]

[source,terminal]

abhatt-rh · 2023-08-04T10:15:26Z

modules/dummy-module-abc.adoc

+oc adm must-gather
+----
+
+. (Optional)- Create a compressed file from the must-gather directory:


Suggested change

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

. Optional: Create a compressed file from the must-gather directory:

abhatt-rh · 2023-08-04T10:24:52Z

modules/dummy-module-xyz.adoc

+
+* Invoking `podman`.
+
+* Calling a wrapper script.


Suggested change

* Calling a wrapper script.

* Calling a wrapper script

abhatt-rh · 2023-08-04T10:26:42Z

scalability_and_performance/dummy-assembly.adoc

@@ -0,0 +1,23 @@
+[id="cnf-create-performance-profiles]


Suggested change

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

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

ID is missing closing quote

abhatt-rh · 2023-08-04T10:27:47Z

scalability_and_performance/dummy-assembly.adoc

+:context: cnf-create-performance-profiles
+toc::[]
+
+Learn about the PPC and how you can use it to create a performance profile.


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

abhatt-rh · 2023-08-04T10:28:25Z

scalability_and_performance/dummy-assembly.adoc

+[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.


remove hard wrapping

abhatt-rh · 2023-08-04T10:29:34Z

scalability_and_performance/dummy-assembly.adoc

+
+
+[role="_additional-resources"]
+= Additional Resources


use h2. each module should have only a single h1

abhatt-rh · 2023-08-04T10:34:07Z

scalability_and_performance/dummy-assembly.adoc

+
+[role="_additional-resources"]
+= Additional Resources
+* For more information about the `must-gather` tool,


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.

abhatt-rh · 2023-10-19T15:26:56Z

/remove-label do-not-merge/work-in-progress

openshift-ci · 2023-10-19T15:27:06Z

@abhatt-rh: The label(s) /remove-label do-not-merge/work-in-progress cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, downstream-change-needed, rebase/manual, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cloud-experts, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, peer-review-done, peer-review-in-progress, peer-review-needed, rhacs, rhv, sd-docs, serverless, service-mesh, sme-review-done, sme-review-needed, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/remove-label do-not-merge/work-in-progress

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.

abhatt-rh · 2023-10-19T15:28:57Z

/remove-label do-not-merge

openshift-ci · 2023-10-19T15:28:59Z

@abhatt-rh: The label(s) /remove-label do-not-merge cannot be applied. These labels are supported: acknowledge-critical-fixes-only, platform/aws, platform/azure, platform/baremetal, platform/google, platform/libvirt, platform/openstack, ga, tide/merge-method-merge, tide/merge-method-rebase, tide/merge-method-squash, px-approved, docs-approved, qe-approved, downstream-change-needed, rebase/manual, approved, backport-risk-assessed, bugzilla/valid-bug, cherry-pick-approved, cloud-experts, cnv, dev-tools, distributed-tracing, ims, jira/valid-bug, merge-review-in-progress, merge-review-needed, mtc, multi-arch, oadp, peer-review-done, peer-review-in-progress, peer-review-needed, rhacs, rhv, sd-docs, serverless, service-mesh, sme-review-done, sme-review-needed, staff-eng-approved, telco. Is this label configured under labels -> additional_labels or labels -> restricted_labels in plugin.yaml?

In response to this:

/remove-label do-not-merge

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-ci · 2024-01-09T02:53:22Z

@abhatt-rh: The following test failed, say /retest to rerun all failed tests or /retest-required to rerun all mandatory failed tests:

Test name	Commit	Details	Required	Rerun command
ci/prow/validate-asciidoc	`cc0fce0`	link	true	`/test validate-asciidoc`

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-bot · 2024-04-10T01:01:12Z

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale.
Stale issues rot after an additional 30d of inactivity and eventually close.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot · 2024-05-10T08:30:52Z

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten.
Rotten issues close after an additional 30d of inactivity.
Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten
/remove-lifecycle stale

openshift-bot · 2024-06-10T00:00:58Z

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci · 2024-06-10T00:01:34Z

@openshift-bot: Closed this PR.

In response to this:

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen.
Mark the issue as fresh by commenting /remove-lifecycle rotten.
Exclude this issue from closing again by commenting /lifecycle frozen.

/close

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-sigs/prow repository.

Dummy content for a new peer reviewer to practice

89d3e44

openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Aug 2, 2023

xenolinux reviewed Aug 3, 2023

View reviewed changes

abhatt-rh commented Aug 4, 2023

View reviewed changes

abhatt-rh assigned abhatt-rh and unassigned abhatt-rh Oct 6, 2023

abhatt-rh force-pushed the dummy-pr branch from f6e1660 to 7550acf Compare October 18, 2023 11:07

abhatt-rh closed this Oct 18, 2023

abhatt-rh reopened this Oct 18, 2023

abhatt-rh force-pushed the dummy-pr branch 3 times, most recently from b4f3abf to 8a5e823 Compare October 18, 2023 11:24

abhatt-rh removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 18, 2023

abhatt-rh force-pushed the dummy-pr branch from 8a5e823 to 3cd31a9 Compare October 18, 2023 12:00

testing a CI failure

cc0fce0

abhatt-rh force-pushed the dummy-pr branch from 3cd31a9 to cc0fce0 Compare October 18, 2023 12:02

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 Oct 18, 2023

abhatt-rh added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 18, 2023

openshift-ci bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 10, 2024

openshift-ci bot added lifecycle/rotten Denotes an issue or PR that has aged beyond stale and will be auto-closed. and removed lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. labels May 10, 2024

openshift-ci bot closed this Jun 10, 2024

	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.

	* 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.
	* You must have the OpenShift CLI (`oc`) installed.

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

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

	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.

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

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

		@@ -0,0 +1,57 @@
		// Module included in the following assemblies:
		// Epic CNF-792 (4.8)

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

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

	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.

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

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

Uh oh!

Conversation

abhatt-rh commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

abhatt-rh commented Aug 2, 2023

Uh oh!

ocpdocs-previewbot commented Aug 2, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhatt-rh left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

abhatt-rh commented Oct 19, 2023

Uh oh!

openshift-ci bot commented Oct 19, 2023

Uh oh!

abhatt-rh commented Oct 19, 2023

Uh oh!

openshift-ci bot commented Oct 19, 2023

Uh oh!

openshift-ci bot commented Jan 9, 2024

Uh oh!

openshift-bot commented Apr 10, 2024

Uh oh!

openshift-bot commented May 10, 2024

Uh oh!

openshift-bot commented Jun 10, 2024

Uh oh!

openshift-ci bot commented Jun 10, 2024

abhatt-rh commented Aug 2, 2023 •

edited

Loading

ocpdocs-previewbot commented Aug 2, 2023 •

edited

Loading