Skip to content

docs: use REST API endpoint for C8run deployment instructions#7706

Merged
bojtospeter merged 10 commits intomainfrom
copilot/update-documentation-to-rest-api
Mar 2, 2026
Merged

docs: use REST API endpoint for C8run deployment instructions#7706
bojtospeter merged 10 commits intomainfrom
copilot/update-documentation-to-rest-api

Conversation

Copy link
Contributor

Copilot AI commented Jan 12, 2026

Description

Updated C8run documentation to default to REST API endpoint (http://localhost:8080) instead of gRPC endpoint (http://localhost:26500) for deployment and interaction instructions, while keeping gRPC endpoint documented for reference.

Changes:

  • Desktop Modeler deployment instructions now use http://localhost:8080 (C8run) and http://localhost:8088 (Docker Compose)
  • gRPC endpoint (http://localhost:26500) remains documented in available endpoints and APIs sections

Files modified:

  • Getting started guides (example and human tasks)
  • C8run quickstart documentation
  • Docker Compose deployment instructions
  • Versioned docs (8.8)

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support. (add bug or support label)
  • This is already available but undocumented and should be released within a week. (add available & undocumented label)
  • This is on a specific schedule and the assignee will coordinate a release with the Documentation team. (create draft PR and/or add hold label)
  • This is part of a scheduled alpha or minor. (add alpha or minor label)
  • There is no urgency with this change (add low prio label)

PR Checklist

  • The commit history of this PR is cleaned up, using {type}(scope): {description} commit message(s)

  • My changes are for an upcoming minor release and are in the /docs directory (version 8.9).

  • My changes are for an already released minor and are in a /versioned_docs directory.

  • I added a DRI, team, or delegate as a reviewer for technical accuracy and grammar/style:

Original prompt

This section details on the original issue you should resolve

<issue_title>Use REST API endpoint for C8run in every documentation</issue_title>
<issue_description>As we have defaulted everything to REST, we should modify all documentation pointing to c8run deployment and interactions to use the REST endpoint instead of the gRPC one.

Context can be found in this slack thread: https://camunda.slack.com/archives/C050G7VJWJV/p1768207188659049</issue_description>

<agent_instructions>The one we want everywhere to use: Orchestration Cluster REST API: http://localhost:8080/
The one we want to get rid and not to use: Zeebe API (gRPC): http://localhost:26500/
</agent_instructions>

Comments on the Issue (you are @copilot in this section)


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits January 12, 2026 11:17
…d of gRPC

Co-authored-by: bojtospeter <1325943+bojtospeter@users.noreply.github.com>
…default

Co-authored-by: bojtospeter <1325943+bojtospeter@users.noreply.github.com>
@bojtospeter
Copy link
Contributor

@copilot don't change the package-lock.json file in your PR

Co-authored-by: bojtospeter <1325943+bojtospeter@users.noreply.github.com>
Copilot AI changed the title [WIP] Update documentation to use REST API endpoint for C8run docs: use REST API endpoint for C8run deployment instructions Jan 12, 2026
Copilot AI requested a review from bojtospeter January 12, 2026 11:30
Copy link
Contributor Author

Copilot AI commented Jan 12, 2026

@copilot don't change the package-lock.json file in your PR

Done. Reverted the package-lock.json changes in commit 01dce82. The PR now only includes documentation changes.

@bojtospeter bojtospeter requested a review from a team January 12, 2026 11:34
@camunda-docs-pr-automation camunda-docs-pr-automation bot moved this to 👀 In Review in Documentation Team Jan 12, 2026
@bojtospeter bojtospeter requested review from a team and hamza-m-masood and removed request for a team January 12, 2026 11:34
MaxTru
MaxTru previously requested changes Jan 13, 2026
Copy link
Collaborator

@MaxTru MaxTru left a comment

Choose a reason for hiding this comment

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

As discussed here, let's include v2

@camunda camunda deleted a comment from Copilot AI Jan 13, 2026
@mesellings mesellings requested review from zaycodes and removed request for a team January 13, 2026 10:07
@mesellings
Copy link
Collaborator

@zaycodes can you take a look at this one please? 🙏

bojtospeter
bojtospeter previously approved these changes Jan 13, 2026
Removed sections on Docker Compose URLs, Deploy diagrams from Desktop Modeler, and Use built-in and custom connectors.
@github-actions
Copy link
Contributor

github-actions bot commented Jan 13, 2026

👋 🤖 🤔 Hello, @bojtospeter! Did you make your changes in all the right places?

These files were changed only in versioned_docs/version-8.8/. You might want to duplicate these changes in docs/.

  • versioned_docs/version-8.8/self-managed/quickstart/developer-quickstart/c8run.md

You may have done this intentionally, but we wanted to point it out in case you didn't. You can read more about the versioning within our docs in our documentation guidelines.

@bojtospeter
Copy link
Contributor

The unversionedc8run.md does not contain any information about usage (due to Operate not working with H2). So it's intentional not to have it in the PR right now.

@bojtospeter bojtospeter marked this pull request as ready for review January 16, 2026 10:37
@christinaausley
Copy link
Contributor

It looks like @zaycodes never got around to this one, as she's out on leave I might add @giorgionaps? Unsure of the status here but let me know if I can help or review?

Copy link
Contributor

@giorgionaps giorgionaps left a comment

Choose a reason for hiding this comment

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

LGTM!

@bojtospeter bojtospeter dismissed their stale review February 28, 2026 21:22

I've approved my own PR

@bojtospeter
Copy link
Contributor

hey @christinaausley it seems @giorgionaps 's approval is not enough to merge, can you take a look please?

@christinaausley christinaausley dismissed MaxTru’s stale review March 2, 2026 22:40

resolved in commit

@bojtospeter bojtospeter merged commit 2c4ee21 into main Mar 2, 2026
7 checks passed
@bojtospeter bojtospeter deleted the copilot/update-documentation-to-rest-api branch March 2, 2026 22:40
@github-project-automation github-project-automation bot moved this from 👀 In Review to ✅ Done in Documentation Team Mar 2, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

Status: ✅ Done

Development

Successfully merging this pull request may close these issues.

Use REST API endpoint for C8run in every documentation

6 participants