Skip to content

Fixes #39694 - Rake task that generates list of settings - #11205

Open
lzap wants to merge 2 commits into
theforeman:developfrom
lzap:settings-39694
Open

Fixes #39694 - Rake task that generates list of settings#11205
lzap wants to merge 2 commits into
theforeman:developfrom
lzap:settings-39694

Conversation

@lzap

@lzap lzap commented Aug 25, 2026

Copy link
Copy Markdown
Member

Also uploads them as individual pages prefixed with Setting (child of page named Settings) into our wiki. The list is merged with existing settings, so anyone can run the rake task and only new settings will be added:

https://projects.theforeman.org/projects/foreman/wiki/Settings

This gives us stable URLs we can refer to and very easy workflow to add missing settings. Any plugin maintainer can add their own settings easily.

To test this:

bundle exec rake settings:list

Or:

FOREMAN_REDMINE_API_KEY=XXX bundle exec rake settings:wiki

The only limitation is that individual pages are generated, changes will be overwritten. I can add a link to the every page something like SettingNotesXXX which will create a (red) link to non-existing page with additional notes we can optionally fill in for some if we want.

Edit: I also pushed a second commit that updates the existing error page generator, it now directly pushes this to the wiki. I want more automation so we can plugin this to the release process.

https://projects.theforeman.org/projects/foreman/wiki/ErrorCodes

Discussion:

https://community.theforeman.org/t/proposal-remove-app-c-from-administering-foreman-guide/45550

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant