URL of the document
90+ files, including:
- Compute profile procedures
- Repository creation
- WebUI form-filling procedures
Examples:
guides/common/modules/proc_importing-ostree-content-by-using-web-ui.adoc
guides/common/modules/proc_adding-custom-rpm-repositories-by-using-web-ui.adoc
Describe the issue
Overly long procedures are difficult to follow, and are (correctly) reported by ReviewDog.
Anything else to add? (context, suggestions for a fix, etc.)
We can improve UX by reducing the number of steps, adding more structure (second- and third-level lists), or creating separate common procedures.
We might also re-evaluate whether we need such detailed procedures for all webUI forms. They should be intuitive enough to fill in without also looking at the docs in parallel.
URL of the document
90+ files, including:
Examples:
guides/common/modules/proc_importing-ostree-content-by-using-web-ui.adoc
guides/common/modules/proc_adding-custom-rpm-repositories-by-using-web-ui.adoc
Describe the issue
Overly long procedures are difficult to follow, and are (correctly) reported by ReviewDog.
Anything else to add? (context, suggestions for a fix, etc.)
We can improve UX by reducing the number of steps, adding more structure (second- and third-level lists), or creating separate common procedures.
We might also re-evaluate whether we need such detailed procedures for all webUI forms. They should be intuitive enough to fill in without also looking at the docs in parallel.