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

Fix: Updated/Added details around APIs and include quickstarts #16855

Merged
merged 3 commits into from
Apr 9, 2024

Conversation

adammarshallNR
Copy link
Contributor

Added link to the Synthetics Quickstarts library on github pages Updated Broken Link and Certificate Check API types Added rows for Nerdgraph, Terraform under additional features, noted REST API deprecation

Please follow conventional commit standards
in your commit messages and pull request title.

Give us some context

  • What problems does this PR solve?
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.
  • If your issue relates to an existing GitHub issue, please link to it.

Added link to the Synthetics Quickstarts library on github pages
Updated Broken Link and Certificate Check API types
Added rows for Nerdgraph, Terraform under additional features, noted REST API deprecation
@CLAassistant
Copy link

CLAassistant commented Apr 9, 2024

CLA assistant check
All committers have signed the CLA.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Apr 9, 2024
Copy link

github-actions bot commented Apr 9, 2024

Hi @adammarshallNR 👋

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.

We will automatically generate a preview of your request, and will comment with a link when the preview is ready (usually 10 to 20 minutes). If you add any more commits, you can comment netlify build on this PR to update the preview.

Copy link

netlify bot commented Apr 9, 2024

Deploy Preview for docs-website-netlify ready!

Name Link
🔨 Latest commit dc5761f
🔍 Latest deploy log https://app.netlify.com/sites/docs-website-netlify/deploys/6615a762c231e90008f24a1f
😎 Deploy Preview https://deploy-preview-16855--docs-website-netlify.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@akristen akristen self-assigned this Apr 9, 2024
@akristen akristen added content requests related to docs site content from_internal Identifies issues/PRs from Relics (except writers) labels Apr 9, 2024
…, added style edits, and fixed table that was creating errors
@akristen akristen requested a review from bpeckNR April 9, 2024 16:30
@akristen
Copy link
Contributor

akristen commented Apr 9, 2024

Hi @adammarshallNR ! I've added @bpeckNR as a reviewer to ensure that we're all in line about updating this doc. I want to explain some of my changes:

  • I went ahead and removed the videos in this doc, since we find that videos aren't enormously helpful. They were also both around 2 years old and we provide the same information by linking out to other docs or outright explaining the processes.
  • I updated the verbiage around our synthetics quickstarts. Since these are open source, we want to make sure that customers understand they are community-sourced and not supported by New Relic.
  • I also fixed some broken links in the doc as well.

Once Brian approves these changes, I might take the opportunity to give this doc a freshness update and soften out the edges. Thanks a bunch for filing this PR!

@akristen akristen moved this from Hero to triage to In review in Docs PRs and Issues Apr 9, 2024
id="EN5FkIW8YWk"
type="youtube"
/>
You can view community-sourced examples of some synthetic monitors in our [synthetics quickstarts](https://newrelic.github.io/quickstarts-synthetics-library/#/). These examples are open source and not supported by New Relic, but may provide valuable examples of how to maximize your synthetic monitors view examples of
Copy link
Contributor

Choose a reason for hiding this comment

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

I like the call out about these examples being open source and not supported by New Relic. It looks like the sentence about the examples has an extra "view examples of" at the end. Maybe we should change it to something like this:

These examples are open source and not supported by New Relic, but contain valuable scripts and snippets that may help you cover common use cases in scripted API and scripted browser monitors.

Copy link
Contributor

Choose a reason for hiding this comment

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

I like it! i'll add this in

@akristen akristen merged commit 0c66618 into newrelic:develop Apr 9, 2024
13 checks passed
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

4 participants