Skip to content

Merge duplicate coprocessor documentation#8844

Merged
abernix merged 3 commits intodevfrom
copilot/merge-duplicate-coprocessor-docs
Feb 3, 2026
Merged

Merge duplicate coprocessor documentation#8844
abernix merged 3 commits intodevfrom
copilot/merge-duplicate-coprocessor-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 30, 2026


Description

Duplicate coprocessor documentation existed where only one file was linked in the sidebar:

  • Live: docs/source/routing/customization/coprocessor/index.mdx (in sidebar)
  • Orphaned: docs/source/routing/customization/coprocessor.mdx (not in sidebar)

The orphaned file contained a unique "Per-stage coprocessor URLs" section showing how to override the global coprocessor URL per-stage.

Changes

  • Migrated "Per-stage coprocessor URLs" section to live documentation after "Minimal configuration" section
  • Deleted orphaned coprocessor.mdx file
  • Verified no references to deleted file exist in codebase
# Now documented in the live file:
coprocessor:
  url: http://127.0.0.1:3000
  supergraph:
    request:
      url: http://127.0.0.1:3001  # per-stage override

Checklist

Complete the checklist (and note appropriate exceptions) before the PR is marked ready-for-review.

  • PR description explains the motivation for the change and relevant context for reviewing
  • PR description links appropriate GitHub/Jira tickets (creating when necessary)
  • Changeset is included for user-facing changes
  • Changes are compatible1
  • Documentation2 completed
  • Performance impact assessed and acceptable
  • Metrics and logs are added3 and documented
  • Tests added and passing4
    • Unit tests
    • Integration tests
    • Manual tests, as necessary

Exceptions

  • No changeset needed: documentation-only change with no user-facing functionality changes
  • No tests needed: consolidated existing documentation content
  • No metrics/logs: documentation-only change

Notes

Original prompt

Merge Duplicate Coprocessor Documentation

Problem

We have duplicate coprocessor documentation files where only one is linked in the sidebar:

  • Live (in sidebar): docs/source/routing/customization/coprocessor/index.mdx
  • Orphaned (not in sidebar): docs/source/routing/customization/coprocessor.mdx

This means content updates might be going to the orphaned file that users never see.

Solution

  1. Preserve unique content: Migrate the "Per-stage coprocessor URLs" section from the orphaned file to the live documentation
  2. Delete the orphaned file: Remove docs/source/routing/customization/coprocessor.mdx

Specific Changes Needed

1. Add Missing "Per-stage coprocessor URLs" Section

Add this section to docs/source/routing/customization/coprocessor/index.mdx after the "Minimal configuration" section (around line 98):

### Per-stage coprocessor URLs

Override the global coprocessor URL on a per-stage basis:

```yaml title="router.yaml"
coprocessor:
  url: http://127.0.0.1:3000 # mandatory URL which is the address of the coprocessor
  router:
    request:
      headers: false
  supergraph:
    request:
      url: http://127.0.0.1:3001 # overrides the top level URL for supergraph request
      headers: true
      body: true
    response: # uses the top level coprocessor URL for supergraph response
      headers: true
      body: true

This enables targeted coprocessors for individual stages.


### 2. Delete the Orphaned File
Remove the file: `docs/source/routing/customization/coprocessor.mdx`

## Verification
- Ensure the live documentation in `docs/source/routing/customization/coprocessor/index.mdx` has all valuable content
- Confirm the sidebar configuration in `docs/source/_sidebar.yaml` correctly points to the `/coprocessor/index.mdx` file (it already does)
- Check that no other files reference the orphaned `coprocessor.mdx` file

This pull request was created from Copilot chat.


💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.

Footnotes

  1. It may be appropriate to bring upcoming changes to the attention of other (impacted) groups. Please endeavour to do this before seeking PR approval. The mechanism for doing this will vary considerably, so use your judgement as to how and when to do this.

  2. Configuration is an important part of many changes. Where applicable please try to document configuration examples.

  3. A lot of (if not most) features benefit from built-in observability and debug-level logs. Please read this guidance on metrics best-practices.

  4. Tick whichever testing boxes are applicable. If you are adding Manual Tests, please document the manual testing (extensively) in the Exceptions.

@apollo-cla
Copy link

@Copilot: Thank you for submitting a pull request! Before we can merge it, you'll need to sign the Apollo Contributor License Agreement here: https://contribute.apollographql.com/

@apollo-librarian
Copy link

apollo-librarian bot commented Jan 30, 2026

✅ Docs preview ready

The preview is ready to be viewed. View the preview

File Changes

0 new, 3 changed, 1 removed
* graphos/routing/(latest)/customization/coprocessor/index.mdx
* graphos/routing/(latest)/observability/router-telemetry-otel/apm-guides/datadog/router-instrumentation.mdx
* graphos/routing/(latest)/observability/router-telemetry-otel/enabling-telemetry/standard-instruments.mdx
- graphos/routing/(latest)/customization/coprocessor.mdx

Build ID: 447bb25237479d60744560e0
Build Logs: View logs

URL: https://www.apollographql.com/docs/deploy-preview/447bb25237479d60744560e0

Co-authored-by: abernix <841294+abernix@users.noreply.github.com>
Copilot AI changed the title [WIP] Merge duplicate coprocessor documentation and remove orphaned file Merge duplicate coprocessor documentation Jan 30, 2026
Copilot AI requested a review from abernix January 30, 2026 14:20
@abernix
Copy link
Member

abernix commented Jan 30, 2026

Linking this to #8384 where things ended up in the wrong place.

@abernix abernix marked this pull request as ready for review January 30, 2026 14:33
@abernix abernix requested a review from a team as a code owner January 30, 2026 14:33
@github-actions
Copy link
Contributor

@Copilot, please consider creating a changeset entry in /.changesets/. These instructions describe the process and tooling.

Copy link
Contributor

@pragl pragl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A couple minor recommendations from our AI reviewer based on the style guide, which I copied in as suggestions. Otherwise, LGTM!

Co-authored-by: Parker <parker.ragland@apollographql.com>
@abernix
Copy link
Member

abernix commented Feb 3, 2026

@mergify backport main

@mergify
Copy link
Contributor

mergify bot commented Feb 3, 2026

backport main

❌ Unable to backport: Mergify can't impersonate Copilot

Details

User Copilot used as bot_account is unknown. Please make sure {login} exists and has logged into the Mergify dashboard.

@abernix abernix enabled auto-merge (squash) February 3, 2026 08:49
@abernix abernix added the documentation Improvements or additions to documentation label Feb 3, 2026
@abernix abernix merged commit 966374e into dev Feb 3, 2026
15 checks passed
@abernix abernix deleted the copilot/merge-duplicate-coprocessor-docs branch February 3, 2026 09:14
the-gigi-apollo pushed a commit that referenced this pull request Feb 4, 2026
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: abernix <841294+abernix@users.noreply.github.com>
Co-authored-by: Jesse Rosenberger <git@jro.cc>
Co-authored-by: Parker <parker.ragland@apollographql.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants