mirror of
https://github.com/apache/superset.git
synced 2026-04-24 10:35:01 +00:00
0fb7fc2721
Major restructuring of documentation to separate concerns: **New Structure:** - `/docs/` - User-facing docs (intro, quickstart, databases, using-superset, faq) - `/admin-docs/` - Administrator docs (installation, configuration, security) - `/developer-docs/` - Developer docs (contributing, extensions, guidelines, testing) **Changes:** - Move installation, configuration, and security docs to admin_docs/ - Move contributing, extensions, guidelines, and testing to developer_docs/ - Rename developer_portal to developer_docs (with underscore to hyphen in URL) - Add sidebarAdminDocs.js for admin documentation navigation - Update versions-config.json with new doc sections - Update docusaurus.config.ts with new plugins and redirects - Update internal links in versioned docs (6.0.0) to use new paths - Keep user-facing content (databases, using-superset, faq) in main docs This separation makes it clearer which documentation is relevant for: - End users exploring and visualizing data - Administrators deploying and configuring Superset - Developers contributing to or extending Superset Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
89 lines
2.1 KiB
JavaScript
89 lines
2.1 KiB
JavaScript
/* eslint-env node */
|
|
/**
|
|
* Licensed to the Apache Software Foundation (ASF) under one
|
|
* or more contributor license agreements. See the NOTICE file
|
|
* distributed with this work for additional information
|
|
* regarding copyright ownership. The ASF licenses this file
|
|
* to you under the Apache License, Version 2.0 (the
|
|
* "License"); you may not use this file except in compliance
|
|
* with the License. You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing,
|
|
* software distributed under the License is distributed on an
|
|
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
|
* KIND, either express or implied. See the License for the
|
|
* specific language governing permissions and limitations
|
|
* under the License.
|
|
*/
|
|
|
|
// @ts-check
|
|
|
|
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
|
const sidebars = {
|
|
// User Docs sidebar - for analysts and business users
|
|
CustomSidebar: [
|
|
{
|
|
type: 'doc',
|
|
label: 'Overview',
|
|
id: 'intro',
|
|
},
|
|
{
|
|
type: 'doc',
|
|
label: 'Quickstart',
|
|
id: 'quickstart',
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Using Superset',
|
|
collapsed: false,
|
|
items: [
|
|
{
|
|
type: 'autogenerated',
|
|
dirName: 'using-superset',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'Connecting to Databases',
|
|
collapsed: true,
|
|
link: {
|
|
type: 'doc',
|
|
id: 'databases/index',
|
|
},
|
|
items: [
|
|
{
|
|
type: 'autogenerated',
|
|
dirName: 'databases',
|
|
},
|
|
],
|
|
},
|
|
{
|
|
type: 'doc',
|
|
label: 'FAQ',
|
|
id: 'faq',
|
|
},
|
|
{
|
|
type: 'category',
|
|
label: 'API Reference',
|
|
link: {
|
|
type: 'doc',
|
|
id: 'api',
|
|
},
|
|
items: (() => {
|
|
try {
|
|
// eslint-disable-next-line @typescript-eslint/no-require-imports
|
|
return require('./docs/api/sidebar.js');
|
|
} catch {
|
|
// Generated by `yarn generate:api-docs`; empty until then
|
|
return [];
|
|
}
|
|
})(),
|
|
},
|
|
],
|
|
};
|
|
|
|
module.exports = sidebars;
|