Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Sandra (neko) <[email protected]>
  • Loading branch information
domalessi and neko-dd authored Jan 20, 2025
1 parent d90bad8 commit bc4f07c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 12 deletions.
22 changes: 14 additions & 8 deletions content/en/service_catalog/use_cases/dependency-management.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,9 +37,9 @@ In [Service Catalog schema v3.0][2], teams can manually define relationships to

To define a manual dependency, update the `spec` section of the relevant entity definition using the following keys:

- ``dependsOn``: Specifies dependencies (e.g., Service A depends on Service B).
- ``ownedBy``: Assigns ownership to a team or group (e.g., Service A is owned by Team A).
- ``partOf``: Groups components under a system (e.g., Service A is part of System A).
- `dependsOn`: Specifies dependencies (for example, Service A depends on Service B).
- `ownedBy`: Assigns ownership to a team or group (for example, Service A is owned by Team A).
- `partOf`: Groups components under a system (for example, Service A is part of System A).

Example YAML configuration:

Expand All @@ -55,18 +55,24 @@ spec:
### View manual dependencies
To view manual dependencies in the Datadog app, navigate to [Service Catalog][1], select your service to open the side panel, find the Performance tab, and then select the Dependencies sub-tab. You can also open the full Service Page for a particular service and select the Dependencies section in the left-hand navigation.
To view manual dependencies in the Datadog app:
All dependencies, including manual dependencies, will be shown, and you can use the "Include Detected" feature to modify your view:
1. Navigate to [Service Catalog][1]
1. Select your service to open the side panel.
1. Find the Performance tab, then select the Dependencies sub-tab.
- When "Include Detected" is disabled: Only manually defined dependencies are shown.
- When "Include Detected" is enabled: Manually added dependencies are shown above auto-detected ones to create a clear distinction.
You can also open the full Service Page for a particular service and select the Dependencies section in the left-hand navigation.
All dependencies, including manual dependencies, are shown. You can use the "Include Detected" feature to modify your view:
- When **Include Detected** is disabled: Only manually defined dependencies are shown.
- When **Include Detected** is enabled: Manually added dependencies are shown above auto-detected ones to create a clear distinction.
{{< img src="tracing/service_catalog/dependency-mgmt-use-case-include-detected.png" alt="A diagram showing the dependencies of a service, where 'Include Detected' is disabled." >}}
### Benefits of manual dependency definitions
- Improved accuracy: By defining dependencies manually, teams can incorporate their specific understanding and insights into the Service Catalog, ensuring it accurately represents real-world system architectures, which automated tools might miss.
- Improved accuracy: By defining dependencies manually, teams can incorporate their specific understanding and insights into the Service Catalog, ensuring it accurately represents architectures of real-world systems that automated tools might miss.
- Enhanced collaboration: Manually defined dependencies support better communication and coordination by making relationships explicit, aiding in incident response efforts and strategic architecture planning.
- Contextual knowledge: Providing manual definitions helps developers and new team members quickly understand the complexities of system dependencies and architectures, facilitating smoother onboarding and knowledge transfer.
Expand Down
8 changes: 4 additions & 4 deletions content/en/service_catalog/use_cases/dev-onboarding.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ further_reading:
text: "Datadog Software Templates"
---

Datadog's Service Catalog automates key tasks and centralizes essential resources-such as docs, runbooks, [scorecards][1], and [templates][2]-to reduce time-to-first-commit and optimize the overall developer experience.
Datadog's Service Catalog automates key tasks and centralizes essential resources (such as docs, runbooks, [scorecards][1], and [templates][2]) to reduce time-to-first-commit and optimize the overall developer experience.

{{< img src="tracing/service_catalog/dev-onboarding-use-case-overview.png" alt="A service's home page, showing information like documentation and repository links, service owners, and on-call details." >}}

Expand All @@ -23,7 +23,7 @@ Datadog's Service Catalog automates key tasks and centralizes essential resource
Service Catalog acts as a single source of truth for your engineering environment. Newly onboarded developers can:

- Quickly locate relevant [APIs][3], services, repositories, and dependencies.
- Access up-to-date documentation, code snippets, and runbooks, and start to make meaningful contributions.
- Access up-to-date documentation, code snippets, and runbooks, enabling them to start making meaningful contributions.
- Navigate [organized metadata and organizational inventory][4] to understand the team's structure, communication channels, and best practices.

{{< img src="tracing/service_catalog/dev-onboarding-use-case-workflows.png" alt="The side panel view of an API in the service catalog, showing a flow chart of services that consume the API, an OpenAPI Preview, and API metadata." >}}
Expand All @@ -37,9 +37,9 @@ Service Catalog acts as a single source of truth for your engineering environmen
- Integrate with third-party tools and systems to ensure every new developer starts with the correct permissions, environments, and resources.
- Scale onboarding processes as your team grows while maintaining consistency and quality across new hires.

[Explore blueprints][5] to automate developer onboarding tasks.
[Explore App Builder blueprints][5] to automate developer onboarding tasks.

{{< img src="tracing/service_catalog/dev-onboarding-use-case-app-builder.png" alt="The app builder landing page, which shows pre-configured blueprints for commom dev workflows." >}}
{{< img src="tracing/service_catalog/dev-onboarding-use-case-app-builder.png" alt="The App Builder landing page, which shows pre-configured blueprints for common dev workflows." >}}


## Further reading
Expand Down

0 comments on commit bc4f07c

Please sign in to comment.