Skip to content

Wrap non-words in code tags

Amy Qualls requested to merge docs-aqualls-fix-kramdown-issues into master

What does this MR do?

Fixes these Kramdown warnings as part of the technical writing monthly chore list

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/omnibus/settings/database.md name=default>
  No link definition for link ID ''db_keepalives'' found on line 1
  No link definition for link ID ''db_keepalives_idle'' found on line 1
  No link definition for link ID ''db_keepalives_interval'' found on line 1
  No link definition for link ID ''db_keepalives_count'' found on line 1
  No link definition for link ID ''db_tcp_user_timeout'' found on line 1

Related issues

Related to technical-writing#307 (closed)

Author's checklist (required)

Do not add the ~"feature", frontend, backend, ~"bug", or database labels if you are only updating documentation. These labels will cause the MR to be added to code verification QA issues.

When applicable:

Review checklist

All reviewers can help ensure accuracy, clarity, completeness, and adherence to the Documentation Guidelines and Style Guide.

1. Primary Reviewer

  • Review by a code reviewer or other selected colleague to confirm accuracy, clarity, and completeness. This can be skipped for minor fixes without substantive content changes.

2. Technical Writer

  • Technical writer review. If not requested for this MR, must be scheduled post-merge. To request for this MR, assign the writer listed for the applicable DevOps stage.

3. Maintainer

  1. Review by assigned maintainer, who can always request/require the above reviews. Maintainer's review can occur before or after a technical writer review.
  2. Ensure a release milestone is set.
  3. If there has not been a technical writer review, create an issue for one using the Doc Review template.

Merge request reports