Skip to content
This repository was archived by the owner on Nov 24, 2025. It is now read-only.

Fix problems with the docs for the remap.config ConfigFile Parameters#6079

Merged
zrhoffman merged 2 commits intoapache:masterfrom
ocket8888:docs/remap.config-param-fix
Aug 3, 2021
Merged

Fix problems with the docs for the remap.config ConfigFile Parameters#6079
zrhoffman merged 2 commits intoapache:masterfrom
ocket8888:docs/remap.config-param-fix

Conversation

@ocket8888
Copy link
Copy Markdown
Contributor

@ocket8888 ocket8888 commented Aug 3, 2021

What does this PR (Pull Request) do?

  • This PR is not related to any Issue

This includes problems that inhibit rendering as well as consistency and semantic issues, including:

  • sample inputs incorrectly labled as files
  • broken term linking
  • missing term linking
  • multiple intended table rows rendering as a single row
  • reword some things for clarity
  • an intended list of plugin pparams that was actually written as a list of terms and definitions
  • using spaces instead of indentation
  • incorrect admonition class
  • expanding unmarked abbreviations
  • extraneous spacing at the beginning of sentences
  • URLs as citations instead of links
  • list in a blockquote when it isn't quoting anything

... and it shortens an underline in the Delivery Services overview, which is technically unrelated, I just saw it when I was looking for a label.

The build output no warnings, but a look at the rendered output shows that the author's intent was not properly translated into the markup.

Which Traffic Control components are affected by this PR?

  • Documentation

What is the best way to verify this PR?

Make sure there are no docs build errors or warnings, and verify that the output is properly rendered into HTML, visually, structurally, and semantically.

The following criteria are ALL met by this PR

  • Tests are unnecessary
  • This PR includes documentation
  • An update to CHANGELOG.md is not necessary
  • This PR includes any and all required license headers
  • This PR DOES NOT FIX A SERIOUS SECURITY VULNERABILITY

This includes problems that inhibit rendering as well as consistency and
semantic issues.
@ocket8888 ocket8888 added bug something isn't working as intended documentation related to documentation labels Aug 3, 2021
@zrhoffman zrhoffman merged commit 87afcac into apache:master Aug 3, 2021
@ocket8888 ocket8888 deleted the docs/remap.config-param-fix branch August 3, 2021 19:29
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

bug something isn't working as intended documentation related to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants