k8s-device-plugin icon indicating copy to clipboard operation
k8s-device-plugin copied to clipboard
verified publisher icon NVIDIA

Add GPU feature discovery docs

Open ArangoGutierrez opened this issue 1 year ago • 5 comments

ArangoGutierrez avatar Feb 29 '24 14:02 ArangoGutierrez

At a quick glance this seems to do alot more than just add GFD docs. It seems to:

  1. Remove the versioning sections of the top level readme
  2. Add a new table of contents to the bottom of the README (separate from the one at the top)
  3. Copy a bunch of the content in the readme out into separate files (and leave the original content in place)

klueska avatar Feb 29 '24 14:02 klueska

At a quick glance this seems to do alot more than just add GFD docs. It seems to:

  1. Remove the versioning sections of the top level readme
  2. Add a new table of contents to the bottom of the README (separate from the one at the top)
  3. Copy a bunch of the content in the readme out into separate files (and leave the original content in place)

I agree, but the GFD documentation was very extensive, and simply appending GFD README into Device Plugin is not desired. that's why I am creating a docs setup.

This is a first pass of this idea, but I am open to suggestions on how to split this effort

ArangoGutierrez avatar Feb 29 '24 16:02 ArangoGutierrez

I'm not necessarily opposed to separating the documentation out into separate files, but that's not what this PR is doing.

It's leaving most of the content in place, removing the section on versioning, and then adding a new table of contents at the bottom of the file that links to the new separated-out docs.

klueska avatar Feb 29 '24 16:02 klueska

This is a first pass of this idea, but I am open to suggestions on how to split this effort

Would splitting out the GFD documentation to separate folder with the links in the top-level documentation be an option?

elezar avatar Feb 29 '24 16:02 elezar

This is a first pass of this idea, but I am open to suggestions on how to split this effort

Would splitting out the GFD documentation to separate folder with the links in the top-level documentation be an option?

Why not, sure. going to edit this PR

ArangoGutierrez avatar Mar 01 '24 09:03 ArangoGutierrez

@elezar @klueska PR has been edited as per conversations, PTAL

ArangoGutierrez avatar Apr 15 '24 10:04 ArangoGutierrez

I have reduced the scope for this PR, changing the name from Adding to Migrating. this way step 1 is to "simply" migrate the documentation, to start then a proper work on enhancing the repo documentation

ArangoGutierrez avatar Apr 15 '24 11:04 ArangoGutierrez

I have edited the github.com/NVIDIA/gpu-feature-discovery README to reflect up-to-date values and instructions. PR is ready for review

ArangoGutierrez avatar Apr 15 '24 11:04 ArangoGutierrez

Rebased

ArangoGutierrez avatar Apr 16 '24 09:04 ArangoGutierrez