document-website/sidebars.js at release · oss-compass/document-website · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */

// @ts-check

/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
const sidebars = {
  // By default, Docusaurus generates a sidebar from the docs folder structure
  // tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
  webSidebar: [
    // { type: 'doc', id: 'docs/user-guide/README', label: 'User Guide', },

    {
      type: 'category',
      collapsed: false,
      label: 'V3 Assessment System',
      link: {
        type: 'generated-index',
        description: 'The V3 Assessment System provides comprehensive evaluation frameworks for open source communities, including Community Ecosystem Health, Developer Journey, and Supply Chain Security assessments.',
        slug: '/v3-assessment',
        keywords: ['V3 Assessment', 'Community Health', 'Developer Journey', 'Supply Chain Security'],
        image: '/img/docusaurus.png',
      },
      items: [
        {
          type: 'category',
          collapsed: false,
          label: 'Community Ecosystem Health Assessment',
          link: {
            type: 'doc',
            id: 'docs/v3-assessment/Community Ecosystem Health Assessment/Overview',
          },
          items: [
            { type: 'doc', id: 'docs/v3-assessment/Community Ecosystem Health Assessment/Community Vitality', label: 'Community Vitality' },
            { type: 'doc', id: 'docs/v3-assessment/Community Ecosystem Health Assessment/Collaboration Efficiency', label: 'Collaboration Efficiency' },
            { type: 'doc', id: 'docs/v3-assessment/Community Ecosystem Health Assessment/Open Governance', label: 'Open Governance' },
          ],
        },
        {
          type: 'category',
          collapsed: false,
          label: 'Developer Journey Assessment',
          link: {
            type: 'doc',
            id: 'docs/v3-assessment/Developer Journey Assessment/Overview',
          },
          items: [
            { type: 'doc', id: 'docs/v3-assessment/Developer Journey Assessment/Developer Attraction', label: 'Developer Attraction' },
            { type: 'doc', id: 'docs/v3-assessment/Developer Journey Assessment/Developer Growth', label: 'Developer Growth' },
            { type: 'doc', id: 'docs/v3-assessment/Developer Journey Assessment/Developer Retention', label: 'Developer Retention' },
          ],
        },
        {
          type: 'category',
          collapsed: false,
          label: 'Open Source Software Supply Chain Security Assessment',
          link: {
            type: 'doc',
            id: 'docs/v3-assessment/Open Source Software Supply Chain Security Assessment/Overview',
          },
          items: [
            { type: 'doc', id: 'docs/v3-assessment/Open Source Software Supply Chain Security Assessment/Source Code Management', label: 'Source Code Management' },
            { type: 'doc', id: 'docs/v3-assessment/Open Source Software Supply Chain Security Assessment/Development and Build', label: 'Development and Build' },
            { type: 'doc', id: 'docs/v3-assessment/Open Source Software Supply Chain Security Assessment/Release and Maintenance', label: 'Release and Maintenance' },
          ],
        },
      ],
    },

    {
      type: 'category',
      collapsed: false,
      label: 'Ecosystem Evaluation System',
      key: 'ecosystem-evaluation-service-guide',
      link: {
        type: 'generated-index',
        description: 'This guide introduces the core services provided by OSS Compass platform, helping users understand and utilize various evaluation and analysis tools.',
        slug: '/service-guide',
        keywords: ['Service Guide', 'Compass Services'],
        image: '/img/docusaurus.png',
      },
      items: [
        { type: 'doc', id: 'docs/service-guide/open-source-insights', label: 'Open Source Trend Insights' },
        { type: 'doc', id: 'docs/service-guide/software-selection', label: 'Software Selection Evaluation' },
        { type: 'doc', id: 'docs/service-guide/developer-persona', label: 'Developer Persona Evaluation' },
        {
          type: 'category',
          collapsed: false,
          label: 'Ecosystem Evaluation Service',
          link: {
            type: 'generated-index',
            description: 'Build a three-dimensional evaluation system to assess the health status of open source communities.',
            slug: '/service-guide/ecosystem-evaluation',
            keywords: ['Ecosystem Evaluation', 'Community Health'],
            image: '/img/docusaurus.png',
          },
          items: [
            { type: 'doc', id: 'community/quick-start', label: 'Quick Start' },
            {
              type: 'category',
              collapsed: false,
              label: 'Ecosystem Evaluation System',
              link: {
                type: 'generated-index',
                description: 'Ecosystem is used to describe the health status of open source community standing from ecology context.',
                slug: '/service-guide/ecosystem-evaluation/metrics-models',
                keywords: ['Metrics Models'],
                image: '/img/docusaurus.png',
              },
              items: [
                { type: 'doc', id: 'docs/metrics-models/metrics-models-overview' },
                {
                  type: 'category',
                  collapsed: true,
                  label: 'Collaboration-Productivity',
                  items: [
                    { type: 'doc', id: 'docs/metrics-models/collaboration/productivity/collaboration-productivity-overview' },
                    { type: 'doc', id: 'docs/metrics-models/collaboration/productivity/collaboration-development-index' },
                    { type: 'doc', id: 'docs/metrics-models/collaboration/productivity/community-service-and-support' },
                  ],
                },
                {
                  type: 'category',
                  collapsed: true,
                  label: 'Collaboration-Robustness',
                  items: [
                    { type: 'doc', id: 'docs/metrics-models/collaboration/robustness/collaboration-robustness-overview' },
                    { type: 'doc', id: 'docs/metrics-models/collaboration/robustness/activity' },
                  ],
                },
                {
                  type: 'category',
                  collapsed: true,
                  label: 'Collaboration-Niche Creation',
                  items: [
                    { type: 'doc', id: 'docs/metrics-models/collaboration/niche-creation/collaboration-niche-creation-overview' },
                    { type: 'doc', id: 'docs/metrics-models/collaboration/niche-creation/organization-activity' },
                  ],
                },
                {
                  type: 'category',
                  collapsed: true,
                  label: 'People-Productivity',
                  items: [
                    { type: 'doc', id: 'docs/metrics-models/people/productivity/people-productivity-overview' },
                    { type: 'doc', id: 'docs/metrics-models/people/productivity/contributor-domain-persona' },
                    { type: 'doc', id: 'docs/metrics-models/people/productivity/contributor-role-persona' },
                    { type: 'doc', id: 'docs/metrics-models/people/productivity/contributor-milestone-persona' },
                  ],
                },
                {
                  type: 'category',
                  collapsed: true,
                  label: 'Software Artifact-Robustness',
                  items: [
                    { type: 'doc', id: 'docs/metrics-models/software_artifact/robustness/software-artifact-robustness-overview' },
                    { type: 'doc', id: 'docs/metrics-models/software_artifact/robustness/cii_best_badge' },
                    { type: 'doc', id: 'docs/metrics-models/software_artifact/robustness/criticality_score' },
                    { type: 'doc', id: 'docs/metrics-models/software_artifact/robustness/scorecard' },
                  ],
                },
              ],
            },
          ],
        },
        { type: 'doc', id: 'docs/service-guide/research-data-hub', label: 'Research Data Hub' },
      ],
    },

    {
      type: 'category',
      collapsed: false,
      label: 'Community',
      link: {
        type: 'generated-index',
        description: 'Join the OSS-Compass Community',
        slug: '/community',
        keywords: [],
        image: '/img/docusaurus.png',
      },
      items: [
        { type: 'link', label: 'GitHub', href: 'https://github.com/oss-compass' },
        { type: 'link', label: 'Gitee', href: 'https://gitee.com/oss-compass' },
        { type: 'link', label: 'AtomGit', href: 'https://atomgit.com/oss-compass' },
        { type: 'doc', label: 'Weekly Meeting', id: 'community/community/metting' },
        { type: 'doc', label: 'Slack', id: 'community/community/slack' },
        { type: 'doc', label: 'WeChat', id: 'community/community/wechat' },
      ],
    },

    { type: 'doc', label: 'Participating Contribution', id: 'community/CONTRIBUTING' },

    {
      type: 'category',
      collapsed: false,
      label: 'Legal',
      link: {
        type: 'generated-index',
        slug: '/legal',
        keywords: [],
        image: '/img/docusaurus.png',
      },
      items: [
        { type: 'doc', label: 'Terms', id: 'community/legal/terms-of-use' },
        { type: 'doc', label: 'Privacy', id: 'community/legal/privacy-policy' },
      ],
    },

  ],
};

module.exports = sidebars;