Updating IDP Homepage Docs #39393
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -5,54 +5,91 @@ description: The Internal Developer Portal Homepage gives you a centralized view | |||||||||||||||||||
| aliases: | ||||||||||||||||||||
| - /software_catalog/developer_homepage | ||||||||||||||||||||
| - /internal_developer_portal/developer_homepage | ||||||||||||||||||||
| further_reading: | ||||||||||||||||||||
| - link: "https://www.datadoghq.com/blog/datadog-idp-homepage/" | ||||||||||||||||||||
| tag: "Blog" | ||||||||||||||||||||
| text: "Start your day with the IDP Homepage" | ||||||||||||||||||||
| - link: "/integrations/github/" | ||||||||||||||||||||
| tag: "Documentation" | ||||||||||||||||||||
| text: "Learn about the GitHub Integration" | ||||||||||||||||||||
| - link: "/integrations/gitlab-source-code/" | ||||||||||||||||||||
| tag: "Documentation" | ||||||||||||||||||||
| text: "Learn about the GitLab Integration" | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. "Integration" isn't a proper noun here. This link goes to GitLab Source Code, so use that name.
Suggested change
|
||||||||||||||||||||
| - link: "/integrations/jira/#configure-a-jira-webhook" | ||||||||||||||||||||
| tag: "Documentation" | ||||||||||||||||||||
| text: "Learn about the Jira Integration" | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. "Integration" isn't a proper noun here.
Suggested change
|
||||||||||||||||||||
| - link: "/integrations/linear/#configure-a-linear-webhook" | ||||||||||||||||||||
| tag: "Documentation" | ||||||||||||||||||||
| text: "Learn about the Linear Integration" | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. "Integration" isn't a proper noun here.
Suggested change
|
||||||||||||||||||||
| --- | ||||||||||||||||||||
|
|
||||||||||||||||||||
| {{< img src="tracing/software_catalog/idp_homepage.png" alt="IDP Homepage showing a personalized view of pull requests awaiting review and tickets" style="width:100%;" >}} | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Alt text must be a complete sentence and end with a period.
Suggested change
Contributor
There was a problem hiding this comment. Don't overwrite |
||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Overview | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The [IDP Homepage][5] provides a centralized view of your team's entities and your daily tasks. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| With this view, you can: | ||||||||||||||||||||
| - View key information about your team's entities, including scorecards, recent deployments, monitors, issues, incidents, dashboards, and on-call status. | ||||||||||||||||||||
| - Track tasks assigned to you across GitHub, GitLab, Jira, and Linear. | ||||||||||||||||||||
| - Identify alerting monitors or failed deployments. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Prerequisites | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The Homepage aggregates data from your Datadog integrations. To populate the task sections, configure the following integrations and webhooks before using the Homepage: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **GitHub**: An administrator installs and configures the GitHub integration, and sets up a GitHub webhook so that repository events (such as pull request activity) reach Datadog in real time. The **GitHub PRs** section requires this webhook to display current pull request data. Each user also signs in with their own GitHub account to load the pull requests relevant to them. For setup steps, see [GitHub][1]. | ||||||||||||||||||||
| - **GitLab**: An administrator installs and configures the GitLab integration and sets up a GitLab webhook so that repository events (such as merge request activity) reach Datadog in real time. The **GitLab** tab in the **Your PRs** section requires this integration to display current merge request data. Each user also signs in with their own GitLab account to load the merge requests relevant to them. For setup steps, see [GitLab][2]. | ||||||||||||||||||||
| - **Jira**: Configure the Jira integration, and set up a Jira webhook so that issue events reach Datadog. The **Jira** tab in the **Your Tickets** section requires this webhook to display your assigned issues. For setup steps, see [Configure a Jira webhook][3]. | ||||||||||||||||||||
| - **Linear**: An administrator installs the Linear integration and sets up a Linear webhook so that issue events reach Datadog. The **Linear** tab in the **Your Tickets** section requires this integration to display your assigned issues. After setup, Datadog detects your assigned issues automatically. For setup steps, see [Configure a Linear webhook][4]. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Configure the Homepage | ||||||||||||||||||||
|
|
||||||||||||||||||||
| To personalize the Homepage, click **Configure** at the top of the [IDP Homepage][5]. The **Homepage settings** panel opens with two tabs: **Section layout** and **Integrations**. After you make changes, click **Save** to apply them, or **Cancel** to discard them. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Lead with the action.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Section layout | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Section layout** tab controls which sections appear on the Homepage and the order in which they display. The available sections are **Your PRs**, **Your Tickets**, **Services & Entities**, and **Apps**. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Add a colon before the list of sections.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| - To reorder a section, drag it by its handle to a new position. | ||||||||||||||||||||
| - To show or hide a section, click the visibility icon next to it. | ||||||||||||||||||||
| - To restore the default sections and order, click **Reset Layout**. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Integrations | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Integrations** tab controls which integrations are enabled and what each one shows on the Homepage. Integrations are grouped by the section they populate, such as **PRs** and **Work Items**. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| Each integration has a toggle to enable or disable it. When you disable an integration, its data no longer appears on the Homepage. Depending on the integration, you can also: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Select which connected account, instance, or organization to display. For example, the GitLab integration includes an **Instance** selector. | ||||||||||||||||||||
| - Open the integration's configuration to manage its connection. For example, the GitHub integration includes a **Configure** option. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Your PRs | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Your PRs** section consolidates your personal action items from source control, so you can track the pull requests and merge requests assigned to you without leaving the Homepage. Switch between the **GitHub** and **GitLab** tabs to view each source | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Looks like a truncated copy of the Your Tickets intro.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| {{< img src="tracing/software_catalog/your_prs_table.png" alt="PRs assigned to the user" style="width:100%;" >}} | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Alt text must be a complete sentence and end with a period.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### GitHub | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **GitHub** tab consolidates your personal action items from GitHub, displaying PRs in the following states: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Needs your review** | ||||||||||||||||||||
| - **Returned to you** | ||||||||||||||||||||
| - **Approved** | ||||||||||||||||||||
| - **Waiting for reviewers** | ||||||||||||||||||||
| - **Recently merged** | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. The new GitHub screenshot shows a Drafts group, and the GitLab tab lists it.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| Each PR includes: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Repository and PR number** | ||||||||||||||||||||
| - **Title** | ||||||||||||||||||||
| - **Status** (Open / Draft / Merged) | ||||||||||||||||||||
| - **Assignee / Reviewer** | ||||||||||||||||||||
|
|
||||||||||||||||||||
| This tab requires two setup steps, in order: an administrator connects the GitHub integration for the organization, and each user signs in with their own GitHub account. After you authorize access, the tab loads your pull requests, grouped by status. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Trimming this keeps the GitHub and GitLab tabs parallel. The permissions list and empty-state prompt below are still worth keeping; they aren't in Prerequisites.
Suggested change
Contributor
There was a problem hiding this comment. If you keep these setup steps rather than trimming them as suggested on this paragraph, use a numbered list. Sequential steps shouldn't live in one sentence.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| If your organization has not configured the GitHub integration, this tab displays an empty state with a prompt to enable it from the [GitHub integration tile][1]. To read PRs from GitHub, this integration requires the following permissions: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - Members: Read | ||||||||||||||||||||
| - Metadata: Read | ||||||||||||||||||||
|
|
@@ -61,13 +98,42 @@ If your organization has not configured the GitHub integration, this section dis | |||||||||||||||||||
| - Statuses: Read | ||||||||||||||||||||
| - Checks: Read | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The tab also requires a configured GitHub webhook so that pull request events reach Datadog in real time. For setup steps, see [GitHub][1]. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Delete this line. Webhook setup and the GitHub docs link are already in Prerequisites, and the empty-state sentence above already links the GitHub tile. |
||||||||||||||||||||
|
|
||||||||||||||||||||
| If you have multiple GitHub orgs connected within Datadog, users must have the Datadog Integrations Read Permissions to toggle between orgs. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ### GitLab | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **GitLab** tab consolidates your personal action items from GitHub, displaying merge requests in the following states: | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Copy-paste from the GitHub tab.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Needs your review** | ||||||||||||||||||||
| - **Returned to you** | ||||||||||||||||||||
| - **Approved** | ||||||||||||||||||||
| - **Waiting for reviewers** | ||||||||||||||||||||
| - **Drafts** | ||||||||||||||||||||
| - **Recently merged** | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Each merge request includes: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Title and MR number**, with the author who opened it | ||||||||||||||||||||
| - **Project or repository context** and **labels** | ||||||||||||||||||||
| - **Status** (for example, Open, Draft, or Merged) | ||||||||||||||||||||
| - **Pipeline status**, including pipeline failures and other merge blockers | ||||||||||||||||||||
| - **Reviewers, approvers, and review state** | ||||||||||||||||||||
| - **Comment counts**, including resolved and unresolved discussion counts | ||||||||||||||||||||
| - **Age**, shown as the time since the last update | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Like GitHub, this tab requires two setup steps, in order: an administrator connects the GitLab integration for the organization, and each user signs in with their own GitLab account. After you authorize access, the tab loads your merge requests, grouped by status. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Prerequisites already cover the GitLab Source Code integration and webhook. Repeating them here is what drifted out of sync with the GitHub tab.
Suggested change
Contributor
There was a problem hiding this comment. Same as GitHub: if you keep these steps rather than trimming them, use a numbered list.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| If your organization has not configured the GitLab integration, this tab displays an empty state with a prompt to enable it from the GitLab integration tile. For setup steps, see [GitLab Source Code][2]. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Link the tile like GitHub, use the GitLab Source Code name, and drop the extra "For setup steps" clause — the tile is the setup path from an empty state.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| If you have multiple GitLab instances connected within Datadog, use the **Instance** selector to choose which instance to view. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Your tickets | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Your Tickets** section consolidates the items assigned to you across Jira, Linear, and Datadog Work Management, so you can track your open work without leaving the Homepage. Switch between the **Jira**, **Linear**, and **Work Items** tabs to view each source, and use **Display** to change how items are shown. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| {{< img src="tracing/software_catalog/your_tickets_table.png" alt="Tickets assigned to the user" style="width:100%;" >}} | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Alt text must be a complete sentence and end with a period.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Jira | ||||||||||||||||||||
|
|
||||||||||||||||||||
|
|
@@ -82,6 +148,22 @@ The **Jira** tab lists the Jira tickets assigned to you, grouped by status categ | |||||||||||||||||||
| - **Due** | ||||||||||||||||||||
| - **Assignee** | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Delete this list item. The new Your Tickets screenshot has no Assignee column, and Linear's list below already matches that. |
||||||||||||||||||||
|
|
||||||||||||||||||||
| An administrator configures the Jira integration and sets up a Jira webhook so that issue events reach Datadog. After setup, your assigned tickets appear automatically. For setup steps, see [Configure a Jira webhook][3]. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Same trim as Linear so the two ticket tabs stay parallel.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Linear | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Linear** tab lists the Linear issues assigned to you, grouped by status category: **To Do**, **In Progress**, and **Done**. Each issue includes: | ||||||||||||||||||||
|
|
||||||||||||||||||||
| - **Key** | ||||||||||||||||||||
| - **Title** | ||||||||||||||||||||
| - **Status** | ||||||||||||||||||||
| - **Created** | ||||||||||||||||||||
| - **Updated** | ||||||||||||||||||||
| - **Priority** | ||||||||||||||||||||
| - **Due** | ||||||||||||||||||||
|
|
||||||||||||||||||||
| An administrator authorizes the Linear integration for the organization. After setup, Datadog detects your assigned issues, and they appear automatically. For setup steps, see [Linear][4]. | ||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. Same as GitLab: keep setup in Prerequisites so these sections don't drift.
Suggested change
|
||||||||||||||||||||
|
|
||||||||||||||||||||
| ### Work Items | ||||||||||||||||||||
|
|
||||||||||||||||||||
| The **Work Items** tab lists the Datadog Work Management work items assigned to you, grouped by status: **Open**, **In Progress**, and **Closed**. Each group shows a count. | ||||||||||||||||||||
|
|
@@ -96,7 +178,7 @@ Each work item includes: | |||||||||||||||||||
| - **Due date** | ||||||||||||||||||||
| - **Assignee** | ||||||||||||||||||||
|
|
||||||||||||||||||||
| Work items appear automatically when they are assigned to you. For more information, see [Work Management][6]. | ||||||||||||||||||||
|
|
||||||||||||||||||||
| ## Services and entities | ||||||||||||||||||||
|
|
||||||||||||||||||||
|
|
@@ -139,8 +221,11 @@ To add an app to the Homepage: | |||||||||||||||||||
| {{< partial name="whats-next/whats-next.html" >}} | ||||||||||||||||||||
|
|
||||||||||||||||||||
| [1]: /integrations/github/ | ||||||||||||||||||||
| [2]: /integrations/gitlab-source-code/ | ||||||||||||||||||||
| [3]: /integrations/jira/#configure-a-jira-webhook | ||||||||||||||||||||
| [4]: /integrations/linear/#configure-a-linear-webhook | ||||||||||||||||||||
| [5]: https://app.datadoghq.com/idp/home | ||||||||||||||||||||
| [6]: /service_management/case_management | ||||||||||||||||||||
| [7]: /actions/app_builder/ | ||||||||||||||||||||
| [8]: /actions/datadog_apps | ||||||||||||||||||||
|
Comment on lines
+227
to
+230
Contributor
There was a problem hiding this comment. These |
||||||||||||||||||||
|
|
||||||||||||||||||||
|
Contributor
There was a problem hiding this comment. The new screenshots need to be added under new filenames, and you'll need to update the Markdown. More details here: https://datadoghq.atlassian.net/wiki/spaces/docs4docs/pages/1985314888/Screenshots+and+Videos#Update-Image-Repository. |
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Integration" isn't a proper noun here.