Merge pull request #2103 from zregvart/issue/EC-940

enterprise-contract · Oct 28, 2024 · 3b909e0 · 3b909e0
2 parents c65f0b5 + e874aa7
commit 3b909e0
Show file tree

Hide file tree

Showing 34 changed files with 87 additions and 30 deletions.
diff --git a/docs/modules/ROOT/pages/ec.adoc b/docs/modules/ROOT/pages/ec.adoc
@@ -1,6 +1,8 @@
 = ec
 
-Enterprise Contract CLI== Synopsis
+Enterprise Contract CLI
+
+== Synopsis
 
 Enterprise Contract CLI
 

diff --git a/docs/modules/ROOT/pages/ec_fetch.adoc b/docs/modules/ROOT/pages/ec_fetch.adoc
@@ -1,6 +1,7 @@
 = ec fetch
 
 Fetch remote resources
+
 == Options
 
 -h, --help:: help for fetch (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_fetch_policy.adoc b/docs/modules/ROOT/pages/ec_fetch_policy.adoc
@@ -1,6 +1,8 @@
 = ec fetch policy
 
-Fetch policy rules from a git repository or other source== Synopsis
+Fetch policy rules from a git repository or other source
+
+== Synopsis
 
 Fetch policy rules (rego files) from a git repository or other source.
 

diff --git a/docs/modules/ROOT/pages/ec_init.adoc b/docs/modules/ROOT/pages/ec_init.adoc
@@ -1,6 +1,7 @@
 = ec init
 
 Initialize a directory for use
+
 == Options
 
 -h, --help:: help for init (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_init_policies.adoc b/docs/modules/ROOT/pages/ec_init_policies.adoc
@@ -1,6 +1,8 @@
 = ec init policies
 
-Initialize a directory with minimal EC scaffolding== Synopsis
+Initialize a directory with minimal EC scaffolding
+
+== Synopsis
 
 This command creates the necessary files for a minimal EC policy setup in the
 specified destination directory.

diff --git a/docs/modules/ROOT/pages/ec_inspect.adoc b/docs/modules/ROOT/pages/ec_inspect.adoc
@@ -1,6 +1,7 @@
 = ec inspect
 
 Inspect policy rules
+
 == Options
 
 -h, --help:: help for inspect (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_inspect_policy-data.adoc b/docs/modules/ROOT/pages/ec_inspect_policy-data.adoc
@@ -1,6 +1,8 @@
 = ec inspect policy-data
 
-Read policy data from source urls and displays the data== Synopsis
+Read policy data from source urls and displays the data
+
+== Synopsis
 
 Read policy data from source urls and displays the data.
 

diff --git a/docs/modules/ROOT/pages/ec_inspect_policy.adoc b/docs/modules/ROOT/pages/ec_inspect_policy.adoc
@@ -1,6 +1,8 @@
 = ec inspect policy
 
-Read policies from source urls and show information about the rules inside them== Synopsis
+Read policies from source urls and show information about the rules inside them
+
+== Synopsis
 
 Read policies from a source url and show information about the rules inside them.
 

diff --git a/docs/modules/ROOT/pages/ec_opa.adoc b/docs/modules/ROOT/pages/ec_opa.adoc
@@ -1,6 +1,8 @@
 = ec opa
 
-Open Policy Agent (OPA) (embedded)== Synopsis
+Open Policy Agent (OPA) (embedded)
+
+== Synopsis
 
 An open source project to policy-enable your service.
 [source,shell]

diff --git a/docs/modules/ROOT/pages/ec_opa_bench.adoc b/docs/modules/ROOT/pages/ec_opa_bench.adoc
@@ -1,6 +1,8 @@
 = ec opa bench
 
-Benchmark a Rego query== Synopsis
+Benchmark a Rego query
+
+== Synopsis
 
 Benchmark a Rego query and print the results.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_build.adoc b/docs/modules/ROOT/pages/ec_opa_build.adoc
@@ -1,6 +1,8 @@
 = ec opa build
 
-Build an OPA bundle== Synopsis
+Build an OPA bundle
+
+== Synopsis
 
 Build an OPA bundle.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_capabilities.adoc b/docs/modules/ROOT/pages/ec_opa_capabilities.adoc
@@ -1,6 +1,8 @@
 = ec opa capabilities
 
-Print the capabilities of OPA== Synopsis
+Print the capabilities of OPA
+
+== Synopsis
 
 Show capabilities for OPA.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_check.adoc b/docs/modules/ROOT/pages/ec_opa_check.adoc
@@ -1,6 +1,8 @@
 = ec opa check
 
-Check Rego source files== Synopsis
+Check Rego source files
+
+== Synopsis
 
 Check Rego source files for parse and compilation errors.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_deps.adoc b/docs/modules/ROOT/pages/ec_opa_deps.adoc
@@ -1,6 +1,8 @@
 = ec opa deps
 
-Analyze Rego query dependencies== Synopsis
+Analyze Rego query dependencies
+
+== Synopsis
 
 Print dependencies of provided query.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_eval.adoc b/docs/modules/ROOT/pages/ec_opa_eval.adoc
@@ -1,6 +1,8 @@
 = ec opa eval
 
-Evaluate a Rego query== Synopsis
+Evaluate a Rego query
+
+== Synopsis
 
 Evaluate a Rego query and print the result.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_exec.adoc b/docs/modules/ROOT/pages/ec_opa_exec.adoc
@@ -1,6 +1,8 @@
 = ec opa exec
 
-Execute against input files== Synopsis
+Execute against input files
+
+== Synopsis
 
 Execute against input files.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_fmt.adoc b/docs/modules/ROOT/pages/ec_opa_fmt.adoc
@@ -1,6 +1,8 @@
 = ec opa fmt
 
-Format Rego source files== Synopsis
+Format Rego source files
+
+== Synopsis
 
 Format Rego source files.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_inspect.adoc b/docs/modules/ROOT/pages/ec_opa_inspect.adoc
@@ -1,6 +1,8 @@
 = ec opa inspect
 
-Inspect OPA bundle(s) or Rego files.== Synopsis
+Inspect OPA bundle(s) or Rego files.
+
+== Synopsis
 
 Inspect OPA bundle(s) or Rego files.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_parse.adoc b/docs/modules/ROOT/pages/ec_opa_parse.adoc
@@ -1,6 +1,8 @@
 = ec opa parse
 
-Parse Rego source file== Synopsis
+Parse Rego source file
+
+== Synopsis
 
 Parse Rego source file and print AST.
 [source,shell]

diff --git a/docs/modules/ROOT/pages/ec_opa_run.adoc b/docs/modules/ROOT/pages/ec_opa_run.adoc
@@ -1,6 +1,8 @@
 = ec opa run
 
-Start OPA in interactive or server mode== Synopsis
+Start OPA in interactive or server mode
+
+== Synopsis
 
 Start an instance of the Open Policy Agent (OPA).
 

diff --git a/docs/modules/ROOT/pages/ec_opa_sign.adoc b/docs/modules/ROOT/pages/ec_opa_sign.adoc
@@ -1,6 +1,8 @@
 = ec opa sign
 
-Generate an OPA bundle signature== Synopsis
+Generate an OPA bundle signature
+
+== Synopsis
 
 Generate an OPA bundle signature.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_test.adoc b/docs/modules/ROOT/pages/ec_opa_test.adoc
@@ -1,6 +1,8 @@
 = ec opa test
 
-Execute Rego test cases== Synopsis
+Execute Rego test cases
+
+== Synopsis
 
 Execute Rego test cases.
 

diff --git a/docs/modules/ROOT/pages/ec_opa_version.adoc b/docs/modules/ROOT/pages/ec_opa_version.adoc
@@ -1,6 +1,8 @@
 = ec opa version
 
-Print the version of OPA== Synopsis
+Print the version of OPA
+
+== Synopsis
 
 Show version and build information for OPA.
 [source,shell]

diff --git a/docs/modules/ROOT/pages/ec_sigstore.adoc b/docs/modules/ROOT/pages/ec_sigstore.adoc
@@ -1,6 +1,7 @@
 = ec sigstore
 
 Perform certain sigstore operations
+
 == Options
 
 -h, --help:: help for sigstore (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_sigstore_initialize.adoc b/docs/modules/ROOT/pages/ec_sigstore_initialize.adoc
@@ -1,6 +1,8 @@
 = ec sigstore initialize
 
-Initializes Sigstore root to retrieve trusted certificate and key targets for verification== Synopsis
+Initializes Sigstore root to retrieve trusted certificate and key targets for verification
+
+== Synopsis
 
 Initializes Sigstore root to retrieve trusted certificate and key targets for verification.
 

diff --git a/docs/modules/ROOT/pages/ec_test.adoc b/docs/modules/ROOT/pages/ec_test.adoc
@@ -1,6 +1,8 @@
 = ec test
 
-Test your configuration files using Open Policy Agent== Synopsis
+Test your configuration files using Open Policy Agent
+
+== Synopsis
 
 
 The 'ec test' command is a thin wrapper for the 'conftest test' command. This

diff --git a/docs/modules/ROOT/pages/ec_track.adoc b/docs/modules/ROOT/pages/ec_track.adoc
@@ -1,6 +1,7 @@
 = ec track
 
 Record resource references for tracking purposes
+
 == Options
 
 -h, --help:: help for track (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_track_bundle.adoc b/docs/modules/ROOT/pages/ec_track_bundle.adoc
@@ -1,6 +1,8 @@
 = ec track bundle
 
-Record tracking information about Tekton bundles== Synopsis
+Record tracking information about Tekton bundles
+
+== Synopsis
 
 Record tracking information about Tekton bundles
 

diff --git a/docs/modules/ROOT/pages/ec_validate.adoc b/docs/modules/ROOT/pages/ec_validate.adoc
@@ -1,6 +1,7 @@
 = ec validate
 
 Validate conformance with the Enterprise Contract
+
 == Options
 
 -h, --help:: help for validate (Default: false)

diff --git a/docs/modules/ROOT/pages/ec_validate_image.adoc b/docs/modules/ROOT/pages/ec_validate_image.adoc
@@ -1,6 +1,8 @@
 = ec validate image
 
-Validate conformance of container images with the Enterprise Contract== Synopsis
+Validate conformance of container images with the Enterprise Contract
+
+== Synopsis
 
 Validate conformance of container images with the Enterprise Contract
 

diff --git a/docs/modules/ROOT/pages/ec_validate_input.adoc b/docs/modules/ROOT/pages/ec_validate_input.adoc
@@ -1,6 +1,8 @@
 = ec validate input
 
-Validate arbitrary JSON or yaml file input conformance with the Enterprise Contract== Synopsis
+Validate arbitrary JSON or yaml file input conformance with the Enterprise Contract
+
+== Synopsis
 
 Validate conformance of arbitrary JSON or yaml file input with the Enterprise Contract
 

diff --git a/docs/modules/ROOT/pages/ec_validate_policy.adoc b/docs/modules/ROOT/pages/ec_validate_policy.adoc
@@ -1,6 +1,8 @@
 = ec validate policy
 
-Validate the provided EnterpriseContractPolicy spec== Synopsis
+Validate the provided EnterpriseContractPolicy spec
+
+== Synopsis
 
 Validate the provided EnterpriseContractPolicy spec against the EnterpriseContractPolicy spec schema used in this version of the ec CLI
 

diff --git a/docs/modules/ROOT/pages/ec_version.adoc b/docs/modules/ROOT/pages/ec_version.adoc
@@ -1,6 +1,7 @@
 = ec version
 
 Print version information
+
 == Options
 
 -h, --help:: help for version (Default: false)

diff --git a/internal/documentation/asciidoc/cli/cli.tmpl b/internal/documentation/asciidoc/cli/cli.tmpl
@@ -1,9 +1,7 @@
 = {{ .CommandPath }}
 
-{{ .Short -}}
-
-{{ if .Long -}}
-
+{{ .Short }}
+{{ if .Long }}
 == Synopsis
 
 {{ .Long }}