Skip to content

docs: fixing the ReportFormat description in markdown files #2350

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

ctschacher
Copy link

Explanation

This pull request includes changes to documentation files to correct the format of the pipe character in the descriptions of the ReportFormat field that led to the problem that only one option for the ReportFormat was displayed (JSON).

Example

Before:
Screenshot 2025-04-15 at 20 39 24

After change:
Screenshot 2025-04-15 at 20 40 04

Related issue

(no related issue found)

Proposed Changes

(see explanation above)

Checklist

  • I have read the contributing guidelines.
  • I have read the PR documentation guide and followed the process including adding proof manifests to this PR.
  • This is a bug fix and I have added unit tests that prove my fix is effective.

@ctschacher ctschacher requested a review from a team as a code owner April 15, 2025 20:28
@ctschacher ctschacher force-pushed the docs/fixing-reportformat-markdown-issue branch from c9f39a6 to aba5aa9 Compare April 15, 2025 20:53
@kokes
Copy link
Contributor

kokes commented May 5, 2025

Note that you're only amending the autogenerated markdown files, not their source, so in the end it will get undone once the codegen is executed:

$ make codegen-api-docs
(...)
$ git diff
diff --git a/website/docs/reference/apis/chainsaw.v1alpha1.md b/website/docs/reference/apis/chainsaw.v1alpha1.md
index 2811a0ab..61b964ff 100644
--- a/website/docs/reference/apis/chainsaw.v1alpha1.md
+++ b/website/docs/reference/apis/chainsaw.v1alpha1.md
@@ -428,7 +428,7 @@ during the testing process.</p>
 | `failFast` | `bool` |  |  | <p>FailFast determines whether the test should stop upon encountering the first failure.</p> |
 | `parallel` | `int` |  |  | <p>The maximum number of tests to run at once.</p> |
 | `deletionPropagationPolicy` | [`meta/v1.DeletionPropagation`](https://kubernetes.io/docs/reference/generated/kubernetes-api/v1.28/#deletionpropagation-v1-meta) |  |  | <p>DeletionPropagationPolicy decides if a deletion will propagate to the dependents of the object, and how the garbage collector will handle the propagation.</p> |
-| `reportFormat` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha1-ReportFormatType) |  |  | <p>ReportFormat determines test report format (JSON\|XML\|JUNIT-TEST\|JUNIT-STEP\|JUNIT-OPERATION\|nil) nil == no report. maps to report.Type, however we don't want generated.deepcopy to have reference to it.</p> |
+| `reportFormat` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha1-ReportFormatType) |  |  | <p>ReportFormat determines test report format (JSON|XML|JUNIT-TEST|JUNIT-STEP|JUNIT-OPERATION|nil) nil == no report. maps to report.Type, however we don't want generated.deepcopy to have reference to it.</p> |
 | `reportPath` | `string` |  |  | <p>ReportPath defines the path.</p> |
 | `reportName` | `string` |  |  | <p>ReportName defines the name of report to create. It defaults to "chainsaw-report".</p> |
 | `namespace` | `string` |  |  | <p>Namespace defines the namespace to use for tests. If not specified, every test will execute in a random ephemeral namespace unless the namespace is overridden in a the test spec.</p> |
diff --git a/website/docs/reference/apis/chainsaw.v1alpha2.md b/website/docs/reference/apis/chainsaw.v1alpha2.md
index 1b1d4c80..9156da41 100644
--- a/website/docs/reference/apis/chainsaw.v1alpha2.md
+++ b/website/docs/reference/apis/chainsaw.v1alpha2.md
@@ -152,7 +152,7 @@ auto_generated: true

 | Field | Type | Required | Inline | Description |
 |---|---|---|---|---|
-| `format` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha2-ReportFormatType) |  |  | <p>ReportFormat determines test report format (JSON\|XML\|JUNIT-TEST\|JUNIT-STEP\|JUNIT-OPERATION).</p> |
+| `format` | [`ReportFormatType`](#chainsaw-kyverno-io-v1alpha2-ReportFormatType) |  |  | <p>ReportFormat determines test report format (JSON|XML|JUNIT-TEST|JUNIT-STEP|JUNIT-OPERATION).</p> |
 | `path` | `string` |  |  | <p>ReportPath defines the path.</p> |
 | `name` | `string` |  |  | <p>ReportName defines the name of report to create. It defaults to "chainsaw-report".</p> |

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.

2 participants