Skip to content

Fix RST formatting and style guide compliance - #255

Merged
chenopis merged 10 commits into
mainfrom
fix-install-gpu-ocp
Sep 18, 2025
Merged

chenopis merged 10 commits into
mainfrom
fix-install-gpu-ocp

Conversation

@chenopis

@chenopis chenopis commented Sep 18, 2025 •

Copy link
Copy Markdown
Collaborator

Several major HTML formatting issues due to RST indentation syntax mistakes.

For example, visually compare: https://docs.nvidia.com/datacenter/cloud-native/openshift/25.3.2/install-gpu-ocp.html
with preview: https://nvidia.github.io/cloud-native-docs/review/pr-255/openshift/latest/install-gpu-ocp.html

Signed-off-by: Andrew Chen andrewch@nvidia.com

@chenopis chenopis self-assigned this Sep 18, 2025
@github-actions

Copy link
Copy Markdown

Documentation preview

https://nvidia.github.io/cloud-native-docs/review/pr-255

@chenopis
chenopis force-pushed the fix-install-gpu-ocp branch 2 times, most recently from 363a3ba to c12f58e Compare September 18, 2025 03:31
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
@chenopis
chenopis force-pushed the fix-install-gpu-ocp branch 13 times, most recently from 6e1ae30 to f0bad74 Compare September 18, 2025 09:15
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
@chenopis chenopis changed the title Fix RST formatting and style guide compliance for OCP Fix RST formatting and style guide compliance Sep 18, 2025

@mikemckiernan mikemckiernan left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Thanks so much for the care and time that you put into this PR. It's great to see the attention to detail.

I think you modified some of the same files in another PR. I didn't point out that new terms, like sandboxing and sandbox workloads are styled in italics because I shared it in the other review.

Comment thread gpu-operator/gpu-operator-kubevirt.rst Outdated
Comment thread openshift/time-slicing-gpus-in-openshift.rst
Signed-off-by: Andrew Chen <andrewch@nvidia.com>
@chenopis
chenopis merged commit 58ddd9d into main Sep 18, 2025
2 checks passed
@chenopis
chenopis deleted the fix-install-gpu-ocp branch September 18, 2025 17:42
chenopis added a commit that referenced this pull request Oct 2, 2025
* Fix RST formatting and style guide compliance

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix install-nfd.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mig-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix nvaie-with-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mirror-gpu-ocp-disconnected.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix more indentation syntax issues

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes + pre-requisites -> prerequisites

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more changes to match style guide

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* revert gpu-operator-kubevirt.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

---------

Signed-off-by: Andrew Chen <andrewch@nvidia.com>
chenopis added a commit that referenced this pull request Oct 2, 2025
* Fix RST formatting and style guide compliance

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix install-nfd.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mig-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix nvaie-with-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mirror-gpu-ocp-disconnected.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix more indentation syntax issues

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes + pre-requisites -> prerequisites

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more changes to match style guide

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* revert gpu-operator-kubevirt.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

---------

Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: chenopis <andrewch@nvidia.com>
chenopis added a commit that referenced this pull request Oct 2, 2025
* Fix RST formatting and style guide compliance

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix install-nfd.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mig-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix nvaie-with-ocp.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix mirror-gpu-ocp-disconnected.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* fix more indentation syntax issues

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes + pre-requisites -> prerequisites

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more changes to match style guide

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* more indentation fixes

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

* revert gpu-operator-kubevirt.rst

Signed-off-by: Andrew Chen <andrewch@nvidia.com>

---------

Signed-off-by: Andrew Chen <andrewch@nvidia.com>
Signed-off-by: chenopis <andrewch@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants