Skip to content

Commit 1652bef

Browse files
janhalenjanhalen
authored
Initial commit
0 parents  commit 1652bef

13 files changed

+459
-0
lines changed

‎.github/dependabot.yml

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: bundler
4+
directory: /
5+
schedule:
6+
interval: "weekly"
7+
allow:
8+
- dependency-type: direct
9+
10+
- package-ecosystem: "github-actions"
11+
directory: "/"
12+
schedule:
13+
# Check for updates to GitHub Actions every week
14+
interval: "weekly"

‎.github/workflows/ci.yml

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches: ["main"]
6+
pull_request:
7+
8+
jobs:
9+
# Build job
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- name: Checkout
14+
uses: actions/checkout@v4
15+
- name: Setup Ruby
16+
uses: ruby/setup-ruby@v1
17+
with:
18+
ruby-version: '3.3' # Not needed with a .ruby-version file
19+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
20+
cache-version: 0 # Increment this number if you need to re-download cached gems
21+
- name: Build with Jekyll
22+
run: bundle exec jekyll build

‎.github/workflows/pages.yml

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
# This workflow uses actions that are not certified by GitHub.
2+
# They are provided by a third-party and are governed by
3+
# separate terms of service, privacy policy, and support
4+
# documentation.
5+
6+
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
7+
name: Deploy Jekyll site to Pages
8+
9+
on:
10+
push:
11+
branches: ["testing"]
12+
13+
# Allows you to run this workflow manually from the Actions tab
14+
workflow_dispatch:
15+
16+
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
17+
permissions:
18+
contents: read
19+
pages: write
20+
id-token: write
21+
22+
# Allow one concurrent deployment
23+
concurrency:
24+
group: "pages"
25+
cancel-in-progress: true
26+
27+
jobs:
28+
# Build job
29+
build:
30+
runs-on: ubuntu-latest
31+
steps:
32+
- name: Checkout
33+
uses: actions/checkout@v4
34+
- name: Setup Ruby
35+
uses: ruby/setup-ruby@v1
36+
with:
37+
ruby-version: '3.1' # Not needed with a .ruby-version file
38+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
39+
cache-version: 0 # Increment this number if you need to re-download cached gems
40+
- name: Setup Pages
41+
id: pages
42+
uses: actions/configure-pages@v5
43+
- name: Build with Jekyll
44+
# Outputs to the './_site' directory by default
45+
run: bundle exec jekyll build --baseurl "${{ steps.pages.outputs.base_path }}"
46+
env:
47+
JEKYLL_ENV: production
48+
- name: Upload artifact
49+
# Automatically uploads an artifact from the './_site' directory by default
50+
uses: actions/upload-pages-artifact@v3
51+
52+
# Deployment job
53+
deploy:
54+
environment:
55+
name: github-pages
56+
url: ${{ steps.deployment.outputs.page_url }}
57+
runs-on: ubuntu-latest
58+
needs: build
59+
steps:
60+
- name: Deploy to GitHub Pages
61+
id: deployment
62+
uses: actions/deploy-pages@v4

‎.gitignore

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# Not sure what a .gitignore is?
2+
# See: https://git-scm.com/docs/gitignore
3+
4+
# These are directly copied from Jekyll's first-party docs on `.gitignore` files:
5+
# https://jekyllrb.com/tutorials/using-jekyll-with-bundler/#commit-to-source-control
6+
7+
# Ignore the default location of the built site, and caches and metadata generated by Jekyll
8+
_site/
9+
.sass-cache/
10+
.jekyll-cache/
11+
.jekyll-metadata
12+
13+
# Ignore folders generated by Bundler
14+
.bundle/
15+
vendor/

‎Gemfile

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
source 'https://rubygems.org'
2+
3+
gem "jekyll", "~> 4.3.4" # installed by `gem jekyll`
4+
# gem "webrick" # required when using Ruby >= 3 and Jekyll <= 4.2.2
5+
6+
gem "just-the-docs", "0.10.0" # pinned to the current release
7+
# gem "just-the-docs" # always download the latest release

‎Gemfile.lock

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
GEM
2+
remote: https://rubygems.org/
3+
specs:
4+
addressable (2.8.7)
5+
public_suffix (>= 2.0.2, < 7.0)
6+
bigdecimal (3.1.8)
7+
colorator (1.1.0)
8+
concurrent-ruby (1.3.4)
9+
em-websocket (0.5.3)
10+
eventmachine (>= 0.12.9)
11+
http_parser.rb (~> 0)
12+
eventmachine (1.2.7)
13+
ffi (1.17.0-arm64-darwin)
14+
ffi (1.17.0-x86_64-linux-gnu)
15+
forwardable-extended (2.6.0)
16+
google-protobuf (4.28.2-arm64-darwin)
17+
bigdecimal
18+
rake (>= 13)
19+
google-protobuf (4.28.2-x86_64-linux)
20+
bigdecimal
21+
rake (>= 13)
22+
http_parser.rb (0.8.0)
23+
i18n (1.14.6)
24+
concurrent-ruby (~> 1.0)
25+
jekyll (4.3.4)
26+
addressable (~> 2.4)
27+
colorator (~> 1.0)
28+
em-websocket (~> 0.5)
29+
i18n (~> 1.0)
30+
jekyll-sass-converter (>= 2.0, < 4.0)
31+
jekyll-watch (~> 2.0)
32+
kramdown (~> 2.3, >= 2.3.1)
33+
kramdown-parser-gfm (~> 1.0)
34+
liquid (~> 4.0)
35+
mercenary (>= 0.3.6, < 0.5)
36+
pathutil (~> 0.9)
37+
rouge (>= 3.0, < 5.0)
38+
safe_yaml (~> 1.0)
39+
terminal-table (>= 1.8, < 4.0)
40+
webrick (~> 1.7)
41+
jekyll-include-cache (0.2.1)
42+
jekyll (>= 3.7, < 5.0)
43+
jekyll-sass-converter (3.0.0)
44+
sass-embedded (~> 1.54)
45+
jekyll-seo-tag (2.8.0)
46+
jekyll (>= 3.8, < 5.0)
47+
jekyll-watch (2.2.1)
48+
listen (~> 3.0)
49+
just-the-docs (0.10.0)
50+
jekyll (>= 3.8.5)
51+
jekyll-include-cache
52+
jekyll-seo-tag (>= 2.0)
53+
rake (>= 12.3.1)
54+
kramdown (2.4.0)
55+
rexml
56+
kramdown-parser-gfm (1.1.0)
57+
kramdown (~> 2.0)
58+
liquid (4.0.4)
59+
listen (3.9.0)
60+
rb-fsevent (~> 0.10, >= 0.10.3)
61+
rb-inotify (~> 0.9, >= 0.9.10)
62+
mercenary (0.4.0)
63+
pathutil (0.16.2)
64+
forwardable-extended (~> 2.6)
65+
public_suffix (6.0.1)
66+
rake (13.2.1)
67+
rb-fsevent (0.11.2)
68+
rb-inotify (0.11.1)
69+
ffi (~> 1.0)
70+
rexml (3.3.8)
71+
rouge (4.4.0)
72+
safe_yaml (1.0.5)
73+
sass-embedded (1.79.4-arm64-darwin)
74+
google-protobuf (~> 4.27)
75+
sass-embedded (1.79.4-x86_64-linux-gnu)
76+
google-protobuf (~> 4.27)
77+
terminal-table (3.0.2)
78+
unicode-display_width (>= 1.1.1, < 3)
79+
unicode-display_width (2.6.0)
80+
webrick (1.8.2)
81+
82+
PLATFORMS
83+
arm64-darwin-23
84+
x86_64-linux
85+
86+
DEPENDENCIES
87+
jekyll (~> 4.3.4)
88+
just-the-docs (= 0.10.0)
89+
90+
BUNDLED WITH
91+
2.3.26

‎LICENSE

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
MIT License
2+
3+
Copyright (c) 2022 just-the-docs
4+
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
11+
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
14+
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎MAINTAINERS.md

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# Maintainers
2+
3+
This document provides information about the maintainers of the project, their roles, and how to engage with them.
4+
5+
## Current Maintainers
6+
7+
| Name | GitHub Username | Role/Responsibilities | Contact Method |
8+
|-----------------|----------------------|-----------------------------------------|-------------------------|
9+
| [Maintainer 1] | [@username1](https://github.com/username1) | [Role/Responsibility] | [email@example.com] |
10+
| [Maintainer 2] | [@username2](https://github.com/username2) | [Role/Responsibility] | [email@example.com] |
11+
| [Maintainer 3] | [@username3](https://github.com/username3) | [Role/Responsibility] | [email@example.com] |
12+
13+
## Emeritus Maintainers
14+
15+
| Name | GitHub Username | Role/Responsibilities | Contact Method |
16+
|-----------------|----------------------|-----------------------------------------|-------------------------|
17+
| [Emeritus 1] | [@emeritus1](https://github.com/emeritus1) | [Previous Role/Responsibility] | [email@example.com] |
18+
19+
## Becoming a Maintainer
20+
21+
To become a maintainer of this project, please follow these steps:
22+
23+
1. **Contribute**: Actively contribute to the project by submitting pull requests and participating in discussions.
24+
2. **Engagement**: Engage with the community and maintainers through issues and discussions.
25+
3. **Request**: Once you feel ready, request maintainer status by opening an issue or contacting an existing maintainer.
26+
27+
## Removal Process
28+
29+
Maintainers may be removed or moved to emeritus status under the following circumstances:
30+
31+
- Inactivity for an extended period (e.g., 6 months).
32+
- Failure to respond to issues or pull requests.
33+
- Request for removal by the maintainer.
34+
35+
Maintainers can be removed through a consensus among current maintainers.
36+
37+
---
38+
39+
*For any questions or concerns regarding maintainership, please reach out to any of the current maintainers listed above.*

‎PROJECT_CONTRIBUTING_TEMPLATE.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Contributing to OS2 Documentation
2+
3+
Contributors to the documentation can be project managers, technical editors, developers, and end-users. We welcome all contributions that help improve our documentation.
4+
5+
To ensure our documentation stays resilient and up-to-date, we employ the use of the open practice of [Docs As Code](https://openpracticelibrary.com/practice/docs-as-code/) and the open [Markdown](https://en.wikipedia.org/wiki/Markdown) format for ease of collaboration and quality control.
6+
7+
To promote digital sovereignty, interoperability, reuse, transparency and resillience, we adhere to the [Standard for Public Code](https://standard.publiccode.net/), a framework maintained by the [Foundation for Public Code](https://publiccode.net/who-we-are/).
8+
`<br>`
9+
`<br>`
10+
11+
## 🚀 Quick start
12+
13+
1. Start by writing a README following the simple criteria in the above guides from Standard for Public Code. For at fast and simple way to accomplish this, you can fill out the placeholders in the PROJECT_README_TEMPLATE.md and [rename it](https://docs.github.com/en/repositories/working-with-files/managing-files/renaming-a-file) to README.md, replacing the Quick start guide for this template with your projects information.
14+
2. Follow the criteria from [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html), [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html) and [Document codebase Maturity]()
15+
in one or several text documents using the Markdown format.
16+
3. Document further suggestions and improvements by [raising issues](https://docs.github.com/en/issues/tracking-your-work-with-issues/about-issues) and describing what needs to be fixed, describe the user stories and potential delivered values.
17+
4. Participate in issue discussions to help reach the correct resolutions. If you have the required knowledge about a part of the project, suggest yourself as an [assignee to the issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/assigning-issues-and-pull-requests-to-other-github-users#about-issue-and-pull-request-assignees).
18+
5. Collaborate on documentation branches with issues assigned to you by the maintainers.
19+
20+
> 📚 Read more about:
21+
>
22+
> How to use [Markdown](https://www.writethedocs.org/guide/writing/markdown/) to collaborate on documentation
23+
> How [Just the Docs](https://just-the-docs.github.io/just-the-docs/) is used to generate a documentation site from your markdown files.

‎README.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
> [!IMPORTANT]
2+
> *Remove this section from your README.md after completing all setup tasks!*
3+
> - [ ] Click the green "Use this template" button above.
4+
> - [ ] Name your new repository and create it.
5+
> - [ ] Replace all the grey placeholder texts with your project-specific information.
6+
> - [ ] Add any additional relevant Markdown documents to your documentation.
7+
> - [ ] Configure a [publishing source for GitHub Pages](https://help.github.com/en/articles/configuring-a-publishing-source-for-github-pages).
8+
> - [ ] **Remove this setup section from your README.md.**
9+
>
10+
> *That's it! You are now set up, and your documentation site is live!*
11+
12+
13+
# [Replace with Project Title]
14+
> Replace this subtitle section with a clear statement defining the mission and goals of your project in a few simple terms.
15+
16+
[How It Works](#🧭-how-it-works) | [Architecture](#architecture) | [ How to Install and Run](#▶️-how-to-install-and-run)
17+
18+
## 🧭 How It Works
19+
> Replace with a brief, clear explanation of how the codebase works to achieve the stated mission objectives.
20+
21+
#### Architecture
22+
23+
> Replace with a Brief introduction to the project's high-level architecture. Link to the architecture documentation with a diagram preferably in mermaid syntax.
24+
[ARCHITECTURE.MD](./docs/ARCHITECTURE.MD)
25+
26+
#### Key Features
27+
28+
> Replace this with a brief explaination of the main features or functionalities of your project.
29+
30+
## ▶️ How to Install and Run
31+
> 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
32+
33+
#### Setting up a development enviroment
34+
> Describe how to get a development enviroment up and running
35+
36+
#### Deploying to production
37+
> 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.
38+
39+
####
40+
41+
## :star: Examples
42+
43+
> Replace with examples demonstrating key functionality, code-snippets such as command-line usage, API calls or if needed screendumps
44+
45+
---
46+
47+
*This project is licensed under the terms of the [LICENSE.md](LICENSE.md) | For contribution guidelines, see [CONTRIBUTING.md](CONTRIBUTING.md) | Contact: [maintainer usernames]()*
48+
49+

‎_config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
title: Just the Docs Template
2+
description: A starter template for a Jeykll site using the Just the Docs theme!
3+
theme: just-the-docs
4+
5+
url: https://just-the-docs.github.io
6+
7+
aux_links:
8+
Template Repository: https://github.com/just-the-docs/just-the-docs-template

0 commit comments

Comments
 (0)