fix: Post-release updates - #478
Conversation
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
194270a to
2394ca8
Compare
Documentation preview |
| Custom GPU Driver Parameters <custom-driver-params.rst> | ||
| precompiled-drivers.rst | ||
| GPU Driver CRD <gpu-driver-configuration.rst> | ||
| NVIDIA Driver CRD <nvidia-driver-configuration.rst> |
There was a problem hiding this comment.
Can we make it NVIDIADriver with no space and page to nvidiadriver-configuration.rst? Folks might use full name nvidiadriver in searches and all and keeping space or - will not give them right results.
There was a problem hiding this comment.
I feel like that would harm readability, esp in a TOC. The "CRD" ought to help.
In general, plain text is the clearest to read. I feel like the OCP folks did a thoughtful review on the topic: https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#api-object-formatting
|
|
||
| Refer to :ref:`GPU Operator with KubeVirt and DRA <gpu-operator-kubevirt-dra>` for prerequisites, limitations, and configuration. | ||
|
|
||
| * Added the following features and enhancements to the NVIDIA driver CRD: |
There was a problem hiding this comment.
It might be better to use "NVIDIADriver" instead of "NVIDIA driver" to be more specific as some might confuse "NVIDIA driver" as regular nvidia driver and might not link it to nvidiadriver directly.
There was a problem hiding this comment.
My preference is to use plain text whenever possible. Like the preceding case, the "CRD" in the sentence should eliminate confusion and preserve readability.
Signed-off-by: Mike McKiernan <mmckiernan@nvidia.com>
2 participants
Updates: