feat: new template and doc updates (#233)

* New Requirements templates

added a new template  for solution requirements

* Update config.yaml

Fixed spelling

* feat: add performance recommendations to the docs (#231)

* feat: add performance recommendations to the docs

* refactor: grammar

* refactor: update theme version to latest after merge

---------

Co-authored-by: John R. Harris <[email protected]>
Co-authored-by: Travis Pawley <[email protected]>

.gitignore

@@ -8,6 +8,7 @@ presidium-hugo
 presidium
 dist/
 .DS_Store
+resources/
 
 dist/
 docs/resources

docs/content/best-practices/general-performance-guidelines.md

@@ -0,0 +1,14 @@
+---
+title: General Performance Guidelines
+weight: 7
+---
+
+For Presidium to support the functionality it has built on top of Hugo there are some performance considerations to take into account so that build times can remain reasonable. Below are some steps that can be taken to help with overall build performance:
+
+- Keep total markdown content to 50MB or less, this should result in a build time of around one minute, but this cannot be guaranteed due to other factors
+
+- Content spread across multiple files is more performant that having fewer files with more content
+
+- Less content per markdown file is encouraged, this also supports Presidium's philosophy of small micro-articles
+
+- While project dependent multiple directories with single a `_index.md` file has better build performance

docs/content/reference/markdown/side-by-side-conten.md

@@ -3,7 +3,7 @@ title: Side By Side Content
 weight: 10
 ---
 
-A shortcode is available (`{{</* sidebyside */>}}`) in order to have content, within a single file, in two different columns that are side by side.
+A shortcode is available (`{{%/* sidebyside */%}}`) in order to have content, within a single file, in two different columns that are side by side.
 
 Create side-by-side content by using the following:
 
@@ -19,4 +19,4 @@ Content you want on the right hand side of the site
 {{% /sidebyside %}}
 ```
 
-> **Note**: `--split-content--` is where the content is to be split between left and right. Without this keyword the site will fail to render the two columns correctly
+> **Note**: `--split-content--` is where the content is to be split between left and right. Without this keyword the site will fail to render the two columns correctly

docs/go.mod

@@ -2,4 +2,4 @@ module presidium
 
 go 1.18
 
-require github.com/spandigital/presidium-theme-website v2.12.4+incompatible // indirect
+require github.com/spandigital/presidium-theme-website v2.17.13+incompatible // indirect

docs/go.sum

@@ -0,0 +1,2 @@
+github.com/spandigital/presidium-theme-website v2.17.13+incompatible h1:uzzv1ZZzW8S4LLgJ2h90a31/HAWEdlbqmGTs26qbKQM=
+github.com/spandigital/presidium-theme-website v2.17.13+incompatible/go.mod h1:8fTL83SigfxCino9GI0yWCVPuWVdUP7o4wfDVgChJCU=

templates/requirements/config.yaml

@@ -0,0 +1,83 @@
+languageCode: "en-us"
+title: "{{ .Title }}"
+copyright: Template Footer
+pluralizelisttitles: false
+params:
+    sortByFilePath: true
+markup:
+  goldmark:
+    renderer:
+      Unsafe: true
+    parser:
+      attribute:
+        block: true
+  highlight:
+    style: github
+menu:
+  main:
+    - identifier: overview
+      name: Overview
+      url: /
+      weight: 1
+    - identifier: archetypes-and-personas
+      name: Archetypes and Personas
+      url: /archetypes-and-personas/
+      weight: 2
+    - identifier: entities-and-relationships
+      name: Entities and Relationships
+      url: /entities-and-relationships/
+      weight: 3
+    - identifier: state-transitions
+      name: State Transitions
+      url: /state-transitions/
+      weight: 4
+    - identifier: features-and-functions
+      name: Features and Functions
+      url: /features-and-functions/
+      weight: 5
+    - identifier: process-flows
+      name: Process Flows
+      url: /process-flows/
+      weight: 6
+    - identifier: capabilities
+      name: Capabilities
+      url: /capabilities/
+      weight: 7
+    - identifier: reference
+      name: Reference
+      url: /reference/
+      weight: 8
+    - identifier: updates
+      name: Updates
+      url: /updates/
+      weight: 9
+outputFormats:
+  MenuIndex:
+    baseName: menu
+    mediaType: application/json
+  SearchMap:
+    baseName: searchmap
+    mediaType: application/json
+outputs:
+  home:
+    - HTML
+    - RSS
+    - MenuIndex
+    - SearchMap
+module:
+  imports:
+    {{ if .Brand -}}
+    - path: {{ .Brand }}
+      mounts:
+        - source: assets
+          target: assets
+        - source: static
+          target: static
+    {{- end }}
+    - path: {{ .Theme }}
+enableInlineShortcodes: true
+frontmatter:
+  lastmod:
+    - lastmod
+    - :fileModTime
+    - :default

templates/requirements/content/archetypes-and-personas/_index.md

@@ -0,0 +1,3 @@
+---
+title: Archetypes and Personas
+---

templates/requirements/content/archetypes-and-personas/persona.md

@@ -0,0 +1,5 @@
+---
+title: A Persona (Archetype)
+author: author
+---
+Content...

templates/requirements/content/capabilities/_index.md

@@ -0,0 +1,16 @@
+---
+title: Capabilities
+---
+
+Capabilities, or non-functional requirements, are quantifiable attributes of the solution that define the overall fitness for purpose of the solution. Common capabilities include 
+
+Performance
+Reliability 
+Security
+Usability 
+Maintainability 
+Scalability 
+Verifiability 
+Interoperability
+
+While all these capabilities are desirable only a few need to be targeted for most solutions. Knowing which are important and defining target values for your solution is vitally important 

templates/requirements/content/capabilities/capability.md

@@ -0,0 +1,6 @@
+---
+title: A capability
+author: author
+---
+
+Content...

templates/requirements/content/entities-and-relationships/_index.md

@@ -0,0 +1,4 @@
+---
+title: Entities and Relationships
+---
+

templates/requirements/content/entities-and-relationships/entity-relationship-diagram.md

@@ -0,0 +1,5 @@
+---
+title: Entity Relationship Diagram
+author: author
+---
+Content...

templates/requirements/content/entities-and-relationships/entity.md

@@ -0,0 +1,9 @@
+---
+title: An Entity
+author: author
+---
+Entity Definition 
+
+Relationships 
+
+...

templates/requirements/content/features-and-functions/_index.md

@@ -0,0 +1,5 @@
+---
+title: Features
+---
+
+The highest level functionality of the system. Each feature covers a major area of functionality 

templates/requirements/content/features-and-functions/feature 1 /_index.md

@@ -0,0 +1,5 @@
+---
+title: feature 1 
+author: author
+---
+Feature definition ....

templates/requirements/content/features-and-functions/feature 1 /function.md

@@ -0,0 +1,5 @@
+---
+title: A Function
+author: author
+---
+

templates/requirements/content/overview/_index.md

@@ -0,0 +1,4 @@
+---
+title: Overview
+url: /
+---

templates/requirements/content/overview/hello.md

@@ -0,0 +1,16 @@
+---
+title: "Hello Presidium!"
+---
+
+This template project provides a basic structure to start your presidium module.
+
+For recipes and help on creating your content, see: [presidium.spandigital.net](http://presidium.spandigital.net)
+for detailed examples.
+
+# Heading 1
+## My Table
+
+One  |  Two |  Three
+--|---|--
+  |   |
+  |   |

templates/requirements/content/process-flows/_index.md

@@ -0,0 +1,3 @@
+---
+title: Process Flows
+---

templates/requirements/content/process-flows/process-flow.md

@@ -0,0 +1,5 @@
+---
+title: A Process Flow
+author: author
+---
+Content...

templates/requirements/content/reference/_index.md

@@ -0,0 +1,3 @@
+---
+title: Reference
+---

templates/requirements/content/reference/reference.md

@@ -0,0 +1,5 @@
+---
+title: A Reference
+author: author
+---
+Content...

templates/requirements/content/state-transitions/_index.md

@@ -0,0 +1,3 @@
+---
+title: State Transition Model 
+---

templates/requirements/content/state-transitions/state-transition model.md

@@ -0,0 +1,5 @@
+---
+title: State Transition Model
+author: author
+---
+Content...

templates/requirements/content/updates/_index.md

@@ -0,0 +1,3 @@
+---
+title: Updates
+---

templates/requirements/content/updates/update.md

@@ -0,0 +1,5 @@
+---
+title: An Update
+author: author
+---
+Content...

templates/requirements/go.mod

@@ -0,0 +1,3 @@
+module github.com/spandigital/{{ .ProjectName }}
+
+go 1.16