diff --git a/.gitignore b/.gitignore index 1a579d47f2..7e5055d4ce 100644 --- a/.gitignore +++ b/.gitignore @@ -19,6 +19,7 @@ /standards/*/*.md /standards/*/*.mdx /standards/scs-*.yaml +/user-docs/application-examples # Dependencies node_modules diff --git a/docs.package.json b/docs.package.json index 24a89f08cc..913c0f59d3 100644 --- a/docs.package.json +++ b/docs.package.json @@ -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" } ] diff --git a/docusaurus.config.js b/docusaurus.config.js index 16a143bfc8..a0b9f962b4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -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', { @@ -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' }, { @@ -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' ] }) ] diff --git a/sidebarsUserDocs.js b/sidebarsUserDocs.js new file mode 100644 index 0000000000..2b6c44c679 --- /dev/null +++ b/sidebarsUserDocs.js @@ -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 diff --git a/user-docs/index.md b/user-docs/index.md new file mode 100644 index 0000000000..c7ad78afbf --- /dev/null +++ b/user-docs/index.md @@ -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.