completed uscase & examples topic

nape-not-another-policy-engine · Aug 21, 2024 · e075eb4 · e075eb4
1 parent 63e1072
commit e075eb4
Show file tree

Hide file tree

Showing 6 changed files with 23 additions and 67 deletions.
diff --git a/Writerside/n-nape.tree b/Writerside/n-nape.tree
@@ -8,10 +8,11 @@
 
     <toc-element topic="nape-overview.md"/>
     <toc-element topic="getting-started-with-nape.topic">
+        <toc-element topic="nape-core-concepts.md"/>
         <toc-element topic="installing-nape.md"/>
     </toc-element>
     <toc-element topic="nape-usecase-and-examples.topic">
-        <toc-element topic="business-process-assurnace.md"/>
+        <toc-element topic="business-process-assurance.md"/>
         <toc-element topic="nape-for-devops-automated-governance-sdlc-ci-cd.md"/>
     </toc-element>
     <toc-element topic="nape-tutorials.topic">

diff --git a/...side/topics/business-process-assurnace.md → ...side/topics/business-process-assurance.md b/...side/topics/business-process-assurnace.md → ...side/topics/business-process-assurance.md
diff --git a/Writerside/topics/getting-started-with-nape.topic b/Writerside/topics/getting-started-with-nape.topic
@@ -16,15 +16,15 @@
             For other groups, try to keep the number between 2 and 6, but you can add more if necessary.-->
 
     <section-starting-page>
-        <title>Section starting page title</title>
+        <title>Getting Started with NAPE</title>
         <description>
             Add an introductory paragraph: explain what this section is about in 2-3 short sentences.
         </description>
 
         <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
         <spotlight>
-            <a href="" type="account" summary="This overrides the card summary of the topic">Custom card title</a>
-            <a href="" type="search" summary="This overrides the card summary of the topic">Another custom title</a>
+            <a href="nape-core-concepts.md" type="learn" summary="This overrides the card summary of the topic">Core Concepts</a>
+            <a href="installing-nape.md" type="settings" summary="This overrides the card summary of the topic">Installing NAPE</a>
         </spotlight>
 
         <!--    Add several topics that are most important for this section.    -->
@@ -45,67 +45,6 @@
             <a href="" summary="With a custom card summary">Custom card title</a>
         </secondary>
 
-        <!--    Optionally add additional cards and links to topics that are not in this section but may be relevant.    -->
-        <misc>
-            <cards>
-                <title>Other relevant topics as wide cards</title>
-                <a href=""/>
-                <a href="" summary="With a custom card summary"/>
-                <a href="">Custom card title</a>
-                <a href="" summary="With a custom card summary">Custom card title</a>
-            </cards>
-
-            <cards narrow="true">
-                <title>Other relevant topics as narrow cards</title>
-                <a href=""/>
-                <a href=""/>
-                <a href="" summary="With a custom card summary"/>
-                <a href="">Custom card title</a>
-                <a href="">Custom card title</a>
-                <a href="" summary="With a custom card summary">Custom card title</a>
-            </cards>
-
-            <links>
-                <group>
-                    <title>Other related topics as links</title>
-                    <a href=""/>
-                    <a href="" summary="With a custom card summary"/>
-                    <a href="">Custom card title</a>
-                    <a href="" summary="With a custom card summary">Custom card title</a>
-                </group>
-                <group>
-                    <title>Two in a row</title>
-                    <a href=""/>
-                    <a href="" summary="With a custom card summary"/>
-                    <a href="">Custom card title</a>
-                    <a href="" summary="With a custom card summary">Custom card title</a>
-                </group>
-            </links>
-
-            <links narrow="true">
-                <group>
-                    <title>More related topics</title>
-                    <a href=""/>
-                    <a href="" summary="With a custom card summary"/>
-                    <a href="">Custom card title</a>
-                    <a href="" summary="With a custom card summary">Custom card title</a>
-                </group>
-                <group>
-                    <title>Three in a row</title>
-                    <a href=""/>
-                    <a href=""/>
-                    <a href="">Custom card title</a>
-                    <a href="">Custom card title</a>
-                </group>
-                <group>
-                    <title>Each group is narrow</title>
-                    <a href=""/>
-                    <a href=""/>
-                    <a href="">Custom card title</a>
-                    <a href="">Custom card title</a>
-                </group>
-            </links>
-        </misc>
     </section-starting-page>
 
 </topic>
diff --git a/Writerside/topics/nape-core-concepts.md b/Writerside/topics/nape-core-concepts.md
@@ -0,0 +1,3 @@
+# Core Concepts
+
+Start typing here...
diff --git a/Writerside/topics/nape-overview.md b/Writerside/topics/nape-overview.md
@@ -1,4 +1,4 @@
-# NAPE - Not Another Policy Engine - Overview
+# NAPE Overview
 
 NAPE is an Assurance Engine that uses the business domain concepts to provide a structured way to conduct any type of assurance activity which requires:
 

diff --git a/Writerside/topics/nape-usecase-and-examples.topic b/Writerside/topics/nape-usecase-and-examples.topic
@@ -23,10 +23,23 @@
 
         <!--    Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon.    -->
         <spotlight>
-            <a href="business-process-assurnace.md" type="account" summary="Many company policies, industry, and regulations require certain business processes to meet a high standard for execution.  Lean how NAPE can analyze a complex business processes to assess its compliance.">Assurance for Complicated Business Processes</a>
+            <a href="business-process-assurance.md" type="account" summary="Many company policies, industry, and regulations require certain business processes to meet a high standard for execution.  Lean how NAPE can analyze a complex business processes to assess its compliance.">Assurance for Complicated Business Processes</a>
             <a href="nape-for-devops-automated-governance-sdlc-ci-cd.md" type="search" summary="The best companies change their software and systems frequently to maintain a competitive advantage. See how NAPE can replace Change Approval Boards (CABs) leveraging the DevOps Automated Governance Reference Architecture (DAG).">Software Delivery and Change Management Assurance</a>
         </spotlight>
 
+        <!--    Add several topics that are most important for this section.    -->
+        <primary>
+            <title>Get started</title>
+            <a href="nape-core-concepts.md" summary="Learn the Core Concepts from Internal Audit and formal Assurance that NAPE is built upon.">NAPE Core Concepts</a>
+            <a href="installing-nape.md" summary="Install NAPE on your computer or anywhere you need it to collect evidence, evaluate facts, and report compliance.">Install NAPE</a>
+        </primary>
+
+        <!--    Add several topics that are less important or are relevant only for advanced/experienced users.    -->
+        <secondary>
+            <title>Hands-On Learning with Tutorials</title>
+            <a href="Simple-Business-Process.topic" summary="Use NAPE to autonomize assurance for a Human Resources on-boarding processes.">NAPE for Business Processes</a>
+            <a href="Simple-SDLC.topic" summary="Verify a CI/CD processes with Automated Governance powered by NAPE">Software Delivery with NAPE</a>
+        </secondary>
 
     </section-starting-page>