Skip to content

Commit 529e32e

Browse files
authored
Minor updates on README.md (#78)
1 parent 74a2a8e commit 529e32e

File tree

1 file changed

+20
-15
lines changed

1 file changed

+20
-15
lines changed

README.md

Lines changed: 20 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ The used framework to generate docs is [docusaurus](https://docusaurus.io).
88

99
## Structure
1010

11-
```
11+
```plain
1212
├── blog # blogs folder structured by year
1313
│   ├── 2019
1414
│   ├── 2021
@@ -35,7 +35,7 @@ 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?
38+
### How to Organize the Docs?
3939

4040
- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.
4141
- 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:
6565

6666
If you want to have your new document in the root-folder of the scope just add it with the following format:
6767

68-
```
68+
```yaml
6969
---
7070
slug: /your-doc-url
7171
title: Title of document
@@ -102,7 +102,7 @@ For this we have a pre-commit hook, which optimizes them with [svgo](https://git
102102

103103
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`.
104104

105-
```
105+
```yaml
106106
---
107107
title: Your Title
108108
watermark: "Blog"
@@ -130,28 +130,29 @@ Requires Bun as .js runtime.
130130

131131
Run the following command to install dependencies:
132132

133-
```
133+
```bash
134134
bun install
135135
```
136136

137137
To generate a local preview use:
138138

139-
```
139+
```bash
140140
bun run start
141141
```
142142

143143
To update the dependencies for the Reference pages:
144144

145-
```
145+
```bash
146146
bun run fetch-readmes
147147
```
148148

149-
## Component references
149+
## Component References
150+
150151
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.
151152
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).
152153
All components are referenced in the `/scripts/components.json` file. Use this minimal template to add a new component:
153154

154-
```json
155+
```jsonc
155156
{
156157
"name": "metalctl", // name of the component, will appear in the navigation
157158
"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
160161
"tag": "v0.18.1", // latest release tag of the component repository
161162
"position": 1, // use this property to sort the navigation subdirectories
162163
"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+
}
164165
```
165166

166167
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.
169170

170171
You create a new version with:
171172

172-
```
173+
```bash
173174
bun run docusaurus docs:version v0.21.6
174175
```
175176

176177
Now, the new version will be create and the latest files will be copied to the "`versioned`" folders.
177178

179+
This, however, is usually done by the metal-robot through an automatically generated pull request.
180+
178181
## 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`.
180182

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
183188
bun run create-release-notes
184189
```
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

Comments
 (0)