Skip to content

Remove HTML markup from table

Amy Qualls requested to merge docs-aqualls-repair-table into master

What does this MR do?

When building locally, I saw the following Kramdown warning:

kramdown warning(s) for <Nanoc::Core::CompilationItemRepView item.identifier=/ee/development/documentation/styleguide/index.md name=default>
  Found block HTML tag 'div' in span-level text on line 548
  Found invalidly used HTML closing tag for 'div' on line 548
      update  [2.25s]  public/ee/development/documentation/styleguide/index.html
      update  [0.83s]

Kramdown doesn't like having the <div> code inside a table, because divs are block-level elements and that information was placed inside an inline <span> element. We MIGHT be able to fix this by declaring the div before the start of the table. @axil would know if this approach would make /help any happier. I'm guessing not, but it's worth asking...

Related issues

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.

For more information about labels, see Technical Writing workflows - Labels.

For suggestions that you are confident don't need to be reviewed, change them locally and push a commit directly to save others from unneeded reviews. For example:

  • Clear typos, like this is a typpo.
  • Minor issues, like single quotes instead of double quotes, Oxford commas, and periods.

For more information, see our documentation on Merging a merge request.

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

Loading