Bugzilla – Bug 1213522
[doc] Issue in "Configuring an sg_persist resource" - do not use sdX as these are not stable
Last modified: 2023-08-11 07:08:11 UTC
Configuring an sg_persist resource: https://documentation.suse.com/de-de/sle-ha/15-SP4/html/SLE-HA-all/cha-ha-storage-protect.html#sec-ha-storage-protect-sgpersist Please, never ever use sdX in documentation. See https://www.suse.com/support/kb/doc/?id=000018449 . Please use grep and change it wherever you can, so our customers do not copy this bad style. Thank you.
Thank you Jiri, I will do so.
Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 I've made changes where it seemed appropriate, with whatever fit best for that particular section (this meant it was not always the same style for every section). Let me know if you're happy with these changes.
(In reply to Tahlia Richardson from comment #2) > Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 > > I've made changes where it seemed appropriate, with whatever fit best for > that particular section (this meant it was not always the same style for > every section). > > Let me know if you're happy with these changes. Hi, as for cacf79916511a82fe6ce2368cec3af5050fd9a6f - the reader will see "/dev/<replaceable>DEVICE_ID</replaceable>" literally?
(In reply to Jiri Belka from comment #3) > (In reply to Tahlia Richardson from comment #2) > > Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 > > > > I've made changes where it seemed appropriate, with whatever fit best for > > that particular section (this meant it was not always the same style for > > every section). > > > > Let me know if you're happy with these changes. > > Hi, as for cacf79916511a82fe6ce2368cec3af5050fd9a6f - the reader will see > "/dev/<replaceable>DEVICE_ID</replaceable>" literally? No, the replaceable tags render the text in italics, even in screen output, so the reader will see "/dev/DEVICE_ID".
(In reply to Tahlia Richardson from comment #4) > (In reply to Jiri Belka from comment #3) > > (In reply to Tahlia Richardson from comment #2) > > > Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 > > > > > > I've made changes where it seemed appropriate, with whatever fit best for > > > that particular section (this meant it was not always the same style for > > > every section). > > > > > > Let me know if you're happy with these changes. > > > > Hi, as for cacf79916511a82fe6ce2368cec3af5050fd9a6f - the reader will see > > "/dev/<replaceable>DEVICE_ID</replaceable>" literally? > > No, the replaceable tags render the text in italics, even in screen output, > so the reader will see "/dev/DEVICE_ID". IMO, this introduces another confusion - it should be /dev/disk/by-id/<device>. My 2 cents.
(In reply to Jiri Belka from comment #5) > (In reply to Tahlia Richardson from comment #4) > > (In reply to Jiri Belka from comment #3) > > > (In reply to Tahlia Richardson from comment #2) > > > > Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 > > > > > > > > I've made changes where it seemed appropriate, with whatever fit best for > > > > that particular section (this meant it was not always the same style for > > > > every section). > > > > > > > > Let me know if you're happy with these changes. > > > > > > Hi, as for cacf79916511a82fe6ce2368cec3af5050fd9a6f - the reader will see > > > "/dev/<replaceable>DEVICE_ID</replaceable>" literally? > > > > No, the replaceable tags render the text in italics, even in screen output, > > so the reader will see "/dev/DEVICE_ID". > > IMO, this introduces another confusion - it should be > /dev/disk/by-id/<device>. > > My 2 cents. There are other options like by-uuid and by-partlabel so I was trying not to be prescriptive here, but maybe being prescriptive is better in this case. In your experience, is by-id used more than the others? Or if we use by-id, will it be easy logic for the reader to decide to use e.g. by-partlabel instead (I would think so, but we know how some people love to copy without thinking).
(In reply to Tahlia Richardson from comment #6) > (In reply to Jiri Belka from comment #5) > > (In reply to Tahlia Richardson from comment #4) > > > (In reply to Jiri Belka from comment #3) > > > > (In reply to Tahlia Richardson from comment #2) > > > > > Here's the PR: https://github.com/SUSE/doc-sleha/pull/341 > > > > > > > > > > I've made changes where it seemed appropriate, with whatever fit best for > > > > > that particular section (this meant it was not always the same style for > > > > > every section). > > > > > > > > > > Let me know if you're happy with these changes. > > > > > > > > Hi, as for cacf79916511a82fe6ce2368cec3af5050fd9a6f - the reader will see > > > > "/dev/<replaceable>DEVICE_ID</replaceable>" literally? > > > > > > No, the replaceable tags render the text in italics, even in screen output, > > > so the reader will see "/dev/DEVICE_ID". > > > > IMO, this introduces another confusion - it should be > > /dev/disk/by-id/<device>. > > > > My 2 cents. > > There are other options like by-uuid and by-partlabel so I was trying not to > be prescriptive here, but maybe being prescriptive is better in this case. > > In your experience, is by-id used more than the others? Or if we use by-id, > will it be easy logic for the reader to decide to use e.g. by-partlabel > instead (I would think so, but we know how some people love to copy without > thinking). Better? https://github.com/SUSE/doc-sleha/pull/341
(In reply to Tahlia Richardson from comment #7) > Better? https://github.com/SUSE/doc-sleha/pull/341 ok for me
This is now completed and backported, and will be published with the next weekly docs update.