Skip to content

Add explicit docs for multi-source services#605

Merged
michaeljguarino merged 1 commit into
mainfrom
multi-source-docs
May 25, 2026
Merged

Add explicit docs for multi-source services#605
michaeljguarino merged 1 commit into
mainfrom
multi-source-docs

Conversation

@michaeljguarino
Copy link
Copy Markdown
Member

Just uses our datastore operator example, which is a good operator + cr case

Plural Flow: docs
Plural Preview: docs

@michaeljguarino michaeljguarino requested a review from a team as a code owner May 25, 2026 02:35
Copy link
Copy Markdown
Contributor

@plural-copilot plural-copilot Bot left a comment

Choose a reason for hiding this comment

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

✅ Deploy preview for docs-pr-605 is ready!

Name Details
⚡ Service docs-pr-605 (5 / 5 ready)
☁️ Cluster plural (eks)
:octocat: Commit sha ab8a626
Plural URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🔍 Logs URL https://console.mgmt.plural.sh/cd/clusters/446acdef-8524-425a-a49f-5336a...
🌊 Flow URL https://console.mgmt.plural.sh/flows/08a17af1-8578-449e-9ae1-28ccd97eafc...
Preview Link Preview

You can learn more about preview environments and Plural Flows here

@greptile-apps
Copy link
Copy Markdown
Contributor

greptile-apps Bot commented May 25, 2026

Greptile Summary

This PR adds a new multi-source-services.md documentation page explaining how to combine Helm charts and Git manifests in a single ServiceDeployment, and wires it into the nav and the existing helm-service.md with a cross-reference.

  • The new page covers spec.sources, spec.renderers, apply ordering with sync waves, and a worked datastore-operator example; callout syntax and internal links all match project conventions.
  • The cross-reference added to helm-service.md is placed between the "It would look like so:" sentence and the code block it introduces, slightly disrupting the reading flow; moving it before or after that sentence+block pair would read more naturally.

Confidence Score: 4/5

Safe to merge; the only concern is a minor prose flow issue in helm-service.md.

The new documentation page is well-structured and accurate, and the nav registration is correct. The one rough edge is that the cross-reference in helm-service.md interrupts the "It would look like so:" → code block sequence, making that paragraph read awkwardly.

The cross-reference placement in helm-service.md is worth a quick look before merging.

Important Files Changed

Filename Overview
pages/plural-features/continuous-deployment/multi-source-services.md New documentation page for multi-source services; content is accurate, callout syntax matches project conventions, and all internal links resolve to existing files.
pages/plural-features/continuous-deployment/helm-service.md Adds a cross-reference to the new multi-source-services page; placement between intro prose and its code block slightly disrupts the reading flow.
src/routing/docs-structure.ts Inserts the new multi-source-services entry into the nav between helm-service and resource-application-logic; no issues.

Reviews (1): Last reviewed commit: "Add explicit docs for multi-source servi..." | Re-trigger Greptile

Comment on lines 68 to 72
Say you want to source the helm templates from an upstream helm repository, but the values files from a Git repository. In that case, you can define a multi-sourced service, which has both a git and helm repository defined. It would look like so:

For more advanced compositions—such as deploying an operator from Helm alongside custom resources from Git using explicit `sources` and `renderers`—see [Multi-source services](multi-source-services.md).

```yaml
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

P2 The cross-reference to multi-source services is inserted between "It would look like so:" and the code block that sentence introduces, which breaks the reading flow. The forward-reference reads better either before the "It would look like so:" sentence or directly after the closing code block.

Suggested change
Say you want to source the helm templates from an upstream helm repository, but the values files from a Git repository. In that case, you can define a multi-sourced service, which has both a git and helm repository defined. It would look like so:
For more advanced compositions—such as deploying an operator from Helm alongside custom resources from Git using explicit `sources` and `renderers`—see [Multi-source services](multi-source-services.md).
```yaml
Say you want to source the helm templates from an upstream helm repository, but the values files from a Git repository. In that case, you can define a multi-sourced service, which has both a git and helm repository defined. It would look like so:
```yaml

Note: If this suggestion doesn't match your team's coding style, reply to this and let me know. I'll remember it for next time!

Just uses our datastore operator example, which is a good operator + cr case
@michaeljguarino michaeljguarino merged commit a0b632e into main May 25, 2026
11 checks passed
@michaeljguarino michaeljguarino deleted the multi-source-docs branch May 25, 2026 02:47
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant