Skip to content

Commit 6e915da

Browse files
authored
Add User Docs and OpenDesk Application Example (#259)
* add new page for user docs Signed-off-by: Max Wolfs <mail@maxwolfs.com> * add opendesk docs Signed-off-by: Max Wolfs <mail@maxwolfs.com> * adjust links Signed-off-by: Max Wolfs <mail@maxwolfs.com> --------- Signed-off-by: Max Wolfs <mail@maxwolfs.com>
1 parent c8ef411 commit 6e915da

5 files changed

Lines changed: 70 additions & 2 deletions

File tree

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@
1919
/standards/*/*.md
2020
/standards/*/*.mdx
2121
/standards/scs-*.yaml
22+
/user-docs/application-examples
2223

2324
# Dependencies
2425
node_modules

docs.package.json

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -135,5 +135,11 @@
135135
"source": ["documentation/overview.md"],
136136
"target": "docs/turnkey-solution",
137137
"label": ""
138+
},
139+
{
140+
"repo": "SovereignCloudStack/opendesk-on-scs",
141+
"source": "docs/*",
142+
"target": "user-docs/application-examples",
143+
"label": "opendesk-on-scs"
138144
}
139145
]

docusaurus.config.js

Lines changed: 24 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,16 @@ const config = {
8181
// ... other options
8282
}
8383
],
84+
[
85+
'@docusaurus/plugin-content-docs',
86+
{
87+
id: 'user-docs',
88+
path: 'user-docs',
89+
routeBasePath: 'user-docs',
90+
sidebarPath: require.resolve('./sidebarsUserDocs.js')
91+
// ... other options
92+
}
93+
],
8494
[
8595
'@docusaurus/plugin-content-docs',
8696
{
@@ -120,6 +130,11 @@ const config = {
120130
label: 'For Contributors',
121131
position: 'left'
122132
},
133+
{
134+
to: '/user-docs',
135+
label: 'For Users',
136+
position: 'left'
137+
},
123138
{ to: '/community', label: 'Community', position: 'left' },
124139
{ to: '/docs/faq', label: 'FAQ', position: 'left' },
125140
{
@@ -194,12 +209,19 @@ const config = {
194209
// @ts-ignore
195210
({
196211
hashed: true,
197-
docsDir: ['docs', 'community', 'standards', 'contributor-docs'],
212+
docsDir: [
213+
'docs',
214+
'community',
215+
'standards',
216+
'contributor-docs',
217+
'user-docs'
218+
],
198219
docsRouteBasePath: [
199220
'docs',
200221
'community',
201222
'standards',
202-
'contributor-docs'
223+
'contributor-docs',
224+
'user-docs'
203225
]
204226
})
205227
]

sidebarsUserDocs.js

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
// @ts-check
2+
3+
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
4+
const sidebars = {
5+
userDocs: [
6+
'index',
7+
{
8+
type: 'category',
9+
label: 'Application Examples',
10+
items: [
11+
{
12+
type: 'category',
13+
label: 'OpenDesk on SCS',
14+
link: {
15+
type: 'generated-index'
16+
},
17+
items: [
18+
'application-examples/opendesk-on-scs/overview',
19+
'application-examples/opendesk-on-scs/quickstart',
20+
'application-examples/opendesk-on-scs/requirements',
21+
'application-examples/opendesk-on-scs/getting_started',
22+
'application-examples/opendesk-on-scs/configuration',
23+
'application-examples/opendesk-on-scs/user-import',
24+
'application-examples/opendesk-on-scs/contribute'
25+
]
26+
}
27+
]
28+
}
29+
]
30+
}
31+
32+
module.exports = sidebars

user-docs/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# Introduction
2+
3+
## Welcome to the User Documentation of the Sovereign Cloud Stack (SCS)
4+
5+
In this section, users will find helpful information and practical guides for working with SCS clouds. We provide insights into various application use cases, migration tutorials between different SCS cloud service providers, and showcase ways to communicate remotely with your cloud without a user interface.
6+
7+
Discover best practices to make the most of your cloud, from introductions to specific applications to advanced use cases. Stay tuned for upcoming content designed to simplify your cloud experience.

0 commit comments

Comments
 (0)