Initial OS2skoledata documentation

Author: abodigital

Gemfile

@@ -8,4 +8,4 @@ gem "just-the-docs", "0.10.1" # pinned to the current release
 
 gem "jekyll-relative-links", "0.7.0"
 
-gem "sass-embedded", "~> 1.78.0"
+gem "sass-embedded", "~> 1.78.0"

Gemfile.lock

@@ -3,18 +3,26 @@ GEM
   specs:
     addressable (2.8.7)
       public_suffix (>= 2.0.2, < 7.0)
-    base64 (0.3.0)
-    bigdecimal (3.2.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.9)
     colorator (1.1.0)
     concurrent-ruby (1.3.5)
-    csv (3.3.5)
+    csv (3.3.4)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
     eventmachine (1.2.7)
+    ffi (1.17.2-arm64-darwin)
+    ffi (1.17.2-x64-mingw-ucrt)
     ffi (1.17.2-x86_64-linux-gnu)
     forwardable-extended (2.6.0)
-    google-protobuf (4.31.1-x86_64-linux-gnu)
+    google-protobuf (4.31.0-arm64-darwin)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.0-x64-mingw-ucrt)
+      bigdecimal
+      rake (>= 13)
+    google-protobuf (4.31.0-x86_64-linux-gnu)
       bigdecimal
       rake (>= 13)
     http_parser.rb (0.8.0)
@@ -67,13 +75,17 @@ GEM
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     public_suffix (6.0.2)
-    rake (13.3.0)
+    rake (13.2.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.11.1)
       ffi (~> 1.0)
     rexml (3.4.1)
     rouge (4.5.2)
     safe_yaml (1.0.5)
+    sass-embedded (1.78.0-arm64-darwin)
+      google-protobuf (~> 4.27)
+    sass-embedded (1.78.0-x64-mingw-ucrt)
+      google-protobuf (~> 4.27)
     sass-embedded (1.78.0-x86_64-linux-gnu)
       google-protobuf (~> 4.27)
     terminal-table (3.0.2)
@@ -82,8 +94,9 @@ GEM
     webrick (1.9.1)
 
 PLATFORMS
+  arm64-darwin-23
+  x64-mingw-ucrt
   x86_64-linux
-  x86_64-linux-gnu
 
 DEPENDENCIES
   jekyll (~> 4.4.1)
@@ -92,4 +105,4 @@ DEPENDENCIES
   sass-embedded (~> 1.78.0)
 
 BUNDLED WITH
-   2.5.14
+   2.3.26

MAINTAINERS.md

@@ -1,49 +1,11 @@
-> [!IMPORTANT] 
-> *Remove this section from your README.md after completing all setup tasks!*
-> - [ ] Click the green "Use this template" button above.
-> - [ ] Name your new repository and create it.
-> - [ ] Replace all the grey placeholder texts with your project-specific information.
-> - [ ] Add any additional relevant Markdown documents to your documentation.
-> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
-> - [ ] **Remove this setup section from your README.md.**
->
-> *That's it! You are now set up, and your documentation site is live!*
+# OS2skoledata dokumentation
+Denne dokumentation har til formål at give et omfattende overblik over, hvordan OS2skoledata fungerer og hvordan den anvendes.
+  
+[Læs dokumentationen](https://os2skoledata.github.io/OS2skoledata-docs/)
 
-
-# [Replace with Project Title]
-> Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
-
-[How It Works](#🧭-how-it-works) | [Architecture](#architecture) | [ How to Install and Run](#▶️-how-to-install-and-run)
-
-## 🧭 How It Works
-> Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
-
-#### Architecture
-
-> Replace with a Brief introduction to the project's high-level architecture. Link to the architecture documentation with a diagram preferably in mermaid syntax.
-[ARCHITECTURE.MD](./docs/ARCHITECTURE.MD)
-
-#### Key Features
-
-> Replace this with a brief explaination of the main features or functionalities of your project.
-
-## ▶️ How to Install and Run
-> Replace with clear, concise instructions on how to install and run the codebase for development, test and production setups. Link to repositories containing deployment templates that automates deployment
-
-#### Setting up a development enviroment
-> Describe how to get a development enviroment up and running
-
-#### Deploying to production
-> Describe the different deployment methods for the project. Please adhere to the deployment standards recommended by OS2 when describing how to get the project running in production.
-
-#### 
-
-## :star: Examples
-
-> Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
+Dokumentationen er skrevet i Markdown og omdannet med [Jekyll](https://jekyllrb.com/)  
 
 ---
 
-*This project is licensed under the terms of the [LICENSE.md](LICENSE.md) | For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md) | Contact: [maintainer usernames]()*
-
+Contact: [kbp-di](https://github.com/kbp-di)*
 

PROJECT_CONTRIBUTING_TEMPLATE.md

@@ -1,8 +1,12 @@
-title: Just the Docs Template
-description: A starter template for a Jeykll site using the Just the Docs theme!
+title: OS2skoledata dokumentation
+description: Denne dokumentation har til formål at give et omfattende overblik over, hvordan man bruger, vedligeholder og fejlsøger OS2skoledata på en sikker og effektiv måde. Den skal klæde brugere, udviklere og administratorer på med den nødvendige viden til effektiv håndtering og langsigtet support.
 theme: just-the-docs
 
-url: https://just-the-docs.github.io
+url: https://os2skoledata.github.io/OS2skoledata-docs/
 
 aux_links:
-  Template Repository: https://github.com/just-the-docs/just-the-docs-template
+  github.com/os2skoledata: https://github.com/OS2skoledata/OS2skoledata
+  os2.eu/os2skoledata: https://www.os2.eu/os2skoledata
+
+plugins:
+  - jekyll-relative-links