Skip to content

Commit d976359

Browse files
Gerrit91Gerrit91
authored
Auto generate first release (#73)
1 parent e3b876f commit d976359

File tree

378 files changed

+31080
-1755
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

378 files changed

+31080
-1755
lines changed

‎.github/release-drafter.yml‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
name-template: 'v$RESOLVED_VERSION'
2+
tag-template: 'v$RESOLVED_VERSION'
3+
4+
template: |
5+
## General Changes
6+
7+
$CHANGES
8+
9+
categories:
10+
- title: '🚀 Features'
11+
labels:
12+
- 'feature'
13+
- 'enhancement'
14+
- title: '🐛 Bug Fixes'
15+
labels:
16+
- 'fix'
17+
- 'bugfix'
18+
- 'bug'
19+
20+
version-resolver:
21+
major:
22+
labels:
23+
- 'major'
24+
minor:
25+
labels:
26+
- 'minor'
27+
patch:
28+
labels:
29+
- 'patch'
30+
default: patch

‎.github/workflows/auto_generate.yaml‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
name: Auto Generate
2+
3+
on:
4+
push:
5+
branches:
6+
- auto-generate/*
7+
8+
jobs:
9+
auto-generate:
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: checkout
13+
uses: actions/checkout@v5
14+
15+
- name: setup-bun
16+
uses: oven-sh/setup-bun@v2
17+
with:
18+
bun-version: v1.2
19+
20+
- name: Build Website
21+
run: |
22+
bun install
23+
bun run fetch-readmes
24+
bun run create-release-notes
25+
26+
version=$(jq -r '.version' src/version.json)
27+
jq "del(.[] | select(. == \"${version}\"))" versions.json > versions.json.tmp && mv versions.json.tmp versions.json
28+
bun run docusaurus docs:version ${version}
29+
env:
30+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
31+
32+
- name: Push
33+
run: |
34+
bun run optimize:svg
35+
36+
if ! git diff --exit-code; then
37+
git config --global user.name "auto-build"
38+
git config --global user.email "info@metal-stack.io"
39+
git add .
40+
git commit -m "Auto generate"
41+
git push
42+
fi

‎.github/workflows/build.yaml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,14 +8,14 @@ on:
88
- main
99

1010
jobs:
11-
build-docs:
11+
build-docs:
1212
name: build-docs
1313
runs-on: ubuntu-latest
1414
steps:
15-
- name: checkout
16-
uses: actions/checkout@v4
15+
- name: checkout
16+
uses: actions/checkout@v5
1717

18-
- name: setup-bun
18+
- name: setup-bun
1919
uses: oven-sh/setup-bun@v2
2020
with:
2121
bun-version: v1.2
@@ -24,4 +24,4 @@ jobs:
2424
run: bun install --frozen-lockfile --production --ignore-scripts
2525

2626
- name: Build Website
27-
run: bun run build
27+
run: bun run build

‎.github/workflows/release-drafter.yaml‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
name: Release Drafter Action
3+
4+
on:
5+
push:
6+
branches:
7+
- main
8+
9+
jobs:
10+
build:
11+
runs-on: ubuntu-latest
12+
steps:
13+
- uses: release-drafter/release-drafter@v6
14+
env:
15+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎CODEOWNERS‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
* @metal-stack/docs-maintainers
2+
* @metal-stack/website-maintainers

‎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) 2020 The metal-stack Authors
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: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Docs-New
1+
# website
22

33
[![Netlify Status](https://api.netlify.com/api/v1/badges/f42ce2b4-45f8-4a11-9555-5a25f7a5e2aa/deploy-status)](https://app.netlify.com/projects/docs-new/deploys)
44

5-
This repository contains a PoC of how the documentation of [metal-stack.io](https://metal-stack.io) can be refactored to meet new requirements.
5+
This repository contains the website including the documentation of [metal-stack.io](https://metal-stack.io).
66

77
The used framework to generate docs is [docusaurus](https://docusaurus.io).
88

@@ -35,6 +35,21 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
3535
└── versions.json # list of versions
3636
```
3737

38+
### How to organize the docs?
39+
40+
- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.
41+
- Use the `general` section to distribute users to their sections or to the deeper concept.
42+
- user, operator or developer specific sections would be nice, but are optional.
43+
44+
#### Example
45+
46+
- Roles and Permissions
47+
- Concept: explains all roles, permissions and sessions
48+
- For operators: OIDC, creation in CI, ... How to / Explanation
49+
- For users: how to guide to create tokens and edit permissions
50+
- General: base concept, links to How to guides and deeper Concept
51+
- CISO / Compliance: minimal need to know Principle Explanation / Concept
52+
3853
## Backwards-Compatibility
3954

4055
In order to not break links of posts, blog articles and shared documents we want to provide full backwards-compatibility.
@@ -141,7 +156,7 @@ All components are referenced in the `/scripts/components.json` file. Use this m
141156
"name": "metalctl", // name of the component, will appear in the navigation
142157
"releasePath": "binaries.metal-stack.metalctl.version", // json-path of the version or tag in the release-vector
143158
"branch": "main", // branch name. Some old repositories use 'master'
144-
"repo": "metal-stack/metalctl", // component repository,
159+
"repo": "metal-stack/metalctl", // component repository,
145160
"tag": "v0.18.1", // latest release tag of the component repository
146161
"position": 1, // use this property to sort the navigation subdirectories
147162
"withDocs": true // set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved.

0 commit comments

Comments
 (0)