Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update docs #9447

Merged
merged 4 commits into from
Aug 14, 2024
Merged

Update docs #9447

merged 4 commits into from
Aug 14, 2024

Conversation

joshcooper
Copy link
Contributor

More updates to documentation so it renders correctly.

  • An important note was missing from the filebucket page
  • external_nodes setting was missing a sentence

@joshcooper
Use valid ronn syntax in filebucket help
ecb2092 
Previously, running `rake manpages` resulted in:

     roff: ./man/man8/puppet-filebucket.8
     warn: unrecognized block tag: "blockquote"

This is because '>' is not valid ronn syntax. As a result the "Note" was
excluded from the generated `man/man8/puppet-filebucket.8`

Also add a new line to separate using a local filebucket.
@joshcooper
Fix typo
9498f3f
@joshcooper
Remove unhelpful warning
d20cc43
@joshcooper
Render man/man5/puppetconf.5 correctly
ef22dc8 
Previously, `rake genmanpages` generated warnings when converting ronn to man:

    roff: ./man/man5/puppetconf.5
    warn: unrecognized block tag: "hr"
    warn: unexpected text: "Return a YAML hash with up to three keys:"

The first warning was because definition lists need to have a space between each
item. As a result the entire line "Return a YAML hash with up to three keys" was
omitted from the output.

The second warning was because '* * *' is not valid in ronn.
mtaggart13
mtaggart13 approved these changes Aug 13, 2024
View reviewed changes
Copy link

@mtaggart13 mtaggart13 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure who gives explicit approval at this stage, but these changes look good to me.

@joshcooper joshcooper marked this pull request as ready for review August 13, 2024 23:58
@joshcooper joshcooper requested a review from a team as a code owner August 13, 2024 23:58
@joshcooper joshcooper merged commit b8ac6f4 into puppetlabs:main Aug 14, 2024
9 checks passed
@joshcooper joshcooper deleted the doc_updates2 branch August 14, 2024 00:11
@joshcooper joshcooper added the maintenance Maintenance chores are excluded from changelogs label Aug 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mtaggart13 mtaggart13 mtaggart13 approved these changes

Assignees
No one assigned
Labels
maintenance Maintenance chores are excluded from changelogs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@joshcooper @mtaggart13