Add explicit docs for multi-source services#605
Conversation
There was a problem hiding this comment.
✅ Deploy preview for docs-pr-605 is ready!
| Name | Details |
|---|---|
| ⚡ Service | docs-pr-605 (5 / 5 ready) |
| ☁️ Cluster | plural (eks) |
| ab8a626 | |
| 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
8649049 to
4b0ab0a
Compare
Greptile SummaryThis PR adds a new
Confidence Score: 4/5Safe 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 The cross-reference placement in
|
| 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
| 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 |
There was a problem hiding this comment.
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.
| 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
4b0ab0a to
ab8a626
Compare
Just uses our datastore operator example, which is a good operator + cr case
Plural Flow: docs
Plural Preview: docs