Skip to content

Commit 9da0309

Browse files
authored
docs: simplify hive doc navigation and clarify offerings (#7047)
1 parent 0f26e42 commit 9da0309

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

65 files changed

+464
-262
lines changed

packages/web/docs/next.config.js

Lines changed: 58 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,12 +52,17 @@ export default withGuildDocs({
5252
},
5353
{
5454
source: '/docs/features/registry-usage',
55-
destination: '/docs/high-availability-cdn',
55+
destination: '/docs/schema-registry/high-availability-cdn',
5656
permanent: true,
5757
},
5858
{
5959
source: '/docs/features/high-availability-cdn',
60-
destination: '/docs/high-availability-cdn',
60+
destination: '/docs/schema-registry/high-availability-cdn',
61+
permanent: true,
62+
},
63+
{
64+
source: '/docs/high-availability-cdn',
65+
destination: '/docs/schema-registry/high-availability-cdn',
6166
permanent: true,
6267
},
6368
{
@@ -102,7 +107,7 @@ export default withGuildDocs({
102107
},
103108
{
104109
source: '/docs/self-hosting/apollo-federation-2',
105-
destination: '/docs/self-hosting/external-composition',
110+
destination: '/docs/schema-registry/self-hosting/external-composition',
106111
permanent: true,
107112
},
108113
{
@@ -121,8 +126,8 @@ export default withGuildDocs({
121126
permanent: true,
122127
},
123128
{
124-
source: '/docs/features/laboratory',
125-
destination: '/docs/dashboard/laboratory',
129+
source: '/docs/features/laboratory/:path*',
130+
destination: '/docs/schema-registry/laboratory/:path*',
126131
permanent: true,
127132
},
128133
{
@@ -145,10 +150,35 @@ export default withGuildDocs({
145150
destination: '/docs/use-cases/apollo-graphos',
146151
permanent: true,
147152
},
153+
{
154+
source: '/docs/specs/link-specifications',
155+
destination: '/docs/api-reference/link-specifications',
156+
permanent: true,
157+
},
158+
{
159+
source: '/docs/graphql-api/:path*',
160+
destination: '/docs/api-reference/graphql-api/:path*',
161+
permanent: true,
162+
},
163+
{
164+
source: '/docs/specs/usage-reports',
165+
destination: '/docs/api-reference/usage-reports',
166+
permanent: true,
167+
},
168+
{
169+
source: '/docs/get-started/:path*',
170+
destination: '/docs/schema-registry/get-started/:path*',
171+
permanent: true,
172+
},
173+
{
174+
source: '/docs/management/:path*',
175+
destination: '/docs/schema-registry/management/:path*',
176+
permanent: true,
177+
},
148178
{
149179
// SEO: Redirect to the new URL
150180
source: '/docs/self-hosting/federation-2',
151-
destination: '/docs/self-hosting/external-composition',
181+
destination: '/docs/schema-registry/self-hosting/external-composition',
152182
permanent: true,
153183
},
154184
{
@@ -169,12 +199,27 @@ export default withGuildDocs({
169199
},
170200
{
171201
source: '/docs/self-hosting',
172-
destination: '/docs/self-hosting/get-started',
202+
destination: '/docs/schema-registry/self-hosting/get-started',
173203
permanent: true,
174204
},
175205
{
176206
source: '/docs/dashboard',
177-
destination: '/docs/dashboard/insights',
207+
destination: '/docs/schema-registry/usage-reporting',
208+
permanent: true,
209+
},
210+
{
211+
source: '/docs/dashboard/insights',
212+
destination: '/docs/schema-registry/usage-reporting',
213+
permanent: true,
214+
},
215+
{
216+
source: '/docs/dashboard/explorer',
217+
destination: '/docs/schema-registry/explorer',
218+
permanent: true,
219+
},
220+
{
221+
source: '/docs/dashboard/laboratory/:path*',
222+
destination: '/docs/schema-registry/laboratory/:path*',
178223
permanent: true,
179224
},
180225
{
@@ -247,6 +292,11 @@ export default withGuildDocs({
247292
destination: '/docs/gateway/other-features/performance/deduplicate-inflight-requests',
248293
permanent: true,
249294
},
295+
{
296+
source: '/docs/self-hosting/:path*',
297+
destination: '/docs/schema-registry/self-hosting/:path*',
298+
permanent: true,
299+
},
250300
],
251301
env: {
252302
SITE_URL: 'https://the-guild.dev/graphql/hive',
-74.8 KB
Binary file not shown.
File renamed without changes.
File renamed without changes.

packages/web/docs/src/app/blog/(posts)/graphql-hive-and-clickhouse/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,8 @@ you missed it, we recently
3333

3434
It is important to be aware of how a GraphQL API is used and what is the experience of its final
3535
users. To answer these questions GraphQL Hive collects
36-
[Usage Reports](https://the-guild.dev/graphql/hive/docs/specs/usage-reports). By looking at the
37-
sample below, you can get an idea of how GraphQL Hive knows when it's safe to delete a type or a
36+
[Usage Reports](https://the-guild.dev/graphql/hive/docs/api-reference/usage-reports). By looking at
37+
the sample below, you can get an idea of how GraphQL Hive knows when it's safe to delete a type or a
3838
field of your GraphQL API. This is the most important building block of all data available in
3939
GraphQL Hive.
4040

packages/web/docs/src/app/product-updates/(posts)/2024-03-26-subscription-defer-stream-usage-reporting/page.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ the following GitHub issue for updates:
3131
[Hive Usage Reporting](https://github.com/the-guild-org/conductor/issues/369)
3232

3333
**Other Gateway/SDK users**: We updated the
34-
[API specification for usage reporting](/docs/specs/usage-reports). Please adjust your custom
35-
implementation accordingly to report the usage of GraphQL Subscription operations.
34+
[API specification for usage reporting](/docs/api-reference/usage-reports). Please adjust your
35+
custom implementation accordingly to report the usage of GraphQL Subscription operations.
3636

3737
**Additional Note:** We are currently only collecting the usage of GraphQL Subscription operations.
3838
We are now evaluating what additional metrics might be relevant for the Subscription analytics. If

packages/web/docs/src/app/product-updates/(posts)/2024-12-27-preflight-script/page.mdx

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ GraphQL request is made. They're especially useful for handling authentication f
1414
where you may need to claim or refresh an access token, validate credentials, or set up custom
1515
headers - all before the request is sent.
1616

17-
![Demo of Preflight Scripts](private-next-content-dir/dashboard/laboratory/editing.png)
17+
![Demo of Preflight Scripts](private-next-content-dir/schema-registry/laboratory/editing.png)
1818

19-
Check out [the documentation on Preflight Scripts](/docs/dashboard/laboratory/preflight-scripts) for
19+
Check out
20+
[the documentation on Preflight Scripts](/docs/schema-registry/laboratory/preflight-scripts) for
2021
information on how to configure, edit, and use them.

packages/web/docs/src/app/product-updates/(posts)/2025-03-08-metadata/page.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -63,4 +63,4 @@ Hive continues to expand.
6363

6464
---
6565

66-
[Learn more in the updated documentation](/docs/specs/link-specifications)
66+
[Learn more in the updated documentation](/docs/schema-registry/link-specifications)
Lines changed: 1 addition & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,10 @@
11
export default {
22
index: 'Introduction',
3-
'get-started': 'Get Started',
4-
'schema-registry': 'Schema Registry',
5-
'high-availability-cdn': 'High-Availability CDN',
6-
dashboard: 'Dashboard',
3+
'schema-registry': 'Console',
74
gateway: 'Gateway',
85
logger: 'Logger',
9-
management: 'Management',
106
'other-integrations': 'Other Integrations',
117
'api-reference': 'CLI/API Reference',
12-
specs: 'Specifications',
13-
'graphql-api': 'GraphQL API',
148
'use-cases': 'Use Cases',
159
'migration-guides': 'Migration Guides',
16-
'self-hosting': 'Self-Hosting',
1710
};
Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,9 @@
11
export default {
2+
'graphql-api': 'Public GraphQL API',
23
cli: 'Hive CLI',
3-
'gateway-config': 'Hive Gateway Configuration',
4+
client: 'Hive Client Configuration',
45
'gateway-cli': 'Hive Gateway CLI',
5-
client: 'Hive Client',
6+
'gateway-config': 'Hive Gateway Configuration',
7+
'link-specifications': 'Hive GraphQL Link Spec',
8+
'usage-reports': 'Usage Report Spec',
69
};

0 commit comments

Comments
 (0)