Skip to content

Commit

Permalink
Add User Docs and OpenDesk Application Example (#259)
Browse files Browse the repository at this point in the history
* 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>
  • Loading branch information
maxwolfs authored Oct 8, 2024
1 parent c8ef411 commit 6e915da
Show file tree
Hide file tree
Showing 5 changed files with 70 additions and 2 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
/standards/*/*.md
/standards/*/*.mdx
/standards/scs-*.yaml
/user-docs/application-examples

# Dependencies
node_modules
Expand Down
6 changes: 6 additions & 0 deletions docs.package.json
Original file line number Diff line number Diff line change
Expand Up @@ -135,5 +135,11 @@
"source": ["documentation/overview.md"],
"target": "docs/turnkey-solution",
"label": ""
},
{
"repo": "SovereignCloudStack/opendesk-on-scs",
"source": "docs/*",
"target": "user-docs/application-examples",
"label": "opendesk-on-scs"
}
]
26 changes: 24 additions & 2 deletions docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,16 @@ const config = {
// ... other options
}
],
[
'@docusaurus/plugin-content-docs',
{
id: 'user-docs',
path: 'user-docs',
routeBasePath: 'user-docs',
sidebarPath: require.resolve('./sidebarsUserDocs.js')
// ... other options
}
],
[
'@docusaurus/plugin-content-docs',
{
Expand Down Expand Up @@ -120,6 +130,11 @@ const config = {
label: 'For Contributors',
position: 'left'
},
{
to: '/user-docs',
label: 'For Users',
position: 'left'
},
{ to: '/community', label: 'Community', position: 'left' },
{ to: '/docs/faq', label: 'FAQ', position: 'left' },
{
Expand Down Expand Up @@ -194,12 +209,19 @@ const config = {
// @ts-ignore
({
hashed: true,
docsDir: ['docs', 'community', 'standards', 'contributor-docs'],
docsDir: [
'docs',
'community',
'standards',
'contributor-docs',
'user-docs'
],
docsRouteBasePath: [
'docs',
'community',
'standards',
'contributor-docs'
'contributor-docs',
'user-docs'
]
})
]
Expand Down
32 changes: 32 additions & 0 deletions sidebarsUserDocs.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
userDocs: [
'index',
{
type: 'category',
label: 'Application Examples',
items: [
{
type: 'category',
label: 'OpenDesk on SCS',
link: {
type: 'generated-index'
},
items: [
'application-examples/opendesk-on-scs/overview',
'application-examples/opendesk-on-scs/quickstart',
'application-examples/opendesk-on-scs/requirements',
'application-examples/opendesk-on-scs/getting_started',
'application-examples/opendesk-on-scs/configuration',
'application-examples/opendesk-on-scs/user-import',
'application-examples/opendesk-on-scs/contribute'
]
}
]
}
]
}

module.exports = sidebars
7 changes: 7 additions & 0 deletions user-docs/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Introduction

## Welcome to the User Documentation of the Sovereign Cloud Stack (SCS)

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.

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 comments on commit 6e915da

Please sign in to comment.