Skip to content

Commit

Permalink
Import existing docs from os2borgerpc-admin-site
Browse files Browse the repository at this point in the history
  • Loading branch information
agnetemoos committed Nov 12, 2024
1 parent 4264e3a commit e41bbb5
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 0 deletions.
103 changes: 103 additions & 0 deletions docs/admin_site/Governancerapport.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,103 @@
---
parent: "Admin Site"
title: OS2borgerPC governance rapport
---

Dette er OS2's governance checkliste der skal benyttes til at belyse niveauet af et OS2 produkt. Er du projektleder, koordinator eller på anden måde ansvarlig for et OS2 produkt? Så lav en kopi af denne fil og navngiv den efter produktet. Derefter udfylder du checklisten og uploader den til det relevante repository under produktets Github.

Du udfylder checklisten ved at skrive et x i de tomme [ ] ud for de krav produktet opfylder. Derudover udfylder du henvisningerne. Henvisningen må meget gerne være links, der forkortes ved at anvende hyperlinks = [tekst](link).

Se [OS2iot Governance Report.md](https://github.com/OS2iot/OS2IoT-docs/blob/master/OS2iot_GOVERNANCE_REPORT.md) for eksempel.

> Brug for hjælp? [Kontakt endelige OS2s sekretariat](https://os2.eu/gruppe/os2sekretariat), vi er her for at hjælpe.




**RELEVANS**

| | # | Krav | Henvisning | Niveau |
| --- | --- | --- | --- | --- |
| <ul><li> [ ] </li> | R1 | Løsningen skaber lokal værdi | Hvordan? | 0 |
| <ul><li> [ ] </li> | R2 | Løsningen skaber potentielt værdi for andre | Hvordan? | 1 |
| <ul><li> [ ] </li> | R3 | Løsningen er accepteret af lokal linjeledelse | fx tilslutningserklæring | 2 |
| <ul><li> [ ] </li> | R4 | _Løsningen har tværkommunal potentiale (anbefaling)_ | Hvordan? | 2 |
| <ul><li> [ ] </li> | R5 | Ophæng til nationale strategier er til stede | Hvordan/hvilke? | 3 |


<br>
<br>



**FORMKRAV**

| | # | Krav | Henvisning | Niveau |
| --- | --- | --- | --- | --- |
| <ul><li> [ ] </li> | F1 | Kildekoden deles | Indsæt link | 0 |
| <ul><li> [ ] </li> | F2 | Open Soruce licenskriterier overholdes | Indsæt vedtaget licens | 0 |
| <ul><li> [ ] </li> | F3 | Udbudsregler og alm. lovformlighed er overholdt | Kan udfyldes | 0 |
| <ul><li> [ ] </li> | F4 | Der er tænkt på sikkerheden i løsningen | Hvordan? | 0 |
| <ul><li> [ ] </li> | F5 | Løsningens formål og værdi er beskrevet | Hvor? | 0 |
| <ul><li> [ ] </li> | F6 | Kildekoden er overdraget og er placeret under OS2's github | Indsæt link | 1 |
| <ul><li> [ ] </li> | F7 | Driftskrav til løsningen er dokumenteret | Hvor? | 1 |
| <ul><li> [ ] </li> | F8 | Løsningen er dokumenteret på teknisk niveau | Hvor? | 1 |
| <ul><li> [ ] </li> | F9 | Teknisk implementering af løsningen er dokumenteret | Hvor? | 1 |
| <ul><li> [ ] </li> | F10 | OS2's kommunikationskanaler anvendes (OS2.eu) | Indsæt link(s) | 1 |
| <ul><li> [ ] </li> | F11 | OS2's styringsværktøj benyttes (Jira) | Indsæt link(s) | 1 |
| <ul><li> [ ] </li> | F12 | Der er kun en version af core koden (Master) | | 2 |
| <ul><li> [ ] </li> | F13 | Der er udarbejdet præsentationsmateriale af løsningen | Hvor? | 2 |
| <ul><li> [ ] </li> | F14 | Der er udarbejdet kommunikationsmateriale til strategisk niveau | Hvor? | 2 |
| <ul><li> [ ] </li> | F15 | Best practice for implementering i organisationen dokumenteres | Hvor? | 2 |
| <ul><li> [ ] </li> | F16 | Teknisk dokumentation indeholder best practice for kodestandarder i forhold til de anvendte teknologier | Hvor? | 2 |
| <ul><li> [ ] </li> | F17 | Drifts og vedligeholdelses setup er beskrevet | Hvem drifter løsningen? er der sat økonomi af til vedligholdelse? | 2 |
| <ul><li> [ ] </li> | F18 | Rammearkitekturen og standarder er fulgt og afvigelser er forklaret | | 2 |
| <ul><li> [ ] </li> | F19 | _Løsningen er leveret i et containerformat fx docker (anbefaling)_ | | 2 |
| <ul><li> [ ] </li> | F20 | _Uddanelses materiale er udarbejdet (anbefaling)_ | Hvor? | 2 |
| <ul><li> [ ] </li> | F21 | Politisk kommunikation er udarbejdet (Lokal + Omverden) | Hvor? | 3 |
| <ul><li> [ ] </li> | F22 | Procesplan + procesansvar for driftsimplementering er udarbejdet ([eksempel](https://os2mo.readthedocs.io/en/development/operation/cookbook.html)) | Hvor? | 3 |


<br>
<br>



**STRATEGISK SAMMENHÆNG**

| | # | Krav | Henvisning | Niveau |
| --- | --- | --- | --- | --- |
| <ul><li> [ ] </li> | S1 | Produktet har en kobling til [OS2's strategi](https://os2.eu/side/os2-mission-vision) | Hvordan? | 1 |
| <ul><li> [ ] </li> | S2 | Løsningen understøtter innovation og open source | Hvordan? | 1 |
| <ul><li> [ ] </li> | S3 | Produktets (forventlige) kobling til [OS2's mission, vision og strategi](https://os2.eu/side/os2-mission-vision) er beskrevet | Hvor? | 2 |
| <ul><li> [ ] </li> | S4 | Der er udarbejdet en vision og strategi for produktet | Hvor? | 2 |
| <ul><li> [ ] </li> | S5 | Produktets kobling til og overensstemmelse med OS2's vision og strategi er tilstede og beskrevet | Hvordan? | 3 |



<br>
<br>




**GOVERNANCE**

| | # | Krav | Henvisning | Niveau |
| --- | --- | --- | --- | --- |
| <ul><li> [ ] </li> | G1 | Produktet er oprettet i OS2's porteføljestyring (Hjemmeside) | Indsæt link | 1 |
| <ul><li> [ ] </li> | G2 | Der koordineres løbende med OS2-sekretariatet | | 1 |
| <ul><li> [ ] </li> | G3 | Der er udpeget en projektleder/tovholder | Hvem? evt. link til beskrivelse af ansvar/opgaver | 1 |
| <ul><li> [ ] </li> | G4 | Bestyrelsen er orienteret | fx link til referat | 1 |
| <ul><li> [ ] </li> | G5 | Bestyrelsen har godkendt produktet | fx link til referat | 2 |
| <ul><li> [ ] </li> | G6 | Der er nedsat en styregruppe | Link til kommissorium | 2 |
| <ul><li> [ ] </li> | G7 | _Der er nedsat en koordinationsgruppe (anbefaling)_ | Link til kommissorium | 2 |
| <ul><li> [ ] </li> | G8 | _En projektmodel anvendes og er dokumenteret (anbefaling)_ | Hvor? | 2 |
| <ul><li> [ ] </li> | G9 | _Review af kode foretages af tredjepart (anbefaling)_ | | 2 |
| <ul><li> [ ] </li> | G10 | _Der er udarbejdet en tilslutningserklæring til sikring af økonomi (anbefaling)_ | Hvor? | 2 |
| <ul><li> [ ] </li> | G11 | Bestyrelsen har godkendt styregruppen | fx link til referat | 3 |
| <ul><li> [ ] </li> | G12 | Bestyrelsen er repræsenteret i styregruppen | fx link til referat | 3 |
| <ul><li> [ ] </li> | G13 | Der foreligger en aftale der sikre økonomi til koordinerg og videreudvikling | Link til aftale | 3 |
| <ul><li> [ ] </li> | G14 | Der er etableret et fagligt fælleskab bag løsningen hvor erfaringer kan udveksles | Henvisning til en faggruppe eller et forum | 3 |

4 changes: 4 additions & 0 deletions docs/admin_site/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
---
title: Admin Site
---
Admin Site
24 changes: 24 additions & 0 deletions docs/admin_site/technical_documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
title: "Technical Documentation"
parent: "Admin Site"

---
## Architectural Diagram

### Terms

* **Check-in:** During every 5 minute interval OS2borgerpc will attempt to connect to the Admin-site to 1. report in and 2. check if any *jobs* are pending. If so the os2borgerpc-client will download and execute these.
* **Job:** A *PC* or *Group* can be delegated 1..* jobs. A *job* is a set of instructions in the form of install- or configuration scripts written in bash or python.



### Models / Database visualized


### Hosting

Configuring the use of customer admins


See the related
`Guide <https://github.com/OS2borgerPC/admin-site/raw/development/admin_site/static/docs/configuring_customer_admins.pdf>`_.

0 comments on commit e41bbb5

Please sign in to comment.