Skip to content

Commit

Permalink
docs: replace placeholder url with global attributes
Browse files Browse the repository at this point in the history
  • Loading branch information
mertbugrabicak authored and goldmann committed Feb 20, 2025
1 parent 97c82fe commit bc78159
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 3 deletions.
4 changes: 4 additions & 0 deletions antora-playbook.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ content:
branches: HEAD
start_path: docs
edit_url: false
asciidoc:
attributes:
image-run-script: https://github.com/project-ncl/mequal
local-run-script: https://github.com/project-ncl/mequal
ui:
supplemental_files: ./docs/ui
bundle:
Expand Down
6 changes: 3 additions & 3 deletions docs/modules/getting-started/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ $ cat input/good/sbom-example.json | podman run -i --rm mequal-testing

[TIP]
====
The https://google.com[./container_files/image-run.sh] script can be edited to decide what should be ran inside the container. Can decide to do evaluations using Conforma or using the OPA client embedded within it, running unit tests, change evaluation parameters, etc.
The {image-run-script}[./container_files/image-run.sh] script can be edited to decide what should be ran inside the container. Can decide to do evaluations using Conforma or using the OPA client embedded within it, running unit tests, change evaluation parameters, etc.
====

=== b. Run Policy Evaluation Locally
Expand All @@ -29,10 +29,10 @@ To run the policies locally, we'll need to use the https://github.com/enterprise

[TIP]
====
Conforma formerly known as *Enterprise Contract* which is where the EC abbreviations in the code and documentation comes from. The download and use of these binaries can be fetched and used automatically using the https://google.com[./runme.sh] script in the repo.
Conforma formerly known as *Enterprise Contract* which is where the EC abbreviations in the code and documentation comes from. The download and use of these binaries can be fetched and used automatically using the {local-run-script}[./runme.sh] script in the repo.
====

Mequal currently relies on helper functions available from https://github.com/enterprise-contract/ec-policies[Conforma/EC policies] in order to generate better output from the policy evaluations and unit testing. *To run the policy evaluations successfully with OPA, we need to download these manually and put them in place.* This can already be done automatically using the https://google.com[./runme.sh] script in the repo. *For evaluation using Conforma/EC, these functions already fetched in the background, so it can immediately be used to start evaluating policies locally.*
Mequal currently relies on helper functions available from https://github.com/enterprise-contract/ec-policies[Conforma/EC policies] in order to generate better output from the policy evaluations and unit testing. *To run the policy evaluations successfully with OPA, we need to download these manually and put them in place.* This can already be done automatically using the {local-run-script}[./runme.sh] script in the repo. *For evaluation using Conforma/EC, these functions already fetched in the background, so it can immediately be used to start evaluating policies locally.*

By running the script mentioned above, we can immediate download the necessary binaries and helper functions, and start running our policy evaluations locally:

Expand Down

0 comments on commit bc78159

Please sign in to comment.