Skip to content

Commit ea90c12

Browse files
committed
initial commit: index.md, hugo[-book], and github actions
Signed-off-by: Thilo Fromm <[email protected]>
0 parents  commit ea90c12

File tree

9 files changed

+115
-0
lines changed

9 files changed

+115
-0
lines changed

.github/workflows/gh-pages.yml

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
name: GitHub Pages
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
jobs:
10+
deploy:
11+
if: github.repository == 'uapi-group/uapi-group.github.io'
12+
runs-on: ubuntu-22.04
13+
concurrency:
14+
group: ${{ github.workflow }}-${{ github.ref }}
15+
steps:
16+
- uses: actions/checkout@v3
17+
with:
18+
submodules: true
19+
fetch-depth: 0
20+
21+
- name: Setup Hugo
22+
uses: peaceiris/actions-hugo@v2
23+
with:
24+
hugo-version: '0.104.3'
25+
extended: true
26+
27+
- name: Build
28+
run: hugo --minify -d ../public
29+
30+
- name: Deploy
31+
uses: peaceiris/actions-gh-pages@v3
32+
if: ${{ github.ref == 'refs/heads/main' }}
33+
with:
34+
github_token: ${{ secrets.GITHUB_TOKEN }}
35+
publish_dir: ./public

.gitignore

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
public
2+
.hugo_build.lock
3+
resources/_gen

.gitmodules

+3
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[submodule "themes/hugo-book"]
2+
path = themes/hugo-book
3+
url = https://github.com/alex-shpak/hugo-book

README.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
# Static website generation for [www.]uapi-group.org
2+
3+
This repository uses Hugo for static HTML generation.
4+
See https://gohugo.io/getting-started/quick-start/ for a brief intro.
5+
6+
The website uses the [hugo-book](https://github.com/alex-shpak/hugo-book) theme; it is included in this repo as a git submodule.
7+
After cloning this repo please run `git submodule init; git submodule update`.
8+
If you check out a branch or tag, make sure the submodule is up to date by running `git submodule update`.
9+
10+
## Website repo layout
11+
12+
Content resides in the [content](content/) folder.
13+
The ([index](content/_index.md) page in that directory serves as central entry point to the org's website.
14+
15+
## Making changes and testing
16+
17+
You'll need [hugo installed](https://gohugo.io/getting-started/installing/) for rendering changes.
18+
19+
First, make your edits.
20+
Then, start hugo locally (in the repo's `website` directory)to review your changes:
21+
22+
```shell
23+
$ hugo server --minify --disableFastRender
24+
```
25+
26+
Review your changes at http://localhost:1313/specifications/ .

archetypes/default.md

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
title: "{{ replace .Name "-" " " | title }}"
3+
date: {{ .Date }}
4+
draft: true
5+
---
6+

assets/_variables.scss

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
$body-min-width: 20rem;
2+
$container-max-width: 110rem;
3+
4+
$menu-width: 15rem;
5+
$toc-width: 15rem;

config.toml

+10
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
baseURL = "https://uapi-group.org"
2+
languageCode = "en-us"
3+
title = "The Linux Userspace API Group"
4+
theme = "hugo-book"
5+
6+
[markup.goldmark.renderer]
7+
unsafe = true # Allow HTML in md files
8+
9+
[params]
10+
BookSearch = false

content/_index.md

+26
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
title: The Linux Userspace API (UAPI) group
3+
---
4+
5+
# The Linux Userspace API (UAPI) group
6+
7+
The userspace API ("uapi") group is a community for people with an interest in innovating how we build, deploy, and run modern Linux operating systems.
8+
It serves as a central gathering place for specs, documentation, and ideas.
9+
10+
Follow [@uapi-group](https://twitter.com/uapi_group) on twitter to catch the latest news!
11+
12+
## Generic documents, minutes, and glossary
13+
14+
Please find generic documents like meeting / summit minutes and a glossary of terms used across uapi-group documents at https://uapi-group.org/docs.
15+
16+
## UAPI Group Specifications
17+
18+
Submitted specifications are available at https://uapi-group.org/specifications.
19+
20+
See [open PRs on github](https://github.com/uapi-group/specifications/pulls) for work-in-progress specifications.
21+
22+
Please use the [specifications issue tracker](https://github.com/uapi-group/specifications/issues) to engage with the project.
23+
24+
## Kernel features wishlist
25+
26+
A collection of kernel features that, if implemented, would improve inter-operation of kernel and early / "plumbing level" is maintained here: https://github.com/uapi-group/kernel/blob/main/README.md.

themes/hugo-book

Submodule hugo-book added at 9e9c7d3

0 commit comments

Comments
 (0)