| Posted | Nick | Remark | |
|---|---|---|---|
| #openstack-cyborg - 2026-08-04 | |||
| 14:26:27 | sean-k-mooney | chandankumar: sorry ill try an take a look at those later | |
| 14:26:44 | rlandy | two patches had multiple comments and I'd like to confirm what the final suggestion is ... | |
| 14:26:50 | chandankumar | np, take your time | |
| 14:27:00 | rlandy | for the drivers table, | |
| 14:27:16 | jgilaber | #link https://review.opendev.org/c/openstack/cyborg/+/999116 | |
| 14:27:23 | rlandy | ack - the generic PCI driver is missing | |
| 14:27:44 | rlandy | jgilaber: not sure if you wanted to add that or I should? | |
| 14:28:03 | jgilaber | you can add the pci driver in you patch | |
| 14:28:11 | rlandy | also should this move before completing the review or was that a comment about moving all this work in general? | |
| 14:28:41 | rlandy | lastly, is the team ok with the status choices of CI and Missing? | |
| 14:28:48 | rlandy | is there another status | |
| 14:29:06 | chandankumar | good to add CI status there | |
| 14:29:16 | rlandy | I removed all the references to individual test results - they were out of date | |
| 14:29:23 | jgilaber | I think that CI and missing is accurate for now | |
| 14:29:25 | sean-k-mooney | so we currently have 2 idffent places where we list the driver in a table | |
| 14:29:33 | sean-k-mooney | the suppoort matic sand in the amdin docs | |
| 14:29:55 | sean-k-mooney | everuatly i think we shoudl have only one table in the admin docs not underfernce and hte supprot statement should move | |
| 14:30:01 | sean-k-mooney | but we can do it as 2 commtis | |
| 14:30:08 | sean-k-mooney | so if you want to defer the move that is ok | |
| 14:30:17 | sean-k-mooney | i woudl add the pci drvier now however | |
| 14:30:26 | rlandy | I can do the move in this patch, no problem | |
| 14:30:53 | rlandy | the final place would be the admin docs? | |
| 14:31:09 | sean-k-mooney | i think so | |
| 14:31:11 | rlandy | ok | |
| 14:31:22 | sean-k-mooney | refence is not realy something we expect peole to read on a first reading of the doc | |
| 14:31:22 | rlandy | next ... | |
| 14:31:31 | sean-k-mooney | its more a place we keep technial notes | |
| 14:31:44 | sean-k-mooney | so puting it in the main admin guide will make this much more visable | |
| 14:31:46 | rlandy | https://review.opendev.org/c/openstack/cyborg/+/999278 | |
| 14:31:48 | sean-k-mooney | https://storage.gra.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_805/openstack/8055e6a20e464edcbb23ba49701ca037/docs/reference/support-matrix.html | |
| 14:31:54 | sean-k-mooney | is what it looks liek for now | |
| 14:32:03 | sean-k-mooney | i woudl add a docs colume as well | |
| 14:32:24 | sean-k-mooney | and maybe make status the last of the colums | |
| 14:32:46 | sean-k-mooney | so name, description, testing, docs, status | |
| 14:33:03 | rlandy | ok | |
| 14:33:18 | rlandy | doc will be blank until we have them all? | |
| 14:33:42 | sean-k-mooney | well you can set it to missing for most of the driver and partial for the intel driver | |
| 14:33:47 | sean-k-mooney | *for the pci driver | |
| 14:34:02 | sean-k-mooney | or partial for all | |
| 14:34:03 | rlandy | ok | |
| 14:34:17 | rlandy | partial sounds better | |
| 14:34:20 | sean-k-mooney | we have some basic configuration docs but they are not complete | |
| 14:34:35 | sean-k-mooney | https://storage.gra.cloud.ovh.net/v1/AUTH_dcaab5e32b234d56b626f72581e3644c/zuul_opendev_logs_805/openstack/8055e6a20e464edcbb23ba49701ca037/docs/configuration/drivers.html | |
| 14:34:40 | rlandy | I'll see what I can find to link | |
| 14:35:04 | sean-k-mooney | once we have per driver docs split out into there own page we can update the docs value in the new table | |
| 14:35:06 | rlandy | moving on to https://review.opendev.org/c/openstack/cyborg/+/999278 | |
| 14:35:19 | rlandy | ^^ remove the inling? | |
| 14:35:43 | rlandy | it seems like the reviewers want the separate doc back? | |
| 14:35:55 | sean-k-mooney | ya i think that should its own docuemnt not inline in the index as its a bit log | |
| 14:36:10 | sean-k-mooney | yes i think https://review.opendev.org/c/openstack/cyborg/+/999278/3/doc/source/user/using-cyborg.rst | |
| 14:36:20 | sean-k-mooney | was fine as it was that was not one of the docs i asked to be inlined | |
| 14:36:40 | rlandy | ok - will correct that | |
| 14:36:51 | rlandy | and also there was a note to move that? | |
| 14:36:54 | sean-k-mooney | however i think you can move https://docs.openstack.org/cyborg/latest/admin/#user-requests into that doc as well | |
| 14:37:20 | sean-k-mooney | so its a little bit tricky | |
| 14:37:30 | sean-k-mooney | normally the user docs are for end users | |
| 14:37:42 | rlandy | that doc - being using-cyborg? | |
| 14:37:48 | sean-k-mooney | so some one creatign a vm with cybrog fits into that catagory | |
| 14:37:57 | sean-k-mooney | yes | |
| 14:38:20 | sean-k-mooney | but the admin guide currently has admin/#user-requests | |
| 14:38:23 | rlandy | ok - let me rework those patches | |
| 14:38:25 | rlandy | thank you | |
| 14:38:27 | sean-k-mooney | and that feels like its in teh wron gplace | |
| 14:39:03 | rlandy | ok - any more doc comments? | |
| 14:39:17 | sean-k-mooney | the admin guide is ment to focus on thinks like configureing the service or creating flavors/device profiels for folkd to use it | |
| 14:40:00 | sean-k-mooney | melwitt: you wote some good developer focused docs for the neutron port workflow | |
| 14:40:31 | sean-k-mooney | melwitt: if we were to also docuemnt that more would you put it with the enduser docs | |
| 14:40:39 | sean-k-mooney | admin or both | |
| 14:41:23 | sean-k-mooney | i feel like procedure like htat woudl fit better in the enduser docs right? im just tryign to validate the recomemndation above | |
| 14:41:34 | sean-k-mooney | to have the creating an instance doc in the user docs not the admin docs | |
| 14:41:51 | melwitt | yeah to me admin guide is for admin-only actions or APIs | |
| 14:42:16 | sean-k-mooney | so disabling a deployable woudl go in admin docs | |
| 14:42:19 | melwitt | like setting up a cloud or configuring one | |
| 14:42:36 | sean-k-mooney | like disablign a nova compute service | |
| 14:42:49 | melwitt | yeah exactly | |
| 14:43:18 | sean-k-mooney | rlandy: ok i guess we shoudl keep an eye out for that split as we rework the exsting docs | |
| 14:43:33 | rlandy | there are a lot of moving parts | |
| 14:43:35 | melwitt | if the how-to is about cloud maintenance like disabling a service, that feels like admin guide to me | |
| 14:43:41 | rlandy | so I think we should do this in pieces | |
| 14:43:53 | rlandy | let's get in some basic changes | |
| 14:44:06 | rlandy | then reconsider more reorgs | |
| 14:44:16 | rlandy | unless we have a clear plan now | |
| 14:44:26 | rlandy | which may not be the case as there is a lot in development | |
| 14:44:39 | rlandy | my initial goal was to reorg the sections | |
| 14:45:00 | rlandy | so that engineers writing new docs could have a clean and organized place to work | |
| 14:45:12 | sean-k-mooney | ya so form the patches you have in flight you can restore the using cybrog to create an instance back to the user guide | |
| 14:45:16 | rlandy | but I don't know if we are ready for that | |
| 14:45:34 | sean-k-mooney | well the over all doc stucre is largely already coorrect | |
| 14:45:51 | rlandy | I am happy to work on this more as the development settles | |
| 14:46:01 | sean-k-mooney | there are some placeholder docs to remove and some minore refienment but most docs wont need to move | |
| 14:46:06 | melwitt | the usual split or sections is admin guide, user guide, contributor guide | |
| 14:46:11 | rlandy | ok - I can deal with those | |
| 14:46:30 | sean-k-mooney | yep and install guide which we alwasy forget about | |
| 14:47:33 | melwitt | it's kind of like personas I guess, organize docs per "persona" of someone who is working with cyborg. and then the install and reference sort of sections | |
| 14:47:57 | sean-k-mooney | yep | |
| 14:48:06 | melwitt | and overview/architecture section for learning | |
| 14:49:26 | rlandy | ok - I'll rework what I have and then look at a new structure | |
| 14:49:44 | rlandy | jgilaber: that is all I had - thank you | |
| 14:49:49 | rlandy | we can move on | |
| 14:50:23 | jgilaber | thanks rlandy moving on | |