docs: restructure to sections administration, user and devlopment
!27 nofusscomputing/infrastructure/website!62
This commit is contained in:
27
docs/projects/django-template/administration/index.md
Normal file
27
docs/projects/django-template/administration/index.md
Normal file
@ -0,0 +1,27 @@
|
||||
---
|
||||
title: Development Documentation
|
||||
description: No Fuss Computings Development Documentation for Django ITSM
|
||||
date: 2024-06-17
|
||||
template: project.html
|
||||
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
|
||||
---
|
||||
|
||||
This documentation is targeted towards those whom administer the applications deployment.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
To install this application you must have a container engine installed, both docker and kubernetes are supported. The container image is available on [Docker Hub](https://hub.docker.com/r/nofusscomputing/django-template) and can be pulled with `docker pull nofusscomputing/django-template:latest`.
|
||||
|
||||
Settings for the application are stored within a docker volume at path `/etc/itsm/`, with the settings living in `.py` files. A database is also required for the application to store it's settings. SQLLite and MariaDB/MySQL are supported.
|
||||
|
||||
|
||||
### Settings file
|
||||
|
||||
The settings file is a python file `.py` and must remain a valid python file for the application to work.
|
||||
|
||||
``` py title="settings.py"
|
||||
|
||||
--8<-- "includes/etc/itsm/settings.py"
|
||||
|
||||
```
|
@ -8,6 +8,8 @@ about: https://gitlab.com/nofusscomputing/infrastructure/configuration-managemen
|
||||
|
||||
This page contains different items related to the development of this application.
|
||||
|
||||
Documentation for the application api is within it's own section, [API](./api/index.md).
|
||||
|
||||
|
||||
## Icons
|
||||
|
||||
|
@ -1,7 +1,7 @@
|
||||
---
|
||||
title: Django ITSM
|
||||
description: No Fuss Computings Django ITSM
|
||||
date: 2024-05-06
|
||||
description: No Fuss Computings Django ITSM Application
|
||||
date: 2024-06-17
|
||||
template: project.html
|
||||
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
|
||||
---
|
||||
@ -13,49 +13,27 @@ This Django Project is designed to be a tool that forms part of IT Service Manag
|
||||
|
||||
This application contains the following module:
|
||||
|
||||
- [API](api.md)
|
||||
- [API](./user/api.md)
|
||||
|
||||
- [Application wide settings](settings.md)
|
||||
- [Application wide settings](./user/settings.md)
|
||||
|
||||
- [Configuration Management](config_management/index.md)
|
||||
- [Configuration Management](./user/config_management/index.md)
|
||||
|
||||
- History
|
||||
|
||||
- [IT Asset Management (ITAM)](itam/index.md)
|
||||
- [IT Asset Management (ITAM)](./user/itam/index.md)
|
||||
|
||||
- [Multi-Tenant](permissions.md)
|
||||
- [Multi-Tenant](./user/permissions.md)
|
||||
|
||||
Specific features for a module can be found on the module's documentation un the features heading
|
||||
|
||||
|
||||
### History
|
||||
## Documentation
|
||||
|
||||
Effort is placed upon all database items having a history. The items that specifically track history can be found on the items documentation page under its features heading. The history Module tracks the following:
|
||||
Documentation is broken down into three areas, they are:
|
||||
|
||||
- What Item Type
|
||||
- [Administration](./administration/index.md)
|
||||
|
||||
- What the change was
|
||||
- [Development](./development/index.md)
|
||||
|
||||
- Who made the change
|
||||
|
||||
- When the change was made
|
||||
|
||||
Once a history entry has been made for an item, no one including a `super_admin` can edit or delete a history entry. The only time a history entry is removed, is when an item is removed from the database.
|
||||
|
||||
|
||||
## Installation
|
||||
|
||||
To install this application you must have a container engine installed, both docker and kubernetes are supported. The container image is available on [Docker Hub](https://hub.docker.com/r/nofusscomputing/django-template) and can be pulled with `docker pull nofusscomputing/django-template:latest`.
|
||||
|
||||
Settings for the application are stored within a docker volume at path `/etc/itsm/`, with the settings living in `.py` files. A database is also required for the application to store it's settings. SQLLite and MariaDB/MySQL are supported.
|
||||
|
||||
|
||||
### Settings file
|
||||
|
||||
The settings file is a python file `.py` and must remain a valid python file for the application to work.
|
||||
|
||||
``` py title="settings.py"
|
||||
|
||||
--8<-- "includes/etc/itsm/settings.py"
|
||||
|
||||
```
|
||||
- [User](./user/index.md)
|
||||
|
Before Width: | Height: | Size: 33 KiB After Width: | Height: | Size: 33 KiB |
26
docs/projects/django-template/user/index.md
Normal file
26
docs/projects/django-template/user/index.md
Normal file
@ -0,0 +1,26 @@
|
||||
---
|
||||
title: User Documentation
|
||||
description: No Fuss Computings User Documentation for Django ITSM
|
||||
date: 2024-05-06
|
||||
template: project.html
|
||||
about: https://gitlab.com/nofusscomputing/infrastructure/configuration-management/django_app
|
||||
---
|
||||
|
||||
This documentation is targeted towards the application users. This section of the documentation specifically targets the UI and how to use each of the applications modules.
|
||||
|
||||
Documentation for specific otems can be found in the navigation menu to the left of the screen.
|
||||
|
||||
|
||||
### History
|
||||
|
||||
Effort is placed upon all database items having a history. The items that specifically track history can be found on the items documentation page under its features heading. The history Module tracks the following:
|
||||
|
||||
- What Item Type
|
||||
|
||||
- What the change was
|
||||
|
||||
- Who made the change
|
||||
|
||||
- When the change was made
|
||||
|
||||
Once a history entry has been made for an item, no one including a `super_admin` can edit or delete a history entry. The only time a history entry is removed, is when an item is removed from the database.
|
Reference in New Issue
Block a user