Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat(Catalog) New document for GitHub Integration for Service Catalog #19384

Draft
wants to merge 3 commits into
base: develop
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
---
title: Seamlessly adopt New Relic Catalog with the GitHub integration
tags:
- New Relic integrations
- GitHub integration
metaDescription: Set up automatic ingestion of your GitHub Dependabot events by using webhook for ongoing ingestion.
freshnessValidatedDate: never
---

<Callout variant="tip" title="PREVIEW">

We're still working on this feature, but we'd love for you to try it out!

This feature is currently provided as part of a preview program pursuant to our [pre-release policies](/docs/licenses/license-information/referenced-policies/new-relic-pre-release-policy).
</Callout>


Unlock seamless efficiency in New Relic with GitHub automation!

Onboard your users and teams in New Relic to enhance your New Relic Catalog's visibility. This integration simplifies user and team onboarding, managing roles, and mapping entity ownership. This significantly reduces the setup configuration, time, and effort. Leverage this seamless connection to boost Catalog visibility and use Scorecards for performance assessment against defined standards. For more information, refer [New Relic Catalog](https://docs-preview.newrelic.com/docs/catalogs/). ```Question to SME: Where this information be available? Will it be on Teams or somewhere else?```

**IMAGE**

{/* <img
title="GitHub Integration dashboard"
alt="GitHub Integration dashboard"
src="/images/github-integration-screenshot.webp"
/> NEW IMAGE REQUIRED

<figcaption>
After setting up our GitHub integration, see your data of teams, repos and users right out of the box.
</figcaption>

*/}



## Prerequisites [#prerequisites]

* Login to your [GitHub account](). This account must be the same GitHub account you want to use use in the New Relic.
```{Question to SME: Does the user needs to have any specific permissions in the GitHub account?}```


## Set up the GitHub integration [#set-up-github]

To set up the GitHub integration:

<Steps>
<Step>

Go to <DNT>**[one.newrelic.com > All capabilities](https://one.newrelic.com/all-capabilities) > + Integrations & Agents** > GitHub integration</DNT> tile.

</Step>

<Step>

## Catalog Details [#catalog-details]

Enable or disable the Power Catalog option. This option provides users the ability to import all data related to teams, repositories, pull requests, pull request reviews, and deployments.`{Question to SME: where is this power catalog option available?}` You can:

* Enable it to import all the items mentioned in the Power Catalog.
* Disable it to import only basic information about the teams and repositories.

</Step>

<Step>

## GitHub Integration [#github-integration]

{/* <img
title="GitHub Integration dashboard"
alt="GitHub Integration dashboard"
src="/images/github-integration-progress.webp"
/> NEW IMAGE REQUIRED
*/}


On the <DNT>GitHub integration</DNT> tile, click <DNT>**Install**</DNT>. The installation page loads to fetch the user's GitHub account information..

Once the installation is complete, the result page which will dynamically list down all the retrieved GitHub data related to teams, repos, pull requests, and deployments.

<Callout variant="tip" title="PREVIEW">

It takes some time to fetch the information, hence the page will auto refresh in every 10 seconds till the power Catalog `{need more information on this power Catalog}` gets ready.

</Callout>


The following information are retrieved from GitHub:

Check notice on line 89 in src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx

View workflow job for this annotation

GitHub Actions / vale

[vale] src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx#L89

[Microsoft.Passive] 'are retrieved' looks like passive voice.
Raw output
{"message": "[Microsoft.Passive] 'are retrieved' looks like passive voice.", "location": {"path": "src/content/docs/infrastructure/host-integrations/host-integrations-list/github-integration.mdx", "range": {"start": {"line": 89, "column": 27}}}, "severity": "INFO"}

| Category | Content |
| -------- | ------- |
| Teams | A List of teams in the GitHub organization. |
| Repositories | A List of repositories owned by the integrated GitHub account. |
| Pull Requests | A List of open and closed pull requests. |
| Deployments | A List of deployment events. |

You can click on individual links to view detailed information in new tab:

***IMAGE***

{/* <img
title="GitHub Integration dashboard"
alt="GitHub Integration dashboard"
src="/images/github-integration-success.webp"
/> NEW IMAGE REQUIRED
*/}

</Step>
</Steps>

To learn more about installing GitHub apps to your account, visit [GitHub Marketplace docs](https://docs.github.com/en/apps/using-github-apps/installing-a-github-app-from-github-marketplace-for-your-organizations).`{Question to SME: Do we need this? This is Relic Docs, not GitHub Docs.}`
2 changes: 2 additions & 0 deletions src/nav/infrastructure.yml
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ pages:
path: /docs/infrastructure/host-integrations/host-integrations-list/envoy-integration
- title: F5 integration
path: /install/f5
- title: GitHub Integration
path: /docs/infrastructure/host-integrations/host-integrations-list/github-integration
- title: HAProxy integration
path: /install/haproxy
- title: HashiCorp Consul integration
Expand Down
Loading