Jingga/Organization-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Organization-Guide.git synced 2026-01-11 12:58:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

update

Browse Source
This commit is contained in:
Dennis Eichhorn 2022-08-06 00:11:13 +02:00
parent a86cd00ef1
commit e7497d8ebe
18 changed files with 184 additions and 20 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation Type Overview.md
View File

@ -25,3 +25,7 @@
* Forms
* Forms to be used for certain organization activities
2022-01-01 - Version 1.0

45
Legal/Licensors.md
View File

@ -1,13 +1,33 @@
# Licensors #
The following **key** licensors are used in the project (end user relevant libraries/resources). Additional libraries and tools are used but not specifically mentioned either because they are only used as dependency by one of the below mentioned licensors or because of their small impact on the overall project.
## Fonts ##
### Font Awesome ###
* Files: fontaweseom/*
* Files: fontawesome/*
* License: https://fortawesome.github.io/Font-Awesome/license/
* Source: https://fortawesome.github.io
### Linearicons
* Files: linearicons/*
* License: https://linearicons.com/free/license
* Source: https://linearicons.com/
### Lineicons
* Files: lineicons/*
* License: https://lineicons.com/download/
* Source: https://lineicons.com/license/
### Roboto
* Files: Roboto/*
* License: https://github.com/googlefonts/roboto/blob/main/LICENSE
* Source: https://github.com/googlefonts/roboto
## JavaScript ##
Core JavaScript libraries
@ -25,6 +45,18 @@ Core JavaScript libraries
* License: https://github.com/chartjs/Chart.js/blob/master/LICENSE.md
* Source: https://github.com/chartjs/Chart.js
### Mermaid
* Files: mermaid/*
* License: https://github.com/mermaid-js/mermaid/blob/develop/LICENSE
* Source: https://github.com/mermaid-js/mermaid
### PDF.js
* Files: mermaid/*
* License: https://github.com/mozilla/pdf.js/blob/master/LICENSE
* Source: https://github.com/mozilla/pdf.js
## Images
### Orange Fruit Pieces ###
@ -66,3 +98,14 @@ Core PHP libraries
* Files: PHPPresentation/*
* License: https://github.com/PHPOffice/PHPPresentation/blob/develop/LICENSE
* Source: https://github.com/PHPOffice/PHPPresentation
## Other
Additional resources can be found in:
* [Resources](https://github.com/Karaka-Management/Resources)
* The respective composer.json files in the repositories
* The respective package.json files in the repositories
* External/third party tools mentioned in the documentation
* [Approved Customer Software](../Processes/Support/Approved%20Customer%20Software.md)

6
Policies & Guidelines/Car Pool Policy.md
View File

@ -41,3 +41,9 @@ All drivers are responsible for their traffic violations. This includes also bei
## Return
The car must be returned in good condition by the end of the lease term or if the employment at the organization ends. Gross negligence including repairs for unreported damages must be paid by the employee.
2022-01-01 - Version 1.0

1
Policies & Guidelines/Code of Conduct.md
View File

@ -44,3 +44,4 @@ This Code of Conduct is adapted from the [Contributor Covenant][homepage], versi
[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/

4
Policies & Guidelines/Development Guidelines.md
View File

@ -1,3 +1,7 @@
# Development Guidelines
The developer and development guidelines are published in a separate documentation called the [Developer-Guide](https://github.com/Karaka-Management/Developer-Guide). The reason for this is that also clients and third parties can modify the source code or create extensions. This documentation contains a vast amount of information which helps to understand the code structure, code standards etc.
2022-01-01 - Version 1.0

4
Policies & Guidelines/General Definitions & Standards.md
View File

@ -104,3 +104,7 @@ This document and the information contained herein is provided on an “AS IS”
## Date Time Format
The date time format in all documents must follow the [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html) standardization: `YYYY-MM-DD` or `YYYY-MM-DD HH:MM:SS` (sometimes written as `YYYY-MM-DD h:i:s`).
2022-01-01 - Version 1.0

20
Policies & Guidelines/IT/Backup & Data Recovery.md
View File

@ -51,3 +51,23 @@ The data should be stored in such a way that only authorized personnel has acces
## Reconstruction
The data reconstruction is documented in a reconstruction tutorial in the IT processes. During the reconstruction it may be necessary to put a higher priority on files and data which are more important for the ongoing organization activities (e.g. customer data, source code data).
## Flowchart (daily backup)
```mermaid
graph TD;
CHECK_CHANGES([System: Check changes])-->CREATE_LOCAL_BACKUP[System: Create/update backup];
CREATE_LOCAL_BACKUP-->VALIDATE_LOCAL[System: Validate local backup];
VALIDATE_LOCAL-->IS_VALID1{System: Is valid?};
IS_VALID1--Yes-->COPY_ONLINE[System: Copy backup to cloud];
IS_VALID1--No-->REPORT[System: Inform IT department];
COPY_ONLINE-->VALIDATE_ONLINE[System: Validate remote backup];
VALIDATE_ONLINE-->IS_VALID2{System: Is valid?};
IS_VALID2--No-->REPORT;
```
2022-01-01 - Version 1.0

18
Policies & Guidelines/IT/Change Management.md
View File

@ -8,7 +8,7 @@ Permissions should always be defined as low as possible and only get expanded if
Potential documents to be changed are:
* Permission List
* [Permission List](../../Processes/IT/Permission%20List.md)
### Flowchart
@ -34,17 +34,17 @@ The IT department can decide to reject a permission change if they consider the
Potential documents to be used are:
* Third Party Software Validation - New
* Third Party Software Validation - Update
* Investment Form
* [Third Party Software Validation - New](../../Processes/IT/Third%20Party%20Software%20Validation%20-%20New.md)
* [Third Party Software Validation - Update](../../Processes/IT/Third%20Party%20Software%20Validation%20-%20New.md)
* [Investment Form](../../Processes/Purchase/Investment%20Form.md)
Potential documents to be changed are:
* IT Equipment & Software
* Automated Jobs
* Permission List
* Approved Customer Software
* Key Supplier Evaluation
* [IT Equipment & Software](../../Processes/IT/IT%20Equipment%20&%20Software.md)
* [Automated Jobs](../../Processes/IT/Automated%20Jobs.md)
* [Permission List](../../Processes/IT/Permission%20List.md)
* [Approved Customer Software](../../Processes/Support/Approved%20Customer%20Software.md)
* [Key Supplier Evaluation](../../Processes/Purchase/Key%20Supplier%20Evaluation.md)
### Flowchart

17
Policies & Guidelines/IT/Database Guidelines.md
View File

@ -1,6 +1,23 @@
# Database Guidelines
## Access permissions
Access permissions to the databases must be defined as granular as reasonably possible.
* Admin: Only for Head of IT and CTO
* This account however must only be used in exceptional situations
* Application specific user and permission settings:
* some applications need one main user with admin permissions on a specific table
* some application need multiple users where the different users have different permissions
* All other database users must only be have read-only permissions
## Direct data changes
No direct data changes are allowed in the databases. All changes in the database must be performed by the applications managing the database.
## Logging
Logging must be always enabled for errors and warnings. Additional logging can be enabled if deemed helpful by the Head of IT or CTO. Error or warning logs must be sent to the head of IT and CTO on a daily basis, if any occurred. The head of IT or CTO must take appropriate steps to solve the errors and warnings in a timely manner.

33
Policies & Guidelines/IT/Operations Guidelines.md
View File

@ -2,6 +2,39 @@
## Infrastructure
```mermaid
graph TD;
ROUTER[Router]---FIREWALL[Firewall & IPS/IDS];
ROUTER---REMOTE_BACKUP_SERVER[Remote backup server];
FIREWALL---INTERNAL_ROUTER[Core routers];
INTERNAL_ROUTER---SWITCH[Organization switches];
INTERNAL_ROUTER---SWITCH_PUBLIC[Public switches];
SWITCH_PUBLIC---WEB_SERVER[Web servers];
WEB_SERVER---WEBSITE[Website];
WEB_SERVER---SHOP[Shop];
WEB_SERVER---SOFTWARE[Software];
WEB_SERVER---DEMO_SERVER1[Puplic demo server 1];
DEMO_SERVER1---DEMO_SERVER2[Puplic demo server 2];
WEB_SERVER---DEMO_SERVER3[Private demo server];
SWITCH---DEV_SERVER[Dev server];
DEV_SERVER---DEV_RESOURCES[Dev resources/assets];
DEV_SERVER---TESTING[Testing server];
DEV_SERVER---INTERNAL_DEMO_SERVER[Demo server];
SWITCH---MAIL_SERVER[Mail server];
SWITCH---FILE_SERVER[File server];
SWITCH---DB_SERVER[DB server];
DB_SERVER---MIRRORED_DB_SERVER[Mirrored DB server];
SWITCH---IP_PHONE_SERVER[IP Phone Server];
SWITCH---USER_HARDWARE[User hardware];
USER_HARDWARE---PC[PC];
USER_HARDWARE---PHONE[Phone];
USER_HARDWARE---PRINTER[Printer]
INTERNAL_ROUTER---SWITCH_PRIVATE[Private switches];
SWITCH_PRIVATE---LOCAL_BACKUP_SERVER[Local backup server];
```
2022-01-01 - Version 1.0

14
Processes/01_Development.md
View File

@ -80,6 +80,10 @@ If the code reviewer only finds minor issues with the proposed code change the r
Some code changes may also require changes or extensions in the demo setup scripts. The demo setup script try to simulate a real world use case by generating and modifying mostly random data. This is also a good way to setup and “manually” test the code changes in a larger picture. The demo setup script can be found in the [demoSetup](https://github.com/Karaka-Management/demoSetup) repository. The demo setup script takes a long time due to the large amount of user input simulated data which is generated. Therefore it is recommended to run this only sporadically. (**R9**)
#### Documentation
Occasionally new code or code changes also require new documentation or documentation changes. Developers should make sure that the new code is also reflected in the existing documentation ([Developer-Guide](), [User-Guide]() and/or module documentation) or if additional documentation is necessary.
### Release flow
Code changes must be performed in a new branch. A new branch can be created with:
@ -120,6 +124,16 @@ The name of the branch can be chosen freely however it is recommended to follow
The senior developer who performs the code review merges the change request into the `develop` branch after their successful code review. Unsuccessful reviews lead to change requests by the original developer, other developers who can make the requested changes, changes by the senior developer who performed the review, or dismissal of the changed code. (**R10**)
## Approved dependencies
### Customer dependencies
Developers may only rely on the dependencies defined in [Approved Customer Software]() when developing a solution. If new software should be added to this list or a different version is required developers should make a request with their team leader/head of department who forwards this requests if appropriate to the CTO and explain the reasoning for the different dependency needs. The CTO can decide if the dependency will be accepted. (**R11**)
### Developer dependencies
Developers may only rely on the dependencies defined in [IT Equipment & Software](). If new software should be added to this list or a different version is required developers should make a request with their team leader/head of department who forwards this requests if appropriate to the CTO and explain the reasoning for the different dependency needs. The CTO can decide if the dependency will be accepted. Changing the package managers such as `composer.json` or `package.json` is not allowed by anyone else than the CTO. (**R12**)
2022-01-01 - Version 1.0

2
Processes/HR/Hiring/Default Rejection.md
View File

@ -6,7 +6,7 @@ Dear {NAME}
We appreciate your interest in our organization and the position of {POSITION} for which you applied. After reviewing the application, yours was not selected for further consideration.
The selection committee appreciates the time you invested in your application and wish you best of lock for your future endeavors.
The selection committee appreciates the time you invested in your application and we wish you best of lock for your future endeavors.

2
Processes/HR/Hiring/Sample Contract.md
View File

@ -0,0 +1,2 @@
# Employment Contract

4
Processes/IT/IT Equipment & Software.md
View File

@ -11,13 +11,13 @@
| PC | < 2,000 EUR (if no laptop) | < 2,500 EUR | < 2,500 EUR |
| Monitor(s) | < 500 EUR per Monitor (if < 2 monitors at desk) | < 1,500 EUR | < 1,500 EUR |
| IT equipment (e.g. mouse, keyboard) | < 300 EUR | < 500 EUR | < 500 EUR |
| Printer & Scanner | < 500 EUR (only sekretariat) | < 500 EUR | < 500 EUR |
| Printer & Scanner | < 500 EUR (only secretariat) | < 500 EUR | < 500 EUR |
### Shared
| Type | Costs | Location(s) |
| ----------------- | -------------------------------- | ------------------------------------------------------------ |
| Printer & Scanner | < 1.500 EUR per machine per year | 1x Sekretariat<br />1x Finance department<br />1x HR department<br />1x Sales department |
| Printer & Scanner | < 1.500 EUR per machine per year | 1x Secretariat<br />1x Finance department<br />1x HR department<br />1x Sales department |
## Software

13
Processes/Purchase/Key Supplier Evaluation.md
View File

@ -3,12 +3,13 @@
| Name | Products & Services | Description | Annual amount | Type | Dependency risk | Alternative evaluation | Quality evaluation | Last evaluated by | Last evaluated |
| --------------------------------------- | ----------------------------------------- | --------------------------- | -------------------- | --------------- | --------------- | ------------------------------------------------------------ | ------------------------------------------------------------ | ----------------- | -------------- |
| Oracle | VirtualBox | Machine virtualization | 0 EUR | single purchase | very low | Alternative solutions such as VMWare, Hyper-V or KVM don't provide any significant benefits for the general use case. Customers can still choose a different solution regardless. | No significant issues | Dennis Eichhorn | 2022-01-01 |
| PHPOffice | PhpSpereadsheet, PHPWord, PHPPresentation | Office software | 0 EUR | single purchase | medium | No alternative supplier could be found which combines all three products and same functionality. Solutions which cover a single aspect are available but more inconvenient to use. | No significant issues but the performance (e.g. memory usage) limits the use cases and requires parallelizing certain tasks. | Dennis Eichhorn | 2022-01-01 |
| mPDF | mPDF | PDF renderer | 0 EUR | single purchase | low | Alternative solutions don't provide the same level of html/css rendering capabilities. Alternatives are also available through PHPWord or tcpdf. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Tecnick | tcpdf | PDF renderer | 0 EUR | single purchase | low | Fastest php pdf renderer. Alternatives are also available through PHPWord or mpdf. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| PHPOffice | PhpSpereadsheet, PHPWord, PHPPresentation | Office software (backend) | 0 EUR | single purchase | medium | No alternative supplier could be found which combines all three products and same functionality. Solutions which cover a single aspect are available but more inconvenient to use. | No significant issues but the performance (e.g. memory usage) limits the use cases and requires parallelizing certain tasks. | Dennis Eichhorn | 2022-01-01 |
| mPDF | mPDF | PDF renderer (backend) | 0 EUR | single purchase | low | Alternative solutions don't provide the same level of html/css rendering capabilities. Alternatives are also available through PHPWord or tcpdf. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Tecnick | tcpdf | PDF renderer (backend) | 0 EUR | single purchase | low | Fastest php pdf renderer. Alternatives are also available through PHPWord or mpdf. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Mozilla | PDF.js | PDF renderer (frontend) | 0 EUR | single purchase | low | Simple pdf frontend renderer. Alternatives are available but not implemented (e.g. PDFium, PSPDFKit, PDFTron, ...). | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| TeamViewer | TeamViewer | Remote desktop connection | 219.50 EUR per month | subscription | very low | No alternative is as conveniently to use or is as broadly implemented (works on many different OS). It is the most well established remote desktop connection tool for support purposes. Alternatives VNC solutions could work as a fall back in a worst case situation. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Microsoft | github | Source code version control | 0 EUR | subscription | very low | The closest alternative is gitlab. However, github is the most established solution which is simple to use and provides the necessary functionality. It's also possible to host alternative solutions on the company servers in a worst case situation. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| PHP | PHP | Programming language | 0 EUR | single purchase | very high | Alternative solutions exist (e.g. node/javascript or C#) but would require substantial efforts in re-writing the applicatio and it's modules | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| PHP | PHP | Programming language | 0 EUR | single purchase | very high | Alternative solutions exist (e.g. node/javascript or C#) but would require substantial efforts in re-writing the application and it's modules | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| MariaDB | MariaDB | Database | 0 EUR | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Oracle | MySQL | Database | not purchased | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| The PostgreSQL Global Development Group | Postgresql | Database | 0 EUR | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
@ -18,6 +19,10 @@
| Redis Ltd. | Redis | Memory cache | 0 EUR | single purchase | very low | A alternative solution is already implemented and ready for use. This software is also not necessary and *only* provides improved performance. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| The Apache Software Foundation | Apache2 | Web server | 0 EUR | single purchase | very low | A alternative solution is already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| F5, Inc. | nginx | Web server | 0 EUR | single purchase | very low | A alternative solution is already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Tesseract | tesseract-ocr | OCR | 0 EUR | single purchase | high | Alternative solutions exist but are more expensive to implement (e.g. TensorFlow, Google Cloud Vision, Amazon Rekognition) | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Fonticons, Inc. | Font Awesome | Icon font | 0 EUR | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Roonas | Linearicons | Icon font | 0 EUR | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
| Lineicons | Lineicons | Icon font | 0 EUR | single purchase | very low | Alternative solutions are already implemented and ready for use. | No significant issues. | Dennis Eichhorn | 2022-01-01 |
> Single purchase can also mean one time download for software without any dependency on other services.

5
Processes/Support/Approved Customer Software.md
View File

@ -10,6 +10,7 @@
| PhpSpereadsheet, PHPWord, PHPPresentation | Office software | | 2022-01-01 |
| mPDF | PDF renderer | | 2022-01-01 |
| tcpdf | PDF renderer | | 2022-01-01 |
| PDF.js | PDF renderer | | 2022-01-01 |
| TeamViewer | Remote desktop connection | | 2022-01-01 |
| Tesseract-OCR | OCR | | 2022-01-01 |
| Memcached | Memory cache | | 2022-01-01 |
@ -25,6 +26,10 @@
| pdftoppm | PDF to image converter | | 2022-01-01 |
| Apache2 | Web server | | 2022-01-01 |
| Nginx | Web server | | 2022-01-01 |
| Roboto | Font | | 2022-01-01 |
| Linearicons | Font | | 2022-01-01 |
| Lineicons | Font | | 2022-01-01 |
| Font Awesome | Font | =4.0 | 2022-01-01 |
Consider to update the [Key Supplier Evaluation](../Purchase/Key%20Supplier%20Evaluation.md) when changing this table.

10
Project/PROJECT.md
View File

@ -13,7 +13,7 @@ Last update of this file: 2022.05.01
## Latest changelog
### June 2022
### July 2022
#### New
@ -21,9 +21,13 @@ Last update of this file: 2022.05.01
* Implement table sorting
##### Auditor
* Turned auditing data from text to blob and compressed it resulting in a storage reduction by approx. 75% - 80%
##### Framework
*
* Hard limit JSON requests and urldata to 1MB
#### Bug fixes
@ -250,6 +254,8 @@ Todos/tasks which are not important enough to be part of the milestones (or don'
| high | Forms | Adding a template to the DOM should modify its id/generate a custom/random id for the added element |
| high | Forms | If a form has unsaved content the browser should ask if the user really wants to change the page or close it (use beforeunload event). |
| medium | Job | Consider to run jobs through the cli application. This means a job executes `php cli.php put:/admin/job -i 3` which runs the command of job 3. This would allow to log the job execution time and response. If you don't want to wait for the execution to finish you may as well run it async (this means of course no execution time or output can be logged, but at least the start time). |
| medium | Form/Table | Implement a filter highlight function (either in forms or in tables, where the filter icon is highlighted, if a filter is defined). One solution could be to put an additional hidden filter checkbox in front of the filter icon and check for filter changes (bubble up) and then activate this hidden checkbox if a filter is defined. In css just define the filter icon as active/highlighted, if the hidden check box is active. This means we have two hidden checkboxes in front of the filter icon (one in case the filter menu is open = popup is visible and another one for highlighting the filter icon if a filter is defined). |
| medium | Form/Table | How to preserve form filter data to the next page? Not an issue, in the future we don't want to reload the whole page, but only exchange the table/list content with the backend response -> the header/filter will not get changed and remains as defined. This means for tables (maybe even forms?) to setup content replacement earlier than for other pages?! |
| medium | CMS | Create functionality which allows to replace application files. Instead of just overwriting them they get backed up in a backup directory. |
| medium | UI select | Bind data to select options such as visible elements and data pre-fills. When an option is selected certain ui elements become visible and get filled out with default values. |
| medium | phpOMS | Implement Redis / memcached sessions |

2
README.md
View File

@ -56,7 +56,7 @@ General updates can be found in our info section at https://karaka.app/info and
## Tech stack
* Language: php, js, c++, html, css, markdown, shell script
* Database: Maria/MySQL, PostgreSQL, MSSQL, SQLite
* Database: Maria/MySQL, PostgreSQL, MSSQL/SQLSrv, SQLite
* Webserver: apache2, nginx
* Cache: Redis, Memcached