Skip to content

Commit 080acd9

Browse files
Copilotabernix
andauthored
docs: Fix invalid MDX comments in documentation files (#8735)
Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: abernix <[email protected]> Co-authored-by: Jesse Rosenberger <[email protected]>
1 parent c6e52d2 commit 080acd9

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed

docs/source/routing/customization/native-plugins.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -236,7 +236,7 @@ plugins:
236236
# Any values here are passed to the plugin as part of your configuration
237237
```
238238

239-
<a id="using-macros"></a> <!-- to keep old links working -->
239+
<a id="using-macros"></a> {/* to keep old links working */}
240240
## Observability
241241

242242
### Add custom metrics

docs/source/routing/upgrade/from-router-v1.mdx

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,6 @@ This upgrade guide describes the steps to upgrade your GraphOS Router deployment
1010

1111
## Upgrade strategy
1212

13-
<!-- TODO: this needs a bit more expansion -->
14-
1513
Before making any changes, auto-upgrade your configuration. This will remove options that already have no effect in v1.x, and make the rest of the upgrade easier.
1614

1715
Check the changes that will be applied using:
@@ -102,7 +100,7 @@ These attributes represent how a span spends time (in nanoseconds) over its life
102100

103101
### Removed custom instrumentation selectors
104102

105-
<!-- PR: https://github.com/apollographql/router/pull/6621 -->
103+
{/* PR: https://github.com/apollographql/router/pull/6621 */}
106104

107105
The `subgraph_response_body` selector is removed in favor of `subgraph_response_data` and `subgraph_response_errors`.
108106

@@ -129,23 +127,23 @@ telemetry:
129127
130128
### Scaffold no longer supported for Rust plugin code generation
131129
132-
<!-- PR: https://github.com/apollographql/router/pull/6274 -->
130+
{/* PR: https://github.com/apollographql/router/pull/6274 */}
133131
134132
Support for the `cargo-scaffold` command to generate boilerplate source code for a Rust plugin has been removed in router v2.x.
135133

136134
**Upgrade step**: Source code generated using Scaffold will continue to compile, so existing Rust plugins will be unaffected by this change.
137135

138136
### Removed configurable poll interval for Apollo Uplink
139137

140-
<!-- PR: https://github.com/apollographql/router/pull/6268 -->
138+
{/* PR: https://github.com/apollographql/router/pull/6268 */}
141139

142140
The configurable poll interval of Apollo Uplink has been removed in router v2.x.
143141

144142
**Upgrade step**: remove uses of both the `--apollo-uplink-poll-interval` command-line argument and the `APOLLO_UPLINK_POLL_INTERVAL` environment variable.
145143

146144
### Removed hot reloading of supergraph URLs
147145

148-
<!-- PR: https://github.com/apollographql/router/pull/6567 -->
146+
{/* PR: https://github.com/apollographql/router/pull/6567 */}
149147

150148
Hot reloading is no longer supported for supergraph URLs configured via either the `--supergraph-urls` command-line argument or the `APOLLO_ROUTER_SUPERGRAPH_URLS` environment variable. In router v1.x, if hot reloading was enabled, the router would repeatedly fetch the URLs on the interval specified by `--apollo-uplink-poll-interval`. This poll interval has been removed in v2.x.
151149

@@ -314,7 +312,7 @@ Automatic configuration upgrades can still be applied explicitly.
314312

315313
**Upgrade step**: use the `router config` commands as shown at the top of the upgrade guide.
316314

317-
<!-- PR: https://github.com/apollographql/router/pull/6777 -->
315+
{/* PR: https://github.com/apollographql/router/pull/6777 */}
318316

319317
## Configuration changes
320318

@@ -408,8 +406,6 @@ You can continue using deprecated context key names from router 1.x if you confi
408406
| `persisted_query_hit` | `apollo::apq::cache_hit` |
409407
| `persisted_query_register` | `apollo::apq::registered` |
410408

411-
<!-- TODO(@goto-bus-stop): list configuration keys that contain context keys? -->
412-
413409
### Context Keys for Coprocessors
414410

415411
The [context key renames](#renamed-context-keys) may impact your coprocessor logic. It can be tricky to update all context key usage together with the router upgrade. To aid this, the `context` option for Coprocessors has been extended.
@@ -488,7 +484,7 @@ No syntax changes are required when using the default endpoint path or a path wi
488484

489485
### Changed syntax for header propagation path
490486

491-
<!-- PR: https://github.com/apollographql/router/pull/6621 -->
487+
{/* PR: https://github.com/apollographql/router/pull/6621 */}
492488

493489
In router v2.x, the path used for selecting data from a client request body for [header propagation](/graphos/routing/header-propagation#insert) must comply with the [JSONPath](https://www.ietf.org/archive/id/draft-goessner-dispatch-jsonpath-00.html) spec. This means a `$` is now required to select the root element.
494490

@@ -520,7 +516,7 @@ The following lists new capabilities in router v2.x that we recommend you use. T
520516

521517
### More granular logging with custom telemetry
522518

523-
<!-- PR: https://github.com/apollographql/router/pull/6285 -->
519+
{/* PR: https://github.com/apollographql/router/pull/6285 */}
524520

525521
Previously, router v1.x had an experimental `experimental_when_header` feature to log requests and responses if a request header was set to a specific value. This feature provided very limited control:
526522

@@ -585,7 +581,7 @@ telemetry:
585581

586582
### Improved traffic shaping
587583

588-
<!-- PR: https://github.com/apollographql/router/pull/6486 -->
584+
{/* PR: https://github.com/apollographql/router/pull/6486 */}
589585

590586
Traffic shaping has been improved significantly in router v2.x. We've added a new mechanism, concurrency control, and we've improved the router's ability to observe timeout and traffic shaping restrictions correctly. These improvements do mean that clients of the router may see an increase in errors as traffic shaping constraints are enforced:
591587

0 commit comments

Comments
 (0)