Exclude assemblies from lint-DITA#4893
Conversation
|
The PR preview for e6b8a75 is available at theforeman-foreman-documentation-preview-pr-4893.surge.sh No diff compared to the current base |
|
Perhaps we should also update skills that create assemblies so that they don't add the content type attribute? |
maximiliankolb
left a comment
There was a problem hiding this comment.
Thanks Anet, LGTM.
I checked .github/workflows/vale.yml and reproduced the remaining changes locally via fd -t f "assembly_" | xargs sed --in-place "/:_mod-docs-content-type: ASSEMBLY/,+1d".
2795849 to
e6b8a75
Compare
|
Rebased to pull in the changes merged with #4887 and resolve the conflict (the other PR deletes an assembly). |
|
Considering that the ASSEMBLY content type is not needed downstream, and it's not relevant for upstream either, I've decided not to cherry-pick. The only consequence should be that PRs on branches 3.16-3.19 will keep reporting Vale errors for assemblies but I don't think it's a big deal because we've been quite okay with ignoring the same errors up until now :) |
What changes are you introducing?
Modifying the DITA part of the Vale check to run only on modules and not on assemblies.
Why are you introducing these changes? (Explanation, links to references, issues, etc.)
While each assembly and module must include a content type definition to be evaluated by asciidoctor-dita-vale (https://github.com/jhradilek/asciidoctor-dita-vale/blob/af6c00940de1ce99994ddd1631aa18d35a7ff0a3/README.md?plain=1#L130), assemblies in Foreman docs can be ignored because they serve as simple containers of includes. For the purposes of Red Hat's migration to DITA downstream, checking the modules in
guides/common/modulesis enough.Anything else to add? (Considerations, potential downsides, alternative solutions you have explored, etc.)
Third time's the charm, after #4865 and #4879 These two PRs explored how to use the IGNORE content type to exclude assemblies from the Vale checks. However, if Vale is not supposed to check assemblies, we can also just drop it from the GH workflow entirely.
Contributor checklists
Please cherry-pick my commits into: