Skip to content

Commit b060a4d

Browse files
author
Serap Aydin
committed
- release notes geupdated
- Dokumentation: https://wiki.gecko.hs-heilbronn.de/doc/dokumentation-release-notes-script-45Ex3hoxjB - neue News post - Reorganisation von API v1 und Api v2 Concepts als Sidebar - PP Validator - hinzufügen von Assets und Bilder - Reverse proxy verlinkung gefixt - Root Ca verlinkt unter Install.md Client Server Cert - Ping Pong 2 bild hinzugefügt unter Explore PP - events seite geupdated - WIPs entfernt - Versucht neues Layout/ Komponente zu erstellen --> News list
1 parent 140dd15 commit b060a4d

Some content is hidden

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

51 files changed

+788
-1121
lines changed

docs/src/.vuepress/client.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,6 @@ export default defineClientConfig({
88
layouts: {
99
ParentLayout,
1010
Layout,
11-
NotFound: NotFoundLayout
11+
NotFound: NotFoundLayout,
1212
},
1313
})
Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
<script setup lang="ts">
2+
import { computed } from "vue";
3+
import { useArticles } from "vuepress-theme-hope/composables/blog/useArticles";
4+
5+
type ArticleInfo = {
6+
title: string;
7+
path: string;
8+
date?: Date;
9+
excerpt?: string;
10+
category?: string[];
11+
tag?: string[];
12+
sticky?: boolean;
13+
cover?: string;
14+
isEncrypted?: boolean;
15+
};
16+
17+
const props = defineProps<{ count?: number }>();
18+
const displayCount = computed(() => props.count ?? 5);
19+
20+
const articlesMap = useArticles();
21+
22+
23+
const sortedArticles = computed(() => {
24+
const allArticles: ArticleInfo[] = Object.values(articlesMap.value).flat();
25+
26+
return allArticles
27+
.filter((a) => a.date) // optional
28+
.sort((a, b) => new Date(b.date!).getTime() - new Date(a.date!).getTime());
29+
});
30+
</script>
31+
32+
<template>
33+
<div class="news-list">
34+
<h2> Latest News</h2>
35+
<p v-if="sortedArticles.length === 0"> No articles found.</p>
36+
<ul>
37+
<li v-for="article in sortedArticles.slice(0, displayCount)" :key="article.path">
38+
<RouterLink :to="article.path">
39+
{{ article.title }} — {{ article.date?.toLocaleDateString?.() }}
40+
</RouterLink>
41+
</li>
42+
</ul>
43+
</div>
44+
</template>
45+
270 KB
Loading
554 KB
Loading
2.22 MB
Loading

docs/src/.vuepress/sidebar/fetch-versioned-release-notes.sh

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
#!/bin/bash
22
# To run: chmod +x fetch-versioned-release-notes.sh && ./fetch-versioned-release-notes.sh
3+
# Dokumentation https://wiki.gecko.hs-heilbronn.de/doc/dokumentation-release-notes-script-45Ex3hoxjB
34

45
# GitHub repository details
56
REPO_OWNER="datasharingframework"
@@ -8,7 +9,7 @@ REPO_NAME="dsf"
89
# Output base directory (this will hold the versioned folders)
910
OUTPUT_BASE_DIR="../../operations"
1011

11-
# Define the range of versions (no extra dot after v)
12+
# Define the range of versions
1213
VERSIONS=("v1.0.0" "v1.1.0" "v1.2.0" "v1.3.0" "v1.3.1" "v1.3.2" "v1.4.0" "v1.5.0" "v1.5.1" "v1.5.2" "v1.6.0" "v1.7.0" "v1.7.1" "v1.8.0")
1314

1415
# Fetch all release details
@@ -29,14 +30,15 @@ for VERSION in "${VERSIONS[@]}"; do
2930

3031
OUTPUT_FILE="$VERSION_DIR/release-notes.md"
3132

32-
# Write frontmatter at the top of the Markdown file
33+
34+
# Write frontmatter at the top of the Markdown file
3335
cat <<EOF > "$OUTPUT_FILE"
3436
---
3537
title: Release Notes ($VERSION)
3638
icon: note
3739
---
3840
39-
## Release Notes for $VERSION
41+
## [Release Notes for $VERSION](https://github.com/$REPO_OWNER/$REPO_NAME/releases/tag/$VERSION)
4042
4143
::: tip Release Notes
4244
You can access all release notes on our [GitHub](https://github.com/datasharingframework/dsf/releases).
@@ -49,8 +51,16 @@ EOF
4951
RELEASE_BODY=$(echo "$RELEASE_JSON" | jq -r '.body')
5052
RELEASE_NAME=$(echo "$RELEASE_JSON" | jq -r '.name')
5153

54+
# Convert #issue_number to GitHub issue link
55+
RELEASE_BODY=$(echo "$RELEASE_BODY" | sed -E 's/#([0-9]+)/[#\1](https:\/\/github.com\/datasharingframework\/dsf\/issues\/\1)/g')
56+
57+
# Convert @username to GitHub user link
58+
RELEASE_BODY=$(echo "$RELEASE_BODY" | sed -E 's/@([a-zA-Z0-9_-]+)/[@\1](https:\/\/github.com\/\1)/g')
59+
60+
5261
echo "### $RELEASE_NAME" >> "$OUTPUT_FILE"
5362
echo "$RELEASE_BODY" >> "$OUTPUT_FILE"
63+
5464
echo "" >> "$OUTPUT_FILE"
5565
done
5666

docs/src/.vuepress/sidebar/operations-v1.ts

Lines changed: 64 additions & 66 deletions
Original file line numberDiff line numberDiff line change
@@ -7,16 +7,16 @@ export function generate_v1_latest_sidebar() {
77
link: "./",
88
},
99
"release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", {
10-
text: "FHIR Reverse Proxy",
11-
icon: "module",
12-
prefix: "fhir-reverse-proxy/",
13-
link: "fhir-reverse-proxy/",
14-
children: [{
15-
icon: "config",
16-
text: "Configuration",
17-
link: "configuration"
18-
}]
19-
}, {
10+
text: "FHIR Reverse Proxy",
11+
icon: "module",
12+
children: [
13+
{
14+
icon: "config",
15+
text: "Configuration",
16+
link: "fhir-reverse-proxy/configuration",
17+
}
18+
]},
19+
{
2020
text: "FHIR Server",
2121
icon: "module",
2222
prefix: "fhir/",
@@ -37,13 +37,13 @@ export function generate_v1_latest_sidebar() {
3737
}, {
3838
text: "BPE Reverse Proxy",
3939
icon: "module",
40-
prefix: "bpe-reverse-proxy/",
41-
link: "bpe-reverse-proxy/",
42-
children: [{
43-
icon: "config",
44-
text: "Configuration",
45-
link: "configuration"
46-
}]
40+
children: [
41+
{
42+
icon: "config",
43+
text: "Configuration",
44+
link: "bpe-reverse-proxy/configuration",
45+
}
46+
]
4747
}, {
4848
text: "BPE Server",
4949
icon: "module",
@@ -81,16 +81,16 @@ export function generate_v1_gt_eq_1_7_0_sidebar() {
8181

8282
},
8383
"release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", "root-certificates", "passwords-secrets", {
84-
text: "FHIR Reverse Proxy",
85-
icon: "module",
86-
prefix: "fhir-reverse-proxy/",
87-
link: "fhir-reverse-proxy/",
88-
children: [{
89-
icon: "config",
90-
text: "Configuration",
91-
link: "configuration"
92-
}]
93-
}, {
84+
text: "FHIR Reverse Proxy",
85+
icon: "module",
86+
children: [
87+
{
88+
icon: "config",
89+
text: "Configuration",
90+
link: "fhir-reverse-proxy/configuration",
91+
}
92+
]},
93+
{
9494
text: "FHIR Server",
9595
icon: "module",
9696
prefix: "fhir/",
@@ -111,13 +111,13 @@ export function generate_v1_gt_eq_1_7_0_sidebar() {
111111
}, {
112112
text: "BPE Reverse Proxy",
113113
icon: "module",
114-
prefix: "bpe-reverse-proxy/",
115-
link: "bpe-reverse-proxy/",
116-
children: [{
117-
icon: "config",
118-
text: "Configuration",
119-
link: "configuration"
120-
}]
114+
children: [
115+
{
116+
icon: "config",
117+
text: "Configuration",
118+
link: "bpe-reverse-proxy/configuration",
119+
}
120+
]
121121
}, {
122122
text: "BPE Server",
123123
icon: "module",
@@ -152,16 +152,15 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {
152152
icon: "tool",
153153
link: "./",
154154
}, "release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", {
155-
text: "FHIR Reverse Proxy",
156-
icon: "module",
157-
prefix: "fhir-reverse-proxy/",
158-
link: "fhir-reverse-proxy/",
159-
children: [{
160-
icon: "config",
161-
text: "Configuration",
162-
link: "configuration"
163-
}]
164-
}, {
155+
text: "FHIR Reverse Proxy",
156+
icon: "module",
157+
children: [
158+
{
159+
icon: "config",
160+
text: "Configuration",
161+
link: "fhir-reverse-proxy/configuration",
162+
}
163+
]}, {
165164
text: "FHIR Server",
166165
icon: "module",
167166
prefix: "fhir/",
@@ -182,13 +181,13 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {
182181
}, {
183182
text: "BPE Reverse Proxy",
184183
icon: "module",
185-
prefix: "bpe-reverse-proxy/",
186-
link: "bpe-reverse-proxy/",
187-
children: [{
188-
icon: "config",
189-
text: "Configuration",
190-
link: "configuration"
191-
}]
184+
children: [
185+
{
186+
icon: "config",
187+
text: "Configuration",
188+
link: "bpe-reverse-proxy/configuration",
189+
}
190+
]
192191
}, {
193192
text: "BPE Server",
194193
icon: "module",
@@ -217,33 +216,32 @@ export function generate_v1_gt_eq_1_5_0_sidebar() {
217216

218217
}
219218

220-
221219
export function generate_v1_gt_eq_1_0_0_sidebar() {
222220
return [
223-
224221
{
225222
text: "Get Started",
226223
icon: "tool",
227224
link: "./",
228225
}, "release-notes", "install", "upgrade-from-1", "upgrade-from-0", "allowList-mgm", {
229-
text: "FHIR Reverse Proxy",
230-
icon: "module",
231-
prefix: "fhir-reverse-proxy/",
232-
link: "fhir-reverse-proxy/",
233-
children: [{
234-
icon: "config",
235-
text: "Configuration",
236-
link: "configuration"
237-
}]
238-
}, {
226+
text: "FHIR Reverse Proxy",
227+
icon: "module",
228+
children: [
229+
{
230+
icon: "config",
231+
text: "Configuration",
232+
link: "fhir-reverse-proxy/configuration",
233+
}
234+
]},
235+
{
239236
text: "FHIR Server",
240237
icon: "module",
241238
prefix: "fhir/",
242239
link: "fhir/",
243240
children: [{
244-
icon: "config",
245-
text: "Configuration",
246-
link: "configuration"
241+
icon: "config",
242+
text: "Configuration",
243+
link: "configuration"
244+
247245
}, {
248246
icon: "config",
249247
text: "Access Control",

0 commit comments

Comments
 (0)