Skip to content

Commit 3a560fa

Browse files
author
Charlie Egan
authored
docs: Update sidebar (#7723)
I have had some feedback that the sidebar is too long and disorganized. The sidebar has not been updated much in the transition to the new docs site. I am expecting some feedback here, but this is a first pass. The docs archive has been removed as this is now linked from the top of the docs nav. Signed-off-by: Charlie Egan <[email protected]>
1 parent d917e3a commit 3a560fa

File tree

4 files changed

+65
-43
lines changed

4 files changed

+65
-43
lines changed

docs/docs/cli.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: CLI
2+
title: CLI Reference
33
---
44

55
The commands exposed in the `opa` executable are listed here in alphabetical

docs/docs/debugging/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,12 @@
11
---
2-
title: Debugging OPA
2+
title: Debugging
33
---
44

5+
# Debugging Rego Policies
6+
57
This section outlines the various tools and techniques that can be used to debug OPA, both as a component in a
68
distributed system and as a policy engine evaluating the Rego language.
79

8-
# Debugging Rego Policies
9-
1010
Debugging Rego is crucial to ensuring OPA functions properly, as its policy
1111
engine evaluates policies written in Rego. Effective Rego debugging helps
1212
identify and resolve issues that impact OPA’s performance and behavior. A strong

docs/docs/rest-api.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: REST API
2+
title: REST API Reference
33
sidebar_position: 10
44
---
55

docs/src/lib/sidebars.js

Lines changed: 60 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -7,41 +7,57 @@ module.exports = {
77
"policy-testing",
88
"policy-performance",
99
{ type: "autogenerated", dirName: "external-data" },
10-
"integration",
11-
"extensions",
12-
{ type: "autogenerated", dirName: "debugging" },
13-
"rest-api",
14-
"cli",
15-
"editor-and-ide-support",
16-
"ir",
17-
"wasm",
18-
"v0-compatibility",
19-
{ type: "autogenerated", dirName: "v0-upgrade" },
20-
{ type: "html", value: "<hr>" },
2110
{
2211
type: "category",
23-
label: "Envoy",
12+
label: "Management APIs",
2413
collapsible: true,
2514
collapsed: true,
2615
items: [
27-
{ type: "autogenerated", dirName: "envoy" },
16+
{ type: "autogenerated", dirName: "management-introduction" },
17+
{ type: "autogenerated", dirName: "management-bundles" },
18+
"management-decision-logs",
19+
"management-status",
20+
"management-discovery",
2821
],
2922
},
3023
{
3124
type: "category",
32-
label: "Kubernetes",
25+
label: "Operations & Configuration",
3326
collapsible: true,
3427
collapsed: true,
3528
items: [
36-
{ type: "autogenerated", dirName: "kubernetes" },
29+
"configuration",
30+
"deployments",
31+
"monitoring",
32+
"security",
33+
"privacy",
34+
"storage",
3735
],
3836
},
3937
{
4038
type: "category",
41-
label: "Other Use Cases",
39+
label: "Use Cases",
4240
collapsible: true,
4341
collapsed: true,
4442
items: [
43+
{
44+
type: "category",
45+
label: "Envoy & Istio",
46+
collapsible: true,
47+
collapsed: true,
48+
items: [
49+
{ type: "autogenerated", dirName: "envoy" },
50+
],
51+
},
52+
{
53+
type: "category",
54+
label: "Kubernetes",
55+
collapsible: true,
56+
collapsed: true,
57+
items: [
58+
{ type: "autogenerated", dirName: "kubernetes" },
59+
],
60+
},
4561
"cicd",
4662
"aws-cloudformation-hooks",
4763
"docker-authorization",
@@ -53,32 +69,26 @@ module.exports = {
5369
"oauth-oidc",
5470
],
5571
},
56-
{ type: "html", value: "<hr>" },
5772
{
5873
type: "category",
59-
label: "Operations",
74+
label: "Developer Resources",
6075
collapsible: true,
6176
collapsed: true,
6277
items: [
63-
"configuration",
64-
"deployments",
65-
"monitoring",
66-
"security",
67-
"privacy",
68-
"storage",
78+
{ type: "autogenerated", dirName: "debugging" },
79+
"cli",
80+
"editor-and-ide-support",
6981
],
7082
},
7183
{
7284
type: "category",
73-
label: "Management APIs",
85+
label: "Build on OPA",
7486
collapsible: true,
7587
collapsed: true,
7688
items: [
77-
{ type: "autogenerated", dirName: "management-introduction" },
78-
{ type: "autogenerated", dirName: "management-bundles" },
79-
"management-decision-logs",
80-
"management-status",
81-
"management-discovery",
89+
"integration",
90+
"extensions",
91+
"rest-api",
8292
],
8393
},
8494
{
@@ -95,22 +105,34 @@ module.exports = {
95105
],
96106
},
97107
{
98-
type: "link",
99-
label: "Documentation Archive",
100-
href: "/docs/archive",
108+
type: "category",
109+
label: "OPA v0",
110+
collapsible: true,
111+
collapsed: true,
112+
items: [
113+
"v0-compatibility",
114+
{ type: "autogenerated", dirName: "v0-upgrade" },
115+
],
116+
},
117+
{
118+
type: "category",
119+
label: "Alternative Runtimes",
120+
collapsible: true,
121+
collapsed: true,
122+
items: [
123+
"ir",
124+
"wasm",
125+
],
101126
},
102127
"faq",
103128
"comparison-to-other-systems",
129+
{ type: "html", value: "<hr>" },
104130
{
105131
type: "link",
106132
label: "Enterprise Support",
107133
href: "/support",
108134
},
109-
{
110-
type: "link",
111-
label: "OPA Ecosystem",
112-
href: "/ecosystem",
113-
},
135+
{ type: "html", value: "<hr>" },
114136
],
115137
rootSidebar: [],
116138
};

0 commit comments

Comments
 (0)