Skip to content

Commit 833c287

Browse files
andreasDroidandreasDroid
authored
Initial commit
0 parents  commit 833c287

10 files changed

Lines changed: 317 additions & 0 deletions

File tree

‎.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.

‎README.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Documentation template for OS2 projects
2+
3+
## 🏗️ Getting started
4+
5+
This is a *bare-minimum* template to create a [Jekyll][Jekyll] site that:
6+
7+
- uses the [Just the Docs][Just the Docs] theme;
8+
- can be built and published on [GitHub Pages][GitHub Pages];
9+
- can be built and previewed locally, and published on other platforms.
10+
11+
[Browse documentation][Just the Docs] to learn more about how to use this theme.
12+
13+
Documentation in OS2 products must follow the documentation criteria from the [Standard for Public Code](https://standard.publiccode.net/)
14+
15+
1. [Document your codebase objectives](https://standard.publiccode.net/criteria/document-codebase-objectives.html)
16+
2. [Document the Code](https://standard.publiccode.net/criteria/document-the-code.html)
17+
18+
Following these criteria not only opens up our codebase and fosters collaboration and transparency, but also encourages more organizations to use and adapt our open source products.
19+
20+
## Contributing
21+
Feel free to contribute, suggest an issue or submit a pull request with your improvements to this template.
22+
23+
## Licensing and Attribution
24+
25+
This repository is licensed under the [MIT License][MIT License]. You are generally free to reuse or extend upon this code as you see fit; just include the original copy of the license (which is preserved when you "make a template"). While it's not necessary, we'd love to hear from you if you do use this template, and how we can improve it for future use!
26+
27+
The deployment GitHub Actions workflow is heavily based on GitHub's mixed-party [starter workflows][starter workflows]. A copy of their MIT License is available in [actions/starter-workflows][actions/starter-workflows].
28+
29+
---
30+
31+
[Jekyll]: https://jekyllrb.com
32+
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
33+
[GitHub Pages]: https://docs.github.com/en/pages
34+
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
35+
[Bundler]: https://bundler.io
36+
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate
37+
[`jekyll-default-layout`]: https://github.com/benbalter/jekyll-default-layout
38+
[`jekyll-seo-tag`]: https://jekyll.github.io/jekyll-seo-tag
39+
[MIT License]: https://en.wikipedia.org/wiki/MIT_License
40+
[starter workflows]: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml
41+
[actions/starter-workflows]: https://github.com/actions/starter-workflows/blob/main/LICENSE
42+
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).

‎_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

‎index.md‎

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
title: Home
3+
layout: home
4+
---
5+
6+
This is a *bare-minimum* template to create a Jekyll site that uses the [Just the Docs] theme. You can easily set the created site to be published on [GitHub Pages] – the [README] file explains how to do that, along with other details.
7+
8+
If [Jekyll] is installed on your computer, you can also build and preview the created site *locally*. This lets you test changes before committing them, and avoids waiting for GitHub Pages.[^1] And you will be able to deploy your local build to a different platform than GitHub Pages.
9+
10+
More specifically, the created site:
11+
12+
- uses a gem-based approach, i.e. uses a `Gemfile` and loads the `just-the-docs` gem
13+
- uses the [GitHub Pages / Actions workflow] to build and publish the site on GitHub Pages
14+
15+
Other than that, you're free to customize sites that you create with this template, however you like. You can easily change the versions of `just-the-docs` and Jekyll it uses, as well as adding further plugins.
16+
17+
[Browse our documentation][Just the Docs] to learn more about how to use this theme.
18+
19+
To get started with creating a site, simply:
20+
21+
1. click "[use this template]" to create a GitHub repository
22+
2. go to Settings > Pages > Build and deployment > Source, and select GitHub Actions
23+
24+
If you want to maintain your docs in the `docs` directory of an existing project repo, see [Hosting your docs from an existing project repo](https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md#hosting-your-docs-from-an-existing-project-repo) in the template README.
25+
26+
----
27+
28+
[^1]: [It can take up to 10 minutes for changes to your site to publish after you push the changes to GitHub](https://docs.github.com/en/pages/setting-up-a-github-pages-site-with-jekyll/creating-a-github-pages-site-with-jekyll#creating-your-site).
29+
30+
[Just the Docs]: https://just-the-docs.github.io/just-the-docs/
31+
[GitHub Pages]: https://docs.github.com/en/pages
32+
[README]: https://github.com/just-the-docs/just-the-docs-template/blob/main/README.md
33+
[Jekyll]: https://jekyllrb.com
34+
[GitHub Pages / Actions workflow]: https://github.blog/changelog/2022-07-27-github-pages-custom-github-actions-workflows-beta/
35+
[use this template]: https://github.com/just-the-docs/just-the-docs-template/generate

0 commit comments

Comments
 (0)