diff --git a/docs/functional-spec/Functional_Specification.pdf b/docs/functional-spec/Functional_Specification.pdf index c0fcd12..b88255b 100644 Binary files a/docs/functional-spec/Functional_Specification.pdf and b/docs/functional-spec/Functional_Specification.pdf differ diff --git a/docs/functional-spec/functional_spec.md b/docs/functional-spec/functional_spec.md index 0d36da1..54c03ef 100644 --- a/docs/functional-spec/functional_spec.md +++ b/docs/functional-spec/functional_spec.md @@ -1,70 +1,70 @@ # Functional Specification ## 0. Table of Contents -1. [Introduction](#1-Introduction) - 1. [Overview](#11-Overview) - 2. [Business Context](#12-Business-Context) - 3. [Glossary](#13-Glossary) - 1. [Panoptes](#131-Panoptes) -2. [General Description](#2-General-Description) - 1. [Product/System Functions](#21-ProductSystem-Functions) - 2. [User Characteristics and Objectives](#22-User-Characteristics-and-Objectives) - 3. [Operational Scenarios](#23-Operational-Scenarios) - 1. [Module Installation](#231-Module-Installation) - 2. [Module Control](#232-Module-Control) - 3. [Function Permission Denied](#233-Function-Permission-Denied) - 4. [User Login and Verification](#234-User-Login-and-Verification) - 4. [Constraints](#24-Constraints) - 1. [Security Constraints](#241-Security-Constraints) - 2. [Server Constraints](#242-Server-Constraints) - 3. [Timing Constraints](#243-Timing-Constraints) -3. [Functional Requirements](#3-Functional-Requirements) - 1. [User Authentication](#31-User-Authentication) - 1. [Description](#311-Description) - 2. [Criticality](#312-Criticality) - 3. [Technical Issues](#313-Technical-Issues) - 4. [Dependencies](#314-Dependencies) - 2. [Hierarchy Management](#32-Hierarchy-Management) - 1. [Description](#321-Description) - 2. [Criticality](#322-Criticality) - 3. [Technical Issues](#323-Technical-Issues) - 4. [Dependencies](#324-Dependencies) - 3. [Module Installation](#33-Module-Installation) - 1. [Description](#331-Description) - 2. [Criticality](#332-Criticality) - 3. [Technical Issues](#333-Technical-Issues) - 4. [Dependencies](#334-Dependencies) - 4. [Module Control](#34-Module-Control) - 1. [Description](#341-Description) - 2. [Criticality](#342-Criticality) - 3. [Technical Issues](#343-Technical-Issues) - 4. [Dependencies](#344-Dependencies) - 5. [Container Orchestration](#35-Container-Orchestration) - 1. [Description](#351-Description) - 2. [Criticality](#352-Criticality) - 3. [Technical Issues](#353-Technical-Issues) - 4. [Dependencies](#354-Dependencies) - 6. [Statistics Display](#36-Statistics-Display) - 1. [Description](#361-Description) - 2. [Criticality](#362-Criticality) - 3. [Technical Issues](#363-Technical-Issues) - 4. [Dependencies](#364-Dependencies) - 7. [Security](#37-Security) - 1. [Description](#371-Description) - 2. [Criticality](#372-Criticality) - 3. [Technical Issues](#373-Technical-Issues) - 4. [Dependencies](#374-Dependencies) -4. [System Architecture](#4-System-Architecture) - 1. [Diagram](#41-Diagram) - 2. [Go Server](#42-Go-Server) - 3. [Blazor Backend](#43-Blazor-Backend) - 4. [Blazor Frontend](#44-Blazor-Frontend) - 5. [Postgresql](#45-Postgresql) - 6. [Docker](#46-Docker) -5. [High Level Design](#5-High-Level-Design) - 1. [User Installs Module](#51-User-Installs-Module) - 2. [User Creates/Updates Role Permissions](#52-User-CreatesUpdates-Role-Permissions) - 3. [User Manages Module](#53-User-Manages-Module) -6. [Preliminary Schedule](#6-Preliminary-Schedule) +1. [Introduction](#1-introduction) + 1. [Overview](#11-overview) + 2. [Business Context](#12-business-context) + 3. [Glossary](#13-glossary) + 1. [Panoptes](#131-panoptes) +2. [General Description](#2-general-description) + 1. [Product/System Functions](#21-productsystem-functions) + 2. [User Characteristics and Objectives](#22-user-characteristics-and-objectives) + 3. [Operational Scenarios](#23-operational-scenarios) + 1. [Module Installation](#231-module-installation) + 2. [Module Control](#232-module-control) + 3. [Function Permission Denied](#233-function-permission-denied) + 4. [User Login and Verification](#234-user-login-and-verification) + 4. [Constraints](#24-constraints) + 1. [Security Constraints](#241-security-constraints) + 2. [Server Constraints](#242-server-constraints) + 3. [Timing Constraints](#243-timing-constraints) +3. [Functional Requirements](#3-functional-requirements) + 1. [User Authentication](#31-user-authentication) + 1. [Description](#311-description) + 2. [Criticality](#312-criticality) + 3. [Technical Issues](#313-technical-issues) + 4. [Dependencies](#314-dependencies) + 2. [Hierarchy Management](#32-hierarchy-management) + 1. [Description](#321-description) + 2. [Criticality](#322-criticality) + 3. [Technical Issues](#323-technical-issues) + 4. [Dependencies](#324-dependencies) + 3. [Module Installation](#33-module-installation) + 1. [Description](#331-description) + 2. [Criticality](#332-criticality) + 3. [Technical Issues](#333-technical-issues) + 4. [Dependencies](#334-dependencies) + 4. [Module Control](#34-module-control) + 1. [Description](#341-description) + 2. [Criticality](#342-criticality) + 3. [Technical Issues](#343-technical-issues) + 4. [Dependencies](#344-dependencies) + 5. [Container Orchestration](#35-container-orchestration) + 1. [Description](#351-description) + 2. [Criticality](#352-criticality) + 3. [Technical Issues](#353-technical-issues) + 4. [Dependencies](#354-dependencies) + 6. [Statistics Display](#36-statistics-display) + 1. [Description](#361-description) + 2. [Criticality](#362-criticality) + 3. [Technical Issues](#363-technical-issues) + 4. [Dependencies](#364-dependencies) + 7. [Security](#37-security) + 1. [Description](#371-description) + 2. [Criticality](#372-criticality) + 3. [Technical Issues](#373-technical-issues) + 4. [Dependencies](#374-dependencies) +4. [System Architecture](#4-system-architecture) + 1. [Diagram](#41-diagram) + 2. [Go Server](#42-go-server) + 3. [Blazor Backend](#43-blazor-backend) + 4. [Blazor Frontend](#44-blazor-brontend) + 5. [Postgresql](#45-postgresql) + 6. [Docker](#46-docker) +5. [High Level Design](#5-high-level-design) + 1. [User Installs Module](#51-user-installs-module) + 2. [User Creates/Updates Role Permissions](#52-user-createsupdates-role-permissions) + 3. [User Manages Module](#53-user-manages-module) +6. [Preliminary Schedule](#6-preliminary-schedule) ## 1. Introduction ### 1.1 Overview