Skip to content

Commit

Permalink
large site update with new pages and modified tree structure
Browse files Browse the repository at this point in the history
  • Loading branch information
@BillBensing
BillBensing committed Sep 4, 2024
1 parent 661cebe commit 4711213
Show file tree
Hide file tree
Showing 18 changed files with 364 additions and 226 deletions.
30 changes: 22 additions & 8 deletions Writerside/n-nape.tree
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,22 +8,36 @@

<toc-element topic="nape-overview.md"/>
<toc-element topic="getting-started-with-nape.topic">
<toc-element topic="installing-nape.md"/>
<toc-element topic="nape-core-concepts.topic">
<toc-element topic="iia-three-lines-of-defense.topic"/>
<toc-element topic="governance-engineering.topic"/>
<toc-element topic="autonomous-assurance.topic"/>
<toc-element topic="what-nape-does.md">
<toc-element topic="control-assurance-and-audit.topic"/>
<toc-element topic="the-two-types-of-assurance-procedures.topic"/>
<toc-element topic="pass-fail-inconclusive.topic"/>
</toc-element>
<toc-element topic="what-you-do.md">
<toc-element topic="iia-three-lines-of-defense.topic"/>
<toc-element topic="autonomous-assurance.topic"/>
<toc-element topic="governance-engineering.topic"/>
</toc-element>
</toc-element>
<toc-element topic="nape-usecase-and-examples.topic">
<toc-element topic="process-assurance.topic">
<toc-element topic="business-process-assurance.md"/>
<toc-element topic="nape-for-devops-automated-governance-sdlc-ci-cd.md"/>
</toc-element>
<toc-element topic="configuration-and-calibration-assurance.topic">
<toc-element topic="software-as-a-service-configuration-assurance.md"/>
<toc-element topic="web-server-configuration-assurance.md"/>
</toc-element>
</toc-element>
<toc-element topic="installing-nape.md"/>
</toc-element>
<toc-element topic="nape-usecase-and-examples.topic">
<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">
<toc-element topic="Tutorial-1.topic">
<toc-element topic="Simple-Business-Process.topic"/>
<toc-element topic="Simple-SDLC.topic"/>
</toc-element>
<toc-element topic="tutorial-2.topic"/>
</toc-element>
<toc-element topic="nape-glossary.topic"/>
</instance-profile>
4 changes: 0 additions & 4 deletions Writerside/redirection-rules.xml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,4 @@
<accepts>page.html</accepts>
</rule>
-->
<rule id="7ea2f225">
<description>Created after removal of "Tutorial-1" from NAPE - Not Another Policy Engine</description>
<accepts>Tutorial-1.html</accepts>
</rule>
</rules>
132 changes: 34 additions & 98 deletions Writerside/topics/Tutorial-1.topic
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,112 +3,48 @@
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Tutorial 1" id="Tutorial-1">
title="Tutorial One (1)" id="Tutorial-1">

<!-- A section combines multiple topics dedicated to a specific subject.
Add a starting page to provide an overview of the topics in the section.
Start with two topics you want to promote in the <spotlight> group,
several important topics in the <primary> group (for example, where to start),
several less important topics in the <secondary> group (for example, more advanced topics),
and optionally add any other relevant topics in the <misc> group as cards and lists of links
(maybe related topics from other sections).
Only the spotlight section is limited to two topics.
For other groups, try to keep the number between 2 and 6, but you can add more if necessary.-->
<!-- TODO - Tutorial 2 - Simple SDLC -->
<p>
Tutorial 1 - Overview
</p>

<!-- TODO - Create the topic page for Tutorial-1-->
<section-starting-page>
<title>NAPE - Tutorial 1</title>
<p>
Provide a short outline for the tutorial.
In this tutorial, you will learn how to:
</p>

<description>
Simple Business Process - Automating the Assurance
</description>
<list>
<li>Do this</li>
<li>Deal with that</li>
</list>

<!-- 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>
</spotlight>
<chapter title="Process Assurance" id="process-assurnace">
<p>
List the prerequisites that are required or recommended.
Make sure that:
</p>

<!-- Add several topics that are most important for this section. -->
<primary>
<title>Get started</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>
</primary>
<list>
<li>Prerequisite one</li>
<li>Prerequisite two</li>
</list>
</chapter>

<!-- Add several topics that are less important or are relevant only for advanced/experienced users. -->
<secondary>
<title>Explore advanced features</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>
</secondary>
<chapter title="Simple Business Process" id="simple-business-process">
<p>
TODO - describe the simple business process tutorial quickly
</p>

<!-- 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>
</chapter>

<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>
<chapter title="Simple SDLC" id="simple-sdlc">
<p>
TODO - describe the simple sdlc tutorial quickly
</p>

<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>
</chapter>

</section-starting-page>

</topic>
</topic>
38 changes: 10 additions & 28 deletions Writerside/topics/autonomous-assurance.topic
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,22 @@
title="Autonomous Assurance" id="autonomous-assurance">

<p>
A reference article is information-oriented.
It provides a structured description of a product:
its APIs, classes, functions, configuration options, actions, and so on.
Start with a summary of what this reference article is about, and what the items you are describing are used for.
TODO: Create this material
</p>

<chapter title="Command" id="command">
<p>Syntax:</p>

<code-block lang="shell">
cmd [OPTIONS]
</code-block>
<chapter title="What is &lt;product/service/concept&gt;" id="overview-chapter" >
<p>Provide some background and context, explain choices and alternatives.</p>
</chapter>

<chapter title="Options" id="options">
<p>Describe what each option is used for:</p>

<deflist type="medium">
<def title="-o, --open">
Opens a file.
</def>
<def title="-c, --close">
Closes a file.
</def>
<def title="-v --version">
Displays version information.
<chapter title="Glossary" id="glossary">
<p>A definition list or a glossary:</p>
<deflist>
<def title="Term1">
This is the definition of the first term.
</def>
<def title="-h, --help">
Displays help.
<def title="Term2">
This is the definition of the second term.
</def>
</deflist>
</chapter>

<seealso>
<!--Provide links to related how-to guides, overviews, and tutorials.-->
</seealso>
</topic>
27 changes: 27 additions & 0 deletions Writerside/topics/configuration-and-calibration-assurance.topic
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Configuration &amp; Calibration Assurance" id="configuration-and-calibration-assurance">

<p>
Overview articles give background information and provide context to a particular subject.
Their goal is to explain a concept, not to teach or give instructions.
</p>

<chapter title="What is &lt;product/service/concept&gt;" id="overview-chapter" >
<p>Provide some background and context, explain choices and alternatives.</p>
</chapter>
<chapter title="Glossary" id="glossary">
<p>A definition list or a glossary:</p>
<deflist>
<def title="Term1">
This is the definition of the first term.
</def>
<def title="Term2">
This is the definition of the second term.
</def>
</deflist>
</chapter>
</topic>
45 changes: 45 additions & 0 deletions Writerside/topics/control-assurance-and-audit.topic
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE topic
SYSTEM "https://resources.jetbrains.com/writerside/1.0/xhtml-entities.dtd">
<topic xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="https://resources.jetbrains.com/writerside/1.0/topic.v2.xsd"
title="Controls, Assurance, and Audit" id="control-assurance-and-audit">

<p>
A reference article is information-oriented.
It provides a structured description of a product:
its APIs, classes, functions, configuration options, actions, and so on.
Start with a summary of what this reference article is about, and what the items you are describing are used for.
</p>

<chapter title="Command" id="command">
<p>Syntax:</p>

<code-block lang="shell">
cmd [OPTIONS]
</code-block>
</chapter>

<chapter title="Options" id="options">
<p>Describe what each option is used for:</p>

<deflist type="medium">
<def title="-o, --open">
Opens a file.
</def>
<def title="-c, --close">
Closes a file.
</def>
<def title="-v --version">
Displays version information.
</def>
<def title="-h, --help">
Displays help.
</def>
</deflist>
</chapter>

<seealso>
<!--Provide links to related how-to guides, overviews, and tutorials.-->
</seealso>
</topic>
24 changes: 11 additions & 13 deletions Writerside/topics/getting-started-with-nape.topic
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,31 +18,29 @@
<section-starting-page>
<title>Getting Started with NAPE</title>
<description>
Add an introductory paragraph: explain what this section is about in 2-3 short sentences.
How do your learn best? Is it by understanding everything from the ground up, or is by getting hands-on and working on real-life problems? Start ground-up with Core Concepts, and get Hands-On by starting with NAPE Installation.
</description>

<!-- Add up to 2 topics that you want to promote. Use the "type" attribute to select an icon. -->
<spotlight>
<a href="nape-core-concepts.topic" 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>
<a href="nape-core-concepts.topic" type="learn" summary="Dig into the concepts and first principles NAPE is based on. These Core Concepts cover the business concepts in 'What NAPE Does', and discussion the new ways of working with the 'What You Do' section. ">Core Concepts</a>
<a href="installing-nape.md" type="settings" summary="Get hands-on right away and install the NAPE software. Then check out the Usecases &amp; Examples, or go straight to the Tutorials.">Installing NAPE</a>
</spotlight>

<!-- Add several topics that are most important for this section. -->
<primary>
<title>Get started</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>
<title>Core Concepts</title>
<a href="what-nape-does.md" type="check-list" summary="Learn the first-principles NAPE is using. Explore the ideas behind controls, assurance, audit, the two (2) types of assurance procedures, and the concept of the P/F/I Test.">What NAPE Does</a>
<a href="what-you-do.md" type="community" summary="Explore how this can change for the good, your and your peers' roles and responsibilities. Read about Governance Engineering and how you can leverage it for Autonomous Assurance.">What You Do</a>
</primary>

<!-- Add several topics that are less important or are relevant only for advanced/experienced users. -->
<secondary>
<title>Explore advanced features</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>
<title>Usecases &amp; Examples</title>
<a href="business-process-assurance.md" type="library" summary="TODO - Provide Summary"/>
<a href="nape-for-devops-automated-governance-sdlc-ci-cd.md" type="branch" summary="TODO - Provide Summary"/>
<a href="software-as-a-service-configuration-assurance.md" type="mixed" summary="TODO - Provide Summary"/>
<a href="web-server-configuration-assurance.md" type="server" summary="TODO - Provide Summary"/>
</secondary>

</section-starting-page>
Expand Down
3 changes: 1 addition & 2 deletions Writerside/topics/governance-engineering.topic
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,7 @@
title="Governance Engineering" id="governance-engineering">

<p>
Overview articles give background information and provide context to a particular subject.
Their goal is to explain a concept, not to teach or give instructions.
TODO: Create this material
</p>

<chapter title="What is &lt;product/service/concept&gt;" id="overview-chapter" >
Expand Down
Loading

0 comments on commit 4711213

Please sign in to comment.