You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-15Lines changed: 20 additions & 15 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,7 +8,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
8
8
9
9
## Structure
10
10
11
-
```
11
+
```plain
12
12
├── blog # blogs folder structured by year
13
13
│ ├── 2019
14
14
│ ├── 2021
@@ -35,7 +35,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
35
35
└── versions.json # list of versions
36
36
```
37
37
38
-
### How to organize the docs?
38
+
### How to Organize the Docs?
39
39
40
40
- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.
41
41
- Use the `general` section to distribute users to their sections or to the deeper concept.
@@ -65,7 +65,7 @@ In order to add new docs you need to be aware of 2 cases:
65
65
66
66
If you want to have your new document in the root-folder of the scope just add it with the following format:
67
67
68
-
```
68
+
```yaml
69
69
---
70
70
slug: /your-doc-url
71
71
title: Title of document
@@ -102,7 +102,7 @@ For this we have a pre-commit hook, which optimizes them with [svgo](https://git
102
102
103
103
In order to add a blog-post follow this template. If a new author is referenced you have to add the author to the `authors.yaml`.
104
104
105
-
```
105
+
```yaml
106
106
---
107
107
title: Your Title
108
108
watermark: "Blog"
@@ -130,28 +130,29 @@ Requires Bun as .js runtime.
130
130
131
131
Run the following command to install dependencies:
132
132
133
-
```
133
+
```bash
134
134
bun install
135
135
```
136
136
137
137
To generate a local preview use:
138
138
139
-
```
139
+
```bash
140
140
bun run start
141
141
```
142
142
143
143
To update the dependencies for the Reference pages:
144
144
145
-
```
145
+
```bash
146
146
bun run fetch-readmes
147
147
```
148
148
149
-
## Component references
149
+
## Component References
150
+
150
151
Ensure first, that all files in the docs folder are updated and ready to freeze. Also execute `bun run fetch-readmes` to update files from components and apis with the release-vector file from the main branch.
151
152
It is also possible to use `bun run fetch-readmes v0.20.8` to use the release-vector file with a specific tag (i.E. v0.20.8).
152
153
All components are referenced in the `/scripts/components.json` file. Use this minimal template to add a new component:
153
154
154
-
```json
155
+
```jsonc
155
156
{
156
157
"name":"metalctl", // name of the component, will appear in the navigation
157
158
"releasePath":"binaries.metal-stack.metalctl.version", // json-path of the version or tag in the release-vector
@@ -160,7 +161,7 @@ All components are referenced in the `/scripts/components.json` file. Use this m
160
161
"tag":"v0.18.1", // latest release tag of the component repository
161
162
"position":1, // use this property to sort the navigation subdirectories
162
163
"withDocs":true// set to true to retrieve further .md files from a /docs folder. With false, only the README.md will be retrieved.
163
-
},
164
+
}
164
165
```
165
166
166
167
The `tag` property will be updated automatically from the release-vector file.
@@ -169,17 +170,21 @@ The `tag` property will be updated automatically from the release-vector file.
169
170
170
171
You create a new version with:
171
172
172
-
```
173
+
```bash
173
174
bun run docusaurus docs:version v0.21.6
174
175
```
175
176
176
177
Now, the new version will be create and the latest files will be copied to the "`versioned`" folders.
177
178
179
+
This, however, is usually done by the metal-robot through an automatically generated pull request.
180
+
178
181
## Release Notes
179
-
The release notes can be synced from GitHub with the GitHub API. Therefore, ensure that a valid access token is created and set on the GitHub Runner or local machine with the name `GH_RELEASE_TOKEN`.
180
182
181
-
To run the synchronization, run the following commmand:
182
-
```
183
+
The release notes can be synced from GitHub with the GitHub API. Therefore, ensure that a valid access token is created and set on the GitHub Runner or local machine with the name `GITHUB_TOKEN`.
184
+
185
+
To run the synchronization, run the following command:
186
+
187
+
```bash
183
188
bun run create-release-notes
184
189
```
185
-
If you run this before the build step, also the release notes get indexed.
190
+
If you run this before the build step, also the release notes get indexed.
0 commit comments