Update patch set 8

Patch Set 8: Code-Review-1

(2 comments)

> Patch Set 7:
> 
> (4 comments)
> 
> > Patch Set 7: Code-Review-1
> > 
> > (4 comments)
> > 
> > About the data collection part, I think it's worth adding examples of what they have to do or what they will have to see as results. Without example(s), procedures or commands, it could be confusing.
> 
> This is an advanced topic, we have to assume that the users know how to run validations and that they have read at least the downstream docs.
> The very fact that they reached this page, means that they have run `command`, it failed, and they have determined that the error isn't on their side.
> 
> The more information they give us to help solve the issue, the better. If we railroad them to much they might omit things that could be useful.

Jiri, we could never assume that the reader knows all about the VF, advanced topic or not! 

Some example(s) we can add that you already know:

- For packages information:

    $ rpm -qa | grep validations | xargs rpm -qi

- For the validations log directory, first we only talk about the /var/log/validations but as you know better than me 😄, the user could store them elsewhere. However for the /var/log/validations directory, we could at least show them what we expect here in terms of permissions/ownership.

    $ ls -ld /var/log/validations
    drwxrws---. 3 root *USER* 4096 Jul 30 21:05 /var/log/validations

Better being explicit as much as possible with what we expect to debug and fix their issues and avoiding back and forth.

Just my 2cents.

Patch-set: 8
Reviewer: Gerrit User 11491 <11491@4a232e18-c5a9-48ee-94c0-e04e7cca6543>
Label: Code-Review=-1
This commit is contained in:
Gerrit User 11491 2021-08-05 09:51:19 +00:00 committed by Gerrit Code Review
parent 5e194833a8
commit 8ed1e57796
1 changed files with 36 additions and 0 deletions

View File

@ -105,6 +105,24 @@
"serverId": "4a232e18-c5a9-48ee-94c0-e04e7cca6543",
"unresolved": true
},
{
"key": {
"uuid": "1fbefda0_26a7803c",
"filename": "doc/source/debugging.rst",
"patchSetId": 7
},
"lineNbr": 43,
"author": {
"id": 11491
},
"writtenOn": "2021-08-05T09:51:19Z",
"side": 1,
"message": "Yes you are right! 👍",
"parentUuid": "ec607fb9_73a8ce9a",
"revId": "0999476e6d3caf0290a2ebf0e100502ed6cc1d9f",
"serverId": "4a232e18-c5a9-48ee-94c0-e04e7cca6543",
"unresolved": true
},
{
"key": {
"uuid": "4f02c3b4_26811abd",
@ -139,6 +157,24 @@
"revId": "0999476e6d3caf0290a2ebf0e100502ed6cc1d9f",
"serverId": "4a232e18-c5a9-48ee-94c0-e04e7cca6543",
"unresolved": true
},
{
"key": {
"uuid": "905fec0f_9cc2411e",
"filename": "doc/source/debugging.rst",
"patchSetId": 7
},
"lineNbr": 46,
"author": {
"id": 11491
},
"writtenOn": "2021-08-05T09:51:19Z",
"side": 1,
"message": "Ack",
"parentUuid": "47e588b7_64491a6b",
"revId": "0999476e6d3caf0290a2ebf0e100502ed6cc1d9f",
"serverId": "4a232e18-c5a9-48ee-94c0-e04e7cca6543",
"unresolved": false
}
]
}