Merge pull request #96 from gtrivedi88/HACDOCS-326

Added content on Managing compliance with EC

Author: jc-berger

antora-lunr-ui/css/main.css

@@ -1,12 +1,3 @@
-.toc.sidebar .toc-menu {
-    padding-left: 100px !important;
-    width: 600px !important;
-}
-
-.doc {
-    min-width: 900px;
-}
-
 .toolbar .edit-this-page a {
     color: white !important;
 }

antora-lunr-ui/img/logo.png

@@ -1,14 +1,16 @@
 <header class="header" role="banner">
   <nav class="navbar">
-    <div class="navbar-brand">
-      <a class="navbar-item" href="{{or site.url (or siteRootUrl siteRootPath)}}">{{site.title}}</a>
-
-      <button class="navbar-burger" data-target="topbar-nav">
-        <span></span>
-        <span></span>
-        <span></span>
-      </button>
-    </div>
+        <div class="navbar-brand">
+          <div class="navbar-item">
+            <button class="navbar-burger" data-target="topbar-nav">
+              <span></span>
+              <span></span>
+              <span></span>
+            </button>
+            <img src="{{uiRootPath}}/img/logo.png" class="navbar-logo" alt="App Studio logo">
+            <a href="{{site.url}}/">{{site.title}}</a>
+          </div>
+        </div>
     <div id="topbar-nav" class="navbar-menu">
       <div class="navbar-end">
               <div class="button"><a href="https://redhat-appstudio.github.io/appstudio.docs.ui.io/" target="_blank">Home</a></div>

antora-lunr-ui/partials/header-content.hbs

@@ -42,36 +42,9 @@ antora:
   - '@antora/collector-extension'
   - '@antora/lunr-extension'
 
-asciidoc:
-  attributes:
+urls:
+    html_extension_style: indexify # For consistency with pages indexed by search engines, see https://docs.antora.org/antora/latest/playbook/urls-html-extension-style/
+    redirect_facility: static # The least convenient, but only available redirect on our hosting platform, see https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/
+    latest_prerelease_version_segment: next # Override the version in the navigation https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/
+    latest_version_segment_strategy: replace # Consequence of static redirect, see https://docs.antora.org/antora/latest/playbook/urls-redirect-facility/
 
-  # Standard document attributes to be used in our documentation
-    icons: font
-    source-highlighter: highlightjs
-    url-guide: https://red-hat-stone-soup.pages.redhat.com/stonesoup-documentation/
-    idseparator: '-'
-    page-pagination: '-'
-
-  # Product content attributes
-    ProductName: App Studio
-    ProductShortName: ''
-    ProductRelease: ''
-    ProductVersion: ''
-    ProductPreviousVersion: ''
-    ProductNextVersion: ''
-
-  # Repository URLs
-    repoURL1: ''
-    repoURL2: ''
-
-  # Name of APIs and their URLs
-    APIName1: ''
-    APIName2: ''
-
-  # Knowledge base article links
-    # TBD
-
-  # Links to other projects
-    Placeholder: ''
-    Placeholder2: ''
-    Placeholder3: ''

antora-playbook.yml

@@ -10,3 +10,41 @@ nav:
 - modules/ROOT/nav-glossary.adoc
 - modules/ROOT/nav-contribute.adoc
 - modules/ROOT/nav-support.adoc
+
+asciidoc:
+  attributes:
+
+  # Standard document attributes to be used in our documentation
+    icons: font
+    source-language: asciidoc@
+    source-highlighter: highlightjs
+    url-guide: https://red-hat-stone-soup.pages.redhat.com/stonesoup-documentation/
+    idseparator: '-'
+    page-pagination: '-'
+    idprefix: ''
+    experimental: ""
+
+  # Product content attributes
+    ProductName: App Studio
+    context: app
+    ProductShortName: ''
+    ProductRelease: ''
+    ProductVersion: ''
+    ProductPreviousVersion: ''
+    ProductNextVersion: ''
+
+  # Repository URLs
+    repoURL1: ''
+    repoURL2: ''
+
+  # Name of APIs and their URLs
+    APIName1: ''
+    APIName2: ''
+
+  # Knowledge base article links
+    # TBD
+
+  # Links to other projects
+    Placeholder: ''
+    Placeholder2: ''
+    Placeholder3: ''

docs/antora.yml

@@ -10,6 +10,7 @@
 ** xref:how-to-guides/proc_managed_services_onboarding.adoc[CLI: Managed services team onboarding]
 ** xref:how-to-guides/delete_application.adoc[CLI: Deleting an application].
 ** xref:how-to-guides/delete_application.adoc[Web UI: Deleting an application].
+** xref:how-to-guides/proc_managing-compliance-with-the-enterprise-contract.adoc[Web UI: Managing compliance with the Enterprise Contract]
 
 ////
 Commenting these out per HACDOCS-425 and -414 

docs/modules/ROOT/nav-how-to-guides.adoc

@@ -0,0 +1,44 @@
+:_content-type: PROCEDURE
+
+[id="managing-compliance-with-the-enterprise-contract_{context}"]
+= Managing compliance with the Enterprise Contract
+
+The Enterprise Contract (EC) is an artifact verifier and customizable policy checker. You can use Enterprise Contract to keep your software supply chain secure and ensure conatiner images comply with your organization's policies. It does this by verifying the security and provenance of builds created through {ProductName}.
+
+{ProductName}'s build process uses the Tekton Chains to generate a signed in-toto attestation of the build pipeline. The Enterprise Contract then uses this attestation to verify the build's integrity and compliance with a set of policies. These policies include best practices and any organization-specific requirements.
+
+.Prerequisites
+
+* You have created an application. 
+* You have an upgraded build pipeline.
+
+.Procedure
+
+. Open an existing application and go to the *Integration tests* tab.
+. Select *Add integration test*.
+. In the *Integration test name* field, enter a name of your choosing.
+. In the *Image bundle* field, enter *quay.io/redhat-appstudio-tekton-catalog/pipeline-enterprise-contract:devel.*
+. In the *Pipeline to run* field, enter *enterprise-contract*.
+. Optional: If passing the this test is optional, and you do not want to prevent the application from being deployed or released, then select *Mark as optional for release*.
+. Select *Add Integration test*.
+. Trigger a new build by commiting a change in the GitHub repository of the application you are working with.
+
+
+.Verification
+
+. On your application, go to the *Activity > Pipeline* runs tab.
+
+. Select a pipeline run with *Type* as *Test*, and review the status of your test pipeline.
+
+. You can also review pipeline run details, logs, task runs, and security details by selecting a pipeline run with *Type* as *Test*. 
+
+[role="_additional-resources"]
+.Additional resources
+* To generate a signed link:https://in-toto.io/in-toto/[in-toto] attestation of the build pipeline, go to link:https://tekton.dev/docs/chains/[Tekton Chains].
+* For information on the source code for the Tekton pipelines defined in the bundle, see the link:https://github.com/redhat-appstudio/build-definitions/blob/main/pipelines/enterprise-contract.yaml[build-definitions] and 
+link:https://github.com/enterprise-contract/ec-cli/blob/main/tasks/verify-enterprise-contract/0.1/verify-enterprise-contract.yaml[ec-cli] repositories.
+* To use a specific version of the pipeline bundle instead of the devel tag, you can select one of the link:https://quay.io/repository/redhat-appstudio-tekton-catalog/pipeline-enterprise-contract?tab=tags[pinned tags].
+* For information on components in Enterprise Contract, see the link:https://enterprisecontract.dev/docs/ec/main/index.html#_components[Components].
+* For information on the Enterprise Contract policies designed for {ProductName}, see the link:https://enterprisecontract.dev/docs/ec-policies/index.html[Enterprise Contract Policies].
+
+