redhat-documentation / newdoc

The newdoc tool generates files formatted with AsciiDoc, which are used in Red Hat documentation.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Verify existing modules against the templates

msuchane opened this issue · comments

Reported by Tomáš Čapek:

Add an auditing option to cross-check templates with actual doc files and report errors.

First, let's scope if this is feasible at all and how much work it would require.

Tomáš Čapek has provided a table of issues in our current modules. The table is accessible only to Red Hat employees.

Next steps:

  1. Identify the issues that are common and easy to process.
  2. Add an option in newdoc, or a related tool, to search for these issues.

In my recent survey, 68% responses voted for this feature. I'm planning it for after the next milestone.

The validation functionality is now very relevant to the Pv2 migration. I'm switching this issue to an earlier milestone.

The validation feature works, covers the checklist, and has been released.

There are some bugs and possible enhancements, but let's close this ticket and handle the rest elsewhere.