search

puppetlabs / puppet-docs

Curated Puppet Documentation
Other
221 stars 303 forks source link

Update automation #1165

Closed joshcooper closed 3 months ago

joshcooper commented 3 months ago

The rake tasks for generating puppet references was broken due to changes in puppet-strings and outdated dependencies. It's now possible to generate the docs for puppet 7 and 8 as follows:

$ rm -rf references_output
$ rbenv shell 3.1.1
$ bundle install
$ bundle exec rake references:puppet VERSION=8.8.0
$ tree references_output 
references_output
└── puppet
    ├── configuration.md
    ├── function.md
    ├── man
    │   ├── agent.md
    │   ├── apply.md
    │   ├── catalog.md
    │   ├── config.md
    │   ├── describe.md
    │   ├── device.md
    │   ├── doc.md
    │   ├── epp.md
    │   ├── facts.md
    │   ├── filebucket.md
    │   ├── generate.md
    │   ├── help.md
    │   ├── lookup.md
    │   ├── module.md
    │   ├── node.md
    │   ├── overview.md
    │   ├── parser.md
    │   ├── plugin.md
    │   ├── report.md
    │   ├── resource.md
    │   ├── script.md
    │   └── ssl.md
    ├── raw_strings_data_output.json
    ├── strings.json
    ├── type.json
    ├── type.md
    ├── types
    │   ├── exec.md
    │   ├── filebucket.md
    │   ├── file.md
    │   ├── group.md
    │   ├── notify.md
    │   ├── overview.md
    │   ├── package.md
    │   ├── resources.md
    │   ├── schedule.md
    │   ├── service.md
    │   ├── stage.md
    │   ├── tidy.md
    │   └── user.md
    ├── types_strings
    │   ├── component.md
    │   ├── exec.md
    │   ├── filebucket.md
    │   ├── file.md
    │   ├── group.md
    │   ├── notify.md
    │   ├── overview.md
    │   ├── package.md
    │   ├── resources.md
    │   ├── schedule.md
    │   ├── service.md
    │   ├── stage.md
    │   ├── tidy.md
    │   ├── user.md
    │   └── whit.md
    ├── type_strings.json
    └── type_strings.md

4 directories, 58 files

And same for puppet 7.32

IngridaCazers commented 3 months ago

I'm not familiar with this process, but I trust that your suggested changes are correct.

Just now, I was updating the ssl.md file, so I hope that there will not be a conflict.