Skip to content

Commit

Permalink
Fixed linkes in BCP documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
PascalSenn committed Dec 2, 2023
1 parent 15b46f0 commit 498c685
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
3 changes: 2 additions & 1 deletion website/src/docs/bananacakepop/v2/apis/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@ title: Apis
An API within the context of Banana Cake Pop, refers to an representation of your GraphQL Servers.
This representation is more than a mere conceptual framework — it serves as a practical tool that allows you to group your documents and share common settings like connection and authorization parameters among them.

Additionally, an API forms the foundation for your client registry, schema registry setup and the telemetry. For more detailed information on these features, refer to the [Schema & Client Registry](/docs/bananacakepop/v2/schema-client-registry) guide and the [Telemetry](/docs/bananacakepop/v2/telemetry) guide.
Additionally, an API forms the foundation for your client registry, schema registry setup and the telemetry. For more detailed information on these features, refer to the [Schema Registry](/docs/bananacakepop/v2/apis/schema-registry) guide
the [Client Registry](/docs/bananacakepop/v2/apis/client-registry) and the [Telemetry](/docs/bananacakepop/v2/apis/open-telemetry) guide.


# API Types
Expand Down
2 changes: 1 addition & 1 deletion website/src/docs/bananacakepop/v2/apis/schema-registry.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@ Examples are:
- Changing the type of a field
- Change a non-null field to a nullable field

Breaking changes need to be managed with care to avoid disruptions to the service. It's important to ensure that all clients can handle these changes before they are introduced. This can be accomplished by versioning your clients and managing the lifecycle of client versions, as described in the section [Understanding Clients](#understanding-clients)].
Breaking changes need to be managed with care to avoid disruptions to the service. It's important to ensure that all clients can handle these changes before they are introduced. This can be accomplished by versioning your clients and managing the lifecycle of client versions, as described in the section [Understanding Clients](/docs/bananacakepop/v2/apis/client-registry#understanding-clients)].

## Extracting the Schema

Expand Down
4 changes: 2 additions & 2 deletions website/src/docs/bananacakepop/v2/bcp-services.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,12 @@
title: Connect you API
---

BananaCake Pop can be smoothly integrated into your HotChocolate server, enabling utilization of the Persisted Query Storage found within the client registry, to report operations and collect open telemetry. Your server will establish a connection with BananaCake Pop, retrieving persisted queries based on their unique hashes. Additional information on the client registry can be found [here](/docs/bananacakepop/v2/schema-client-registry).
BananaCake Pop can be smoothly integrated into your HotChocolate server, enabling utilization of the Persisted Query Storage found within the client registry, to report operations and collect open telemetry. Your server will establish a connection with BananaCake Pop, retrieving persisted queries based on their unique hashes. Additional information on the client registry can be found [here](/docs/bananacakepop/v2/apis/client-registry).

## Getting Started
To get started, follow these steps:

1. Set up a client registry as instructed [here](/docs/bananacakepop/v2/schema-client-registry).
1. Set up a client registry as instructed [here](/docs/bananacakepop/v2/apis/client-registry).

2. Install the BananaCakePop package from NuGet using the following command:
```bash
Expand Down

0 comments on commit 498c685

Please sign in to comment.