Skip to content

Commit a26cf60

Browse files
authored
docs: fix cli docs further reading links (#6833)
1 parent 78b9a56 commit a26cf60

File tree

3 files changed

+26
-3
lines changed

3 files changed

+26
-3
lines changed

packages/web/docs/src/content/api-reference/cli.mdx

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -173,6 +173,7 @@ hive schema:publish \
173173
**Further reading:**
174174

175175
- [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)
176+
- [`schema:publish` API Reference](https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md#hive-apppublish)
176177
- [Apollo Router integration](/docs/other-integrations/apollo-router)
177178
- [Apollo-Server integration](/docs/other-integrations/apollo-server)
178179

@@ -201,6 +202,7 @@ hive schema:publish \
201202
**Further reading:**
202203

203204
- [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)
205+
- [`schema:publish` API Reference](https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md#hive-apppublish)
204206

205207
</Tabs.Tab>
206208

@@ -225,6 +227,11 @@ hive schema:publish \
225227
--github
226228
```
227229

230+
**Further reading:**
231+
232+
- [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)
233+
- [`schema:publish` API Reference](https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md#hive-apppublish)
234+
228235
#### Metadata
229236

230237
You can attach metadata to your schema publication. Hive metadata published to Hive must be a valid
@@ -309,8 +316,9 @@ hive schema:check "src/schema.graphql" --service users --url "https://users.grap
309316

310317
**Further reading:**
311318

312-
- [Publishing a schema to the Schema Registry](/docs/schema-registry#publish-a-schema)
319+
- [Checking a schema with the Schema Registry](/docs/schema-registry#check-a-schema)
313320
- [Conditional Breaking Changes](/docs/management/targets#conditional-breaking-changes)
321+
- [Approving breaking schema changes](/docs/schema-registry#approve-breaking-schema-changes)
314322

315323
#### GitHub Integration
316324

@@ -353,6 +361,10 @@ hive schema:delete \
353361
"<SERVICE_NAME>"
354362
```
355363

364+
**Further reading:**
365+
366+
- [Deleting a service](/docs/schema-registry#delete-a-service)
367+
356368
#### Dry Run
357369

358370
You can also use `--dryRun` flag first to see what effect the command will have on the registry.

packages/web/docs/src/content/schema-registry/app-deployments.mdx

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,10 @@ import detailAppImage from '../../../public/docs/pages/features/app-deployments/
190190
className="mt-10 max-w-2xl rounded-lg drop-shadow-md"
191191
/>
192192

193+
**Further reading**:
194+
195+
- [`app:create` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-appcreate-file)
196+
193197
## Publish an App Deployment
194198

195199
A app deployment will be in the pending state until you publish it. By publishing the app
@@ -223,6 +227,10 @@ import activeAppImage from '../../../public/docs/pages/features/app-deployments/
223227
className="mt-10 max-w-2xl rounded-lg drop-shadow-md"
224228
/>
225229

230+
**Further reading**:
231+
232+
- [`app:publish` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-apppublish)
233+
226234
## Persisted Documents on GraphQL Server and Gateway
227235

228236
Persisted documents can be used on your GraphQL server or Gateway to reduce the payload size of your

packages/web/docs/src/content/schema-registry/index.mdx

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -151,8 +151,8 @@ performed to ensure a schema is fully valid:
151151
For additional reading:
152152

153153
- [Publishing a schema using Hive CLI](/docs/api-reference/cli#publish-a-schema)
154-
- [`schema:publish` command reference](/docs/api-reference/cli#hive-schemapublish-file)
155154
- [Publishing a schema using Hive Client](/docs/api-reference/client)
155+
- [`schema:publish` API Reference](https://github.com/graphql-hive/console/blob/main/packages/libraries/cli/README.md#hive-apppublish)
156156

157157
### Check a schema
158158

@@ -177,6 +177,7 @@ performed to ensure a schema is valid:
177177
For additional reading:
178178

179179
- [Checking a schema using Hive CLI](/docs/api-reference/cli#check-a-schema)
180+
- [`schema:check` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-schemacheck-file)
180181

181182
### Approve breaking schema changes
182183

@@ -201,6 +202,8 @@ local development. This can be done using the `schema:fetch` command.
201202
</Callout>
202203

203204
- [Fetch a schema using Hive CLI](/docs/api-reference/cli#fetch-a-schema-from-the-registry)
205+
- [`schema:fetch` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-schemafetch-actionid)
206+
- [`artifact:fetch` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-artifactfetch)
204207

205208
### Delete a service
206209

@@ -213,7 +216,7 @@ Deleting a service is the form of removing a service from the multi-schema proje
213216
For additional reading:
214217

215218
- [Deleting a service using Hive CLI](/docs/api-reference/cli#delete-a-schema)
216-
- [`schema:delete` command reference](/docs/api-reference/cli#hive-schemadelete-service)
219+
- [`schema:delete` API Reference](https://github.com/graphql-hive/console/tree/main/packages/libraries/cli#hive-schemadelete-service)
217220

218221
## Schema History and Changelog
219222

0 commit comments

Comments
 (0)