The following is a summary of changes in each newdoc release, which is also a Git tag by the same name in this repository.
- Update dependencies
- Previously, newdoc didn't recognize configuration files in your Git repository when you entered its sub-directories. This is now fixed, and newdoc can detect configuration files even from sub-directories. See RHELDOCS-17915.
- Fix the
--no-file-prefixes(-P) option. Previously, the option didn't have the expected effect, and instead, it disabled comments.
- An option to generate files without the metadata attributes header. See issue #45.
- Enable configuration files. See the documentation. Issue #20
- Remove the outdated
abstracttag from all templates. Issue #40 - Update various dependencies.
- Enable the
--simplifiedoption to generate files without thecontextattribute. See issue #31. - Update various dependencies.
- Properly follow the
YYYY-MM-DDdate format. Fixes issue #39. - Update various dependencies.
- Add metadata in the generated files that specify which newdoc version generated the document and the date that it was generated.
- Build the RPM using rustup to work around the outdated toolchain on RHEL.
- Rename
_content-typeto_mod-docs-content-type. See issue #37.
- Update modular templates to synchronize with modular-docs/pull/208.
- Remove the legacy, deprecated
--validate(-l) option. Please use Enki instead: https://github.com/Levi-Leah/enki/. - The command-line options parser previously disabled snippets by mistake. Fix and re-enable them.
- Switch the main container to the Alpine base from UBI Micro.
- Update various dependencies.
- The help message and the man page now specify that the validation feature is deprecated. See #36.
- By default, the generated files do not contain any comments. The
--no-comments(-C) option is now deprecated and has no effect. You can use the new--comments(-M) option to generate files with the comments that were previously the default.
- Deprecate the
--validate(-l) option. Please useenkiinstead: https://github.com/Levi-Leah/enki/. - Switch to the
bpafcommand-line argument parser.
- Separate options for the module type prefix in IDs (anchors) and file names.
- A prettier confirmation prompt when overwriting a file.
- Update the modular templates to the latest upstream version.
- Improvements to error handling and reporting.
- Validation: Jupiter now supports attributes in titles.
- Remove the
--detect-directoryoption, which has been the default behavior. - Minor internal changes.
- Sanitize non-ASCII characters in the module ID (#33).
- No longer check for the
experimentalattribute, which isn't required anymore.
- Fix an ID bug reported by Marc Muehlfeld.
- Enable generating the snippet file type.
- Remove the abstract tag from the templates. Jupiter doesn't require it.
- No longer report a missing abstract tag in validation
- The
--validateoption can take multiple values.
- No longer validate that xrefs are path-based; Jupiter does not require them
- Changes to error handling
- Check that each module name is a single string
- Various internal improvements and documentation fixes
- Rename the
:_module-type:attribute to:_content-type:
- Validation: Report when no issues have been found.
- Improve the documentation in the readme.
- Validation: Use a slightly more robust detection of path-based xrefs.
- Validation: Check that supported xrefs are path-based.
- Add a validation (linting) functionality using the
--validateoption.
- Update the modular templates to match upstream changes
- Add the module type attributes; Issue #18
- Remove the blank line after 'Additional resources' in the assembly, which caused issues with Pantheon 2
- Update the modular templates to match upstream changes
- Use a standardized syntax for configuring the templates (askama).
- Remove extra blank lines from the generated files.
- Attempt to fill in the full include path by default. This obsoletes the
--detect-directoryoption. Issue #16 - Use a more standardizedterminal logging solution. You can now set the verbosity level.
- Update the modular templates.
- Update the crates that newdoc depends on.
- Bug fix: With the --no-comments option, remove all multi-line comments, not just the first one
- Change the assembly prerequisites to a numbered heading in accordance with modular-docs #134
- Small internal changes
- The templates have been updated with Patheon 2 metadata
- The generated IDs now start with a module type prefix, matching the new templates
- Add the
--no-examplesoption - Recognize block AsciiDoc comments in the templates
- Add first unit tests
- Optionally detect and fill out the include path
- Refactoring the code into smaller modules
- Deduplicate app metadata
- Updated README
- New packaging options
- Enabled CI
- Make context in assembly IDs optional and conditional
- Align the Optional formatting with the IBM Style Guide; #8
- Use colors instead of emoji for highlighting in the output
No changelog. See the commit messages between the Git tags.
Initial release of newdoc rewritten in the Rust language.