github.com/kubeshop/testkube@v1.17.23/docs/sidebars.js (about) 1 /** 2 * Creating a sidebar enables you to: 3 - create an ordered group of docs 4 - render a sidebar for each doc of that group 5 - provide next/previous navigation 6 7 The sidebars can be generated from the filesystem, or explicitly defined here. 8 9 Create as many sidebars as you want. 10 */ 11 12 // @ts-check 13 14 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ 15 const sidebars = { 16 // By default, Docusaurus generates a sidebar from the docs folder structure 17 tutorialSidebar: [ 18 { 19 type: "category", 20 label: "Overview", 21 link: { 22 type: "doc", 23 id: "index", 24 }, 25 items: ["articles/supported-tests", "articles/testkube-benefits", "articles/open-source-or-pro"], 26 }, 27 { 28 type: "doc", 29 label: "Getting Started", 30 id: "articles/getting-started", 31 }, 32 { 33 type: "category", 34 label: "Concepts", 35 items: [ 36 { 37 type: "category", 38 label: "Tests", 39 items: [ 40 "articles/creating-tests", 41 "articles/running-tests", 42 "articles/getting-tests-results", 43 "articles/adding-tests-variables", 44 "articles/adding-timeout", 45 ], 46 }, 47 { 48 type: "category", 49 label: "Test Suites", 50 items: [ 51 "articles/creating-test-suites", 52 "articles/running-test-suites", 53 "articles/getting-test-suites-results", 54 ], 55 }, 56 { 57 type: "category", 58 label: "Testkube Dashboard", 59 link: { 60 type: "doc", 61 id: "articles/testkube-dashboard", 62 }, 63 items: [ 64 "articles/testkube-dashboard-explore", 65 "articles/testkube-dashboard-general-settings", 66 ], 67 }, 68 "articles/adding-tests-secrets", 69 "articles/scheduling-tests", 70 "articles/test-triggers", 71 "articles/webhooks", 72 "articles/test-sources", 73 "articles/test-executions", 74 "articles/templates", 75 ], 76 }, 77 { 78 type: "category", 79 label: "Guides", 80 items: [ 81 { 82 type: "category", 83 label: "Getting to Production", 84 items: [ 85 { 86 type: "category", 87 label: "Authentication", 88 items: ["articles/oauth-cli"], 89 }, 90 "articles/deploying-in-aws", 91 "articles/deploying-from-private-registries", 92 ], 93 }, 94 { 95 type: "category", 96 label: "CI/CD Integration", 97 link: { 98 type: "doc", 99 id: "articles/cicd-overview", 100 }, 101 items: [ 102 "articles/github-actions", 103 "articles/gitlab", 104 "articles/jenkins", 105 "articles/jenkins-ui", 106 "articles/circleci", 107 "articles/run-tests-with-github-actions", 108 "articles/testkube-cli-docker", 109 { 110 type: "category", 111 label: "GitOps", 112 link: { 113 type: "doc", 114 id: "articles/gitops-overview", 115 }, 116 items: [ 117 { 118 type: "doc", 119 id: "articles/flux-integration", 120 label: "Flux", 121 }, 122 { 123 type: "doc", 124 id: "articles/argocd-integration", 125 label: "ArgoCD", 126 }, 127 ], 128 }, 129 ], 130 }, 131 "articles/creating-first-test", 132 "articles/cd-events", 133 "articles/slack-integration", 134 "articles/generate-test-crds", 135 "articles/logging", 136 "articles/install-cli", 137 "articles/uninstall", 138 "articles/upgrade", 139 ], 140 }, 141 { 142 type: "category", 143 label: "Test Types", 144 link: { 145 type: "generated-index", 146 description: "Supported Test Types / Executors within Testkube", 147 }, 148 items: [ 149 "test-types/executor-artillery", 150 "test-types/executor-curl", 151 "test-types/executor-cypress", 152 "test-types/executor-ginkgo", 153 "test-types/executor-gradle", 154 "test-types/executor-jmeter", 155 "test-types/executor-k6", 156 "test-types/executor-kubepug", 157 "test-types/executor-kubent", 158 "test-types/executor-maven", 159 "test-types/executor-playwright", 160 "test-types/executor-postman", 161 "test-types/executor-pytest", 162 "test-types/executor-soapui", 163 "test-types/executor-tracetest", 164 "test-types/executor-zap", 165 "test-types/prebuilt-executor", 166 "test-types/container-executor", 167 "test-types/executor-distributed-jmeter", 168 ], 169 }, 170 { 171 type: "html", 172 value: "<hr />", 173 }, 174 { 175 type: "category", 176 label: "Testkube Pro", 177 items: [ 178 "testkube-pro/articles/intro", 179 "testkube-pro/articles/installing-agent", 180 "testkube-pro/articles/transition-from-oss", 181 "testkube-pro/articles/organization-management", 182 "testkube-pro/articles/environment-management", 183 "testkube-pro/articles/managing-cli-context", 184 "testkube-pro/articles/architecture", 185 "testkube-pro/articles/running-parallel-tests-with-test-suite", 186 "testkube-pro/articles/AI-test-insights", 187 "testkube-pro/articles/status-pages", 188 "testkube-pro/articles/cached-results", 189 "testkube-pro/articles/log-highlighting", 190 ], 191 }, 192 { 193 type: "category", 194 label: "Testkube Pro On-Prem", 195 items: [ 196 "testkube-pro-on-prem/articles/testkube-pro-on-prem", 197 "testkube-pro-on-prem/articles/usage-guide", 198 "testkube-pro-on-prem/articles/auth", 199 "testkube-pro-on-prem/articles/migrating-from-oss-to-pro"], 200 }, 201 "articles/testkube-oss", 202 { 203 type: "category", 204 label: "Reference", 205 items: [ 206 { 207 type: "doc", 208 id: "articles/helm-chart", 209 label: "Helm Chart", 210 }, 211 "articles/crds-reference", 212 { 213 type: "category", 214 label: "CLI", 215 items: [ 216 { 217 type: "autogenerated", 218 dirName: "cli", 219 }, 220 ], 221 }, 222 "openapi", 223 "articles/metrics", 224 "articles/artifacts", 225 "articles/testkube-dependencies", 226 "articles/architecture", 227 "articles/telemetry", 228 ], 229 }, 230 "articles/common-issues", 231 "articles/deprecations", 232 { 233 type: "category", 234 label: "Contributing", 235 items: [ 236 "articles/contributing", 237 { 238 type: "category", 239 label: "Development", 240 link: { 241 type: "doc", 242 id: "articles/development", 243 }, 244 items: ["articles/crds"], 245 }, 246 ], 247 }, 248 ], 249 250 // But you can create a sidebar manually 251 /* 252 tutorialSidebar: [ 253 { 254 type: 'category', 255 label: 'Tutorial', 256 items: ['hello'], 257 }, 258 ], 259 */ 260 }; 261 262 module.exports = sidebars;