docs(core): initial docs pages for v1.2

ref: #250 #252 #96 #93 #95 #90 #115
nofusscomputing · Aug 31, 2024 · 638ea46 · 638ea46
1 parent 31bc1e4
commit 638ea46
Show file tree

Hide file tree

Showing 11 changed files with 31 additions and 20 deletions.
diff --git a/app/core/templates/core/ticket.html.j2 b/app/core/templates/core/ticket.html.j2
@@ -5,7 +5,7 @@
     <link rel="stylesheet" href="{% static 'ticketing.css' %}">
 {% endblock additional-stylesheet %}
 
-{% load tickets %}
+{% load markdown %}
 
 {% block article %}
 

diff --git a/app/core/templates/core/ticket/comment/comment.html.j2 b/app/core/templates/core/ticket/comment/comment.html.j2
@@ -1,4 +1,4 @@
-{% load tickets %}
+{% load markdown %}
 
 {% if comment %}
 

diff --git a/app/core/templatetags/tickets.py b/app/core/templatetags/tickets.py
diff --git a/docs/projects/centurion_erp/administration/core/ticketing.md b/docs/projects/centurion_erp/administration/core/ticketing.md
@@ -0,0 +1,8 @@
+---
+title: Tickets
+description: Tickets administration documentation for Centurion ERP by No Fuss Computing
+date: 2024-08-27
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/centurion_erp
+---
+
diff --git a/docs/projects/centurion_erp/development/forms.md b/docs/projects/centurion_erp/development/forms.md
@@ -51,6 +51,7 @@ All forms must meet the following requirements:
 
     ```
 
+
 ## Details Form
 
 A details form is for the display of a models data. This form should inherit from a base form and contain any additional fields as is required for the display of the models data. Additional requirements are as follows:
@@ -63,7 +64,6 @@ A details form is for the display of a models data. This form should inherit fro
         Ensure that there is a call to the super-class `__init__` method so that the form is correctly initialised. i.e. `super().__init__(*args, **kwargs)`
 
 
-
 ## Abstract Classes
 
 The following abstract classes exist for a forms inheritance:

diff --git a/docs/projects/centurion_erp/development/templates.md b/docs/projects/centurion_erp/development/templates.md
@@ -110,9 +110,7 @@ Base definition for defining a detail page is as follows:
 
 For the view to render the page, you must define the data as part of the form class.
 
-
-
- The variable name to use is `tabs` The layout/schema is as follows:
+The variable name to use is `tabs` The layout/schema is as follows:
 
 
 ##### Full Example

diff --git a/docs/projects/centurion_erp/development/testing.md b/docs/projects/centurion_erp/development/testing.md
@@ -55,7 +55,7 @@ class DeviceHistory(TestCase, HistoryEntry, HistoryEntryParentItem):
 
 Each module is to contain a tests directory of the model being tested with a single file for grouping of what is being tested. for items that depend upon a parent model, the test file is to be within the child-models test directory named with format `test_<model>_<parent app>_<parent model name>`
 
-_example file system structure showing the layout of the tests directory for a module_
+example file system structure showing the layout of the tests directory for a module.
 
 ``` text
 .

diff --git a/docs/projects/centurion_erp/user/core/tickets.md b/docs/projects/centurion_erp/user/core/tickets.md
@@ -0,0 +1,8 @@
+---
+title: Tickets
+description: Ticket system Documentation as part of the Core Module for Centurion ERP by No Fuss Computing
+date: 2024-08-23
+template: project.html
+about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/centurion_erp
+---
+
diff --git a/...template/user/project_management/index.md → ...rion_erp/user/project_management/index.md b/...template/user/project_management/index.md → ...rion_erp/user/project_management/index.md
diff --git a/...mplate/user/project_management/project.md → ...on_erp/user/project_management/project.md b/...mplate/user/project_management/project.md → ...on_erp/user/project_management/project.md
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -60,6 +60,8 @@ nav:
 
       - projects/centurion_erp/administration/backup.md
 
+      - projects/centurion_erp/administration/core/ticketing.md
+
       - projects/centurion_erp/administration/installation.md
 
     - Development:
@@ -188,6 +190,8 @@ nav:
 
         - projects/centurion_erp/user/core/index.md
 
+        - projects/centurion_erp/user/core/tickets.md
+
       - ITAM:
 
         - projects/centurion_erp/user/itam/index.md
@@ -210,6 +214,12 @@ nav:
 
         - projects/centurion_erp/user/itim/service.md
 
+      - Project Management:
+
+        - projects/centurion_erp/user/project_management/index.md
+
+        - projects/centurion_erp/user/project_management/project.md
+
       - Settings:
 
         - projects/centurion_erp/user/settings/index.md