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: new circleci guide (DOC-7895) #7107

Merged
merged 6 commits into from
Apr 27, 2022
Merged

Conversation

jcountsNR
Copy link
Contributor

New guide for circleci/new relic integration.

IMPORTANT: I need help from the dev team to decide where this lives both in the repo and in the website as a whole.

A lot of the template I used came from the existing cloudflare doc since this is a very similar page, only for CircleCI.

The guide covers 2 main areas:

  1. how to set up a circleCI webhook to send logs to new relic
  2. what you can do in New Relic with those logs (mainly the quickstart already built)

@github-actions
Copy link

Hi @jcountsNR 👋
Thanks for your pull request! Your PR is in a queue, and a writer will take a look soon. We generally publish small edits within one business day, and larger edits within three days.

Gatsby Cloud will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 20 to 30 minutes).

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Apr 14, 2022
@gatsby-cloud
Copy link

gatsby-cloud bot commented Apr 14, 2022

Gatsby Cloud Build Report

docs-website-develop

🎉 Your build was successful! See the Deploy preview here.

Build Details

View the build logs here.

🕐 Build time: 22m

@paperclypse paperclypse changed the title feat: new circleci guide feat: new circleci guide (DOC-7895) Apr 14, 2022
@paperclypse
Copy link
Contributor

The person assigned to this Jira work will review and update this draft.

@paperclypse paperclypse marked this pull request as draft April 14, 2022 23:22
@paperclypse paperclypse moved this from Hero to triage to Drafts in Docs PRs and Issues Apr 14, 2022
@paperclypse paperclypse added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Apr 14, 2022
@paperclypse paperclypse self-assigned this Apr 27, 2022
@paperclypse paperclypse marked this pull request as ready for review April 27, 2022 21:59
@paperclypse paperclypse moved this from Drafts to Needs review in Docs PRs and Issues Apr 27, 2022
bradleycamacho
bradleycamacho previously approved these changes Apr 27, 2022
Copy link
Contributor

@bradleycamacho bradleycamacho left a comment

Choose a reason for hiding this comment

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

Looks good, just a few style edits


4. In the sidebar of your Project Settings, click **Webhooks**.

5. Click **Add Webhook**.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
5. Click **Add Webhook**.
5. Click **Add webhook**.

Copy link
Contributor

Choose a reason for hiding this comment

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

These are CircleCI UI things. I have to trust that they're capitalized correctly.

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh this is an interesting situation! Our style guide says we use sentence case and bold for UI elements, even if the UI element is in a different case in the UI, but maybe that should only apply to our product and not when we reference other products?


6. Name your webhook.

7. Enter New Relic's **Logs Endpoint**:
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
7. Enter New Relic's **Logs Endpoint**:
7. Enter New Relic's **Logs endpoint**:


8. Select either **Workflow** or **Job**, depending on the type of event you want to trigger the logpush.

9. If you've set up your receiving API or third-party service, click **Test Ping Event** to create a test event.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
9. If you've set up your receiving API or third-party service, click **Test Ping Event** to create a test event.
9. If you've set up your receiving API or third-party service, click **Test ping event** to create a test event.

paperclypse and others added 2 commits April 27, 2022 15:43
Co-authored-by: Bradley Camacho <42678939+bradleycamacho@users.noreply.github.com>
@paperclypse
Copy link
Contributor

@bradleycamacho I'm not going to commit your changes, because these are CircleCI UI procedures and I'm assuming that they're capitalized correctly.

@bradleycamacho
Copy link
Contributor

@paperclypse happy to defer to you on this, just want to ensure you saw that one comment above!

Oh this is an interesting situation! Our style guide says we use sentence case and bold for UI elements, even if the UI element is in a different case in the UI, but maybe that should only apply to our product and not when we reference other products?

@paperclypse
Copy link
Contributor

@bradleycamacho In this case, I think we want to prioritize trying to get this published today and then circle back later, if necessary.

@paperclypse paperclypse reopened this Apr 27, 2022
Docs PRs and Issues automation moved this from Needs review to Hero to triage Apr 27, 2022
@paperclypse paperclypse moved this from Hero to triage to In progress in Docs PRs and Issues Apr 27, 2022
@jcountsNR
Copy link
Contributor Author

@bradleycamacho In this case, I think we want to prioritize trying to get this published today and then circle back later, if necessary.

Just to add to this, the CircleCI doc link is here, I made the casing the same as the casing they used on their site. I don't have any insight as to whether our casing style should supersede theirs or not.

@paperclypse paperclypse merged commit 1e0c271 into newrelic:develop Apr 27, 2022
@paperclypse
Copy link
Contributor

@jcountsNR I wanted to make sure we got this into the afternoon release. We can go back and edit the casing later, if need be.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers)
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants