Skip to content

Commit e04d202

Browse files
authored
Docs revamp (#333)
* Docs revamp * navbar update
1 parent c6fa340 commit e04d202

File tree

4 files changed

+277
-44
lines changed

4 files changed

+277
-44
lines changed

website/docusaurus.config.js

Lines changed: 37 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ const resources = [
2929
},
3030
{
3131
label: 'FAQ',
32-
href: 'https://docs.litmuschaos.io/docs/faq-general/'
32+
href: 'https://docs.litmuschaos.io/docs/faq/'
3333
},
3434
{
3535
label: 'Issues',
@@ -51,6 +51,14 @@ module.exports = {
5151
apiKey: 'b388bb42bbdfcd9c02f0eb32c6ee9fa4',
5252
indexName: 'litmuschaos'
5353
},
54+
announcementBar: {
55+
id: 'support_us',
56+
content:
57+
'Star our repository on <a target="_blank" rel="noopener noreferrer" href="https://github.com/litmuschaos/litmus">GitHub</a> to stay updated with new features and contribute to our project!',
58+
backgroundColor: '#d8dbfa',
59+
textColor: '#5b44ba',
60+
isCloseable: true,
61+
},
5462
navbar: {
5563
title: 'Litmus Docs',
5664
logo: {
@@ -59,10 +67,6 @@ module.exports = {
5967
src: 'img/litmus-light-icon.svg'
6068
},
6169
items: [
62-
{
63-
type: 'docsVersion',
64-
position: 'right'
65-
},
6670
{
6771
activeBasePath: 'Version',
6872
label: 'Versions',
@@ -84,6 +88,15 @@ module.exports = {
8488
},
8589
]
8690
},
91+
{
92+
type: 'docsVersion',
93+
position: 'left'
94+
95+
},
96+
{
97+
type: 'search',
98+
position: 'right',
99+
},
87100
{
88101
label: 'APIs',
89102
to: 'https://litmuschaos.github.io/litmus/graphql/v3.11.0/api.html',
@@ -95,23 +108,33 @@ module.exports = {
95108
position: 'right'
96109
},
97110
{
98-
to: 'https://github.com/litmuschaos/litmus',
99-
label: 'GitHub',
111+
to: 'https://hub.litmuschaos.io/',
112+
label: 'ChaosHub',
100113
position: 'right'
114+
} ,
115+
{
116+
to: 'https://github.com/litmuschaos/litmus',
117+
position: 'right',
118+
label: 'Try Litmus',
119+
className: 'try-button',
120+
'aria-label': 'Try Litmus',
101121
},
102122
{
103-
to: 'https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN',
104-
label: 'Slack',
105-
position: 'right'
123+
href: 'https://github.com/litmuschaos/litmus',
124+
className: 'github-button',
125+
position: 'right',
126+
'aria-label': 'GitHub repository',
106127
},
107128
{
108-
to: 'https://hub.litmuschaos.io/',
109-
label: 'ChaosHub',
110-
position: 'right'
129+
href: 'https://app.slack.com/client/T09NY5SBT/CNXNB0ZTN',
130+
className: 'slack-button',
131+
position: 'right',
132+
'aria-label': 'Slack',
111133
}
134+
112135
]
113136
},
114-
colorMode: {
137+
colorMode: {
115138
// "light" | "dark"
116139
defaultMode: 'light',
117140

website/sidebars.js

Lines changed: 77 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
module.exports = {
22
docs: [
33
{
4-
Introduction: [
4+
type: 'category',
5+
label: 'Introduction',
6+
className: 'category-as-header',
7+
collapsed: false,
8+
collapsible: false,
9+
items: [
510
'introduction/what-is-litmus',
611
'introduction/features',
712
'introduction/usage',
@@ -10,10 +15,50 @@ module.exports = {
1015
]
1116
},
1217
{
13-
'Getting Started': ['getting-started/resources', 'getting-started/installation']
18+
type: 'category',
19+
label: 'Getting Started',
20+
className: 'category-as-header',
21+
collapsed: false,
22+
collapsible: false,
23+
items: [
24+
'getting-started/installation',
25+
{
26+
type: 'category',
27+
label: 'Concepts',
28+
items: [
29+
'concepts/overview',
30+
'concepts/chaos-infrastructure',
31+
'concepts/chaoshub',
32+
'concepts/chaos-workflow',
33+
'concepts/probes',
34+
'concepts/user-management',
35+
'concepts/projects',
36+
'concepts/teaming',
37+
'concepts/gitops',
38+
'concepts/oauth-dex-concept',
39+
'concepts/visualize-experiment'
40+
]
41+
},
42+
{
43+
type: 'category',
44+
label: 'Tutorial',
45+
items: [
46+
'tutorials/overview',
47+
'tutorials/podtato-head'
48+
]
49+
},
50+
'developer-guide/chaoscenter-developer-guide',
51+
'glossary',
52+
'getting-started/resources'
53+
]
1454
},
1555
{
16-
Architecture: [
56+
type: 'category',
57+
label: 'Architecture',
58+
className: 'category-as-header',
59+
collapsed: false,
60+
collapsible: false,
61+
items: [
1762
'architecture/overview',
1863
'architecture/architecture-summary',
1964
'architecture/chaos-control-plane',
@@ -22,22 +67,12 @@ module.exports = {
2267
]
2368
},
2469
{
25-
Concepts: [
26-
'concepts/overview',
27-
'concepts/chaos-infrastructure',
28-
'concepts/chaoshub',
29-
'concepts/chaos-workflow',
30-
'concepts/probes',
31-
'concepts/user-management',
32-
'concepts/projects',
33-
'concepts/teaming',
34-
'concepts/gitops',
35-
'concepts/oauth-dex-concept',
36-
'concepts/visualize-experiment'
37-
]
38-
},
39-
{
40-
'User Guides': [
70+
type: 'category',
71+
label: 'User Guides',
72+
className: 'category-as-header',
73+
collapsed: false,
74+
collapsible: false,
75+
items: [
4176
'user-guides/overview',
4277
{
4378
'Advanced Installation': [
@@ -107,20 +142,32 @@ module.exports = {
107142
]
108143
},
109144
{
110-
'Developer Guide': ['developer-guide/chaoscenter-developer-guide']
145+
type: 'category',
146+
label: 'Litmusctl',
147+
className: 'category-as-header',
148+
collapsed: false,
149+
collapsible: false,
150+
items: ['litmusctl/installation', 'litmusctl/litmusctl-usage']
111151
},
112152
{
113-
Litmusctl: ['litmusctl/installation', 'litmusctl/litmusctl-usage']
153+
type: 'category',
154+
label: 'Integrations',
155+
className: 'category-as-header',
156+
collapsed: false,
157+
collapsible: false,
158+
items: ['integrations/prometheus', 'integrations/grafana', 'integrations/backstage']
114159
},
115160
{
116-
Integrations: ['integrations/prometheus', 'integrations/grafana', 'integrations/backstage']
117-
},
118-
{
119-
Tutorials: ['tutorials/overview', 'tutorials/podtato-head']
120-
},
121-
'troubleshooting',
122-
'best-practices',
123-
'glossary',
124-
'faq'
161+
type: 'category',
162+
label: 'Reference',
163+
className: 'category-as-header',
164+
collapsed: false,
165+
collapsible: false,
166+
items: [
167+
'troubleshooting',
168+
'best-practices',
169+
'faq'
170+
]
171+
}
125172
]
126173
}

0 commit comments

Comments
 (0)