Uploaded image for project: 'Quarkus Documentation'
  1. Quarkus Documentation
  2. QDOCS-218

Make bulk edits to security*.adoc files.

XMLWordPrintable

    • Quarkus Upstream Docs Sprint 5

      Although the original plan was for me to "start with the first 8 files alphabetically (along with any includes). We'll rebalance the workload daily as we make progress."

      In agreement with shjones@redhat.com, I made bulk edits across all 16 files. The purpose of this approach was to fix some (not all) common style issues, fix vale errors and warnings, and standardize the language around xrefs and links (e.g., "For more information, see the .. guide"); and pushed all these changes to a commit called "edits" in https://gitlab.cee.redhat.com/quarkus-documentation/quarkus/-/merge_requests/947/commits

      Sheila is working from this initial set of changes.

      Then, starting on Friday and continuing this week, I am working through each of the first 8 files, making extra refinements to each file individually and creating an MR for peer review and QE review of each one.

      As I encounter issues in these individual files, I fix some of them across the full set of docs. All these changes show up in a commit called "post-cutoff". I don't expect you, Sheila, to pick up these changes. They're there for informational purposes, in case you're interested.

      The size of these files is very uneven. When either of us completes the initial set of 8 files, we will coordinate with the other to complete the remaining files.

              rdlugyhe Rolfe Dlugy-Hegwer
              rdlugyhe Rolfe Dlugy-Hegwer
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Created:
                Updated:
                Resolved: