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

[Backport perf-v16] feature(sct_config): generate markdown as list #9577

Merged
merged 1 commit into from
Dec 18, 2024

Conversation

mergify[bot]
Copy link

@mergify mergify bot commented Dec 17, 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)

(cherry picked from commit bb016d1)

Parent PR: #9558

@mergify mergify bot added the conflicts label Dec 17, 2024
Copy link
Author

mergify bot commented Dec 17, 2024

Cherry-pick of bb016d1 has failed:

On branch mergify/bp/branch-perf-v16/pr-9558
Your branch is up to date with 'origin/branch-perf-v16'.

You are currently cherry-picking commit bb016d1a.
  (fix conflicts and run "git cherry-pick --continue")
  (use "git cherry-pick --skip" to skip this patch)
  (use "git cherry-pick --abort" to cancel the cherry-pick operation)

Changes to be committed:
	modified:   sdcm/sct_config.py

Unmerged paths:
  (use "git add <file>..." to mark resolution)
	both modified:   docs/configuration_options.md

To fix up this pull request, you can check it out locally. See documentation: https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally

@mergify mergify bot assigned fruch Dec 17, 2024
@mergify mergify bot marked this pull request as draft December 17, 2024 19:07
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.

(cherry picked from commit bb016d1)
@fruch fruch force-pushed the mergify/bp/branch-perf-v16/pr-9558 branch from e992f18 to 7e4376b Compare December 17, 2024 22:06
@fruch fruch marked this pull request as ready for review December 17, 2024 22:06
@fruch fruch removed the conflicts label Dec 17, 2024
@fruch fruch merged commit a234e04 into branch-perf-v16 Dec 18, 2024
6 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant