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.

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

feature(sct_config): generate markdown as list #9558

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

fruch
Copy link
Contributor

@fruch fruch commented Dec 16, 2024

the table generated into docs/configuration_options.md was not very readable and more, and need to be vertical scrolling, that make it hard to work with.

this change is replacing the table with a header list of each configuration and make it a bit more readable and automaticlly linkable with no further tricks.

Testing

  • [ ]

PR pre-checks (self review)

  • I added the relevant backport labels
  • I didn't leave commented-out/debugging code

Reminders

  • Add New configuration option and document them (in sdcm/sct_config.py)
  • Add unit tests to cover my changes (under unit-test/ folder)
  • Update the Readme/doc folder relevant to this change (if needed)

the table generated into `docs/configuration_options.md` was not very
readable and more, and need to be vertical scrolling, that make it
hard to work with.

this change is replacing the table with a header list of each configuration
and make it a bit more readable and automaticlly linkable with no further tricks.
@fruch
Copy link
Contributor Author

fruch commented Dec 16, 2024

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.

3 participants