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

Update instructions to list source maps via node #4514

Merged
merged 3 commits into from
Oct 27, 2021

Conversation

afvalenciab
Copy link
Contributor

@afvalenciab afvalenciab commented Oct 25, 2021

  • What problems does this PR solve?
    Fix the instructions to list source maps via node, because the instructions are wrong and different to npm instrucctions.
  • Add any context that will help us review your changes such as testing notes,
    links to related docs, screenshots, etc.

Before:

`var listSourcemaps = require(‘@newrelic/publish-sourcemap’).listSourcemaps

listSourcemaps({
  sourcemapPath: 'SOURCE_MAP_FULL_PATH',
  javascriptUrl: 'JS_URL',
  applicationId: <var>YOUR_NEW_RELIC_APP_ID</var>,
  apiKey: '<var>YOUR_NEW_RELIC_USER_API_KEY</var>',
}, function (err, res) { console.log(err || res.body)})`

After:

` var listSourcemaps = require(‘@newrelic/publish-sourcemap’).listSourcemaps

listSourcemaps({
  applicationId: <var>YOUR_NEW_RELIC_APP_ID</var>,
  apiKey: '<var>YOUR_NEW_RELIC_USER_API_KEY</var>',
  limit: [Max number of results to return || 20]: ,
  offset: [Number of results to skip before returning || 0]: ,
}, function (err, res) { console.log(err || res.body)})`

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.

* Before:
var listSourcemaps = require(‘@newrelic/publish-sourcemap’).listSourcemaps

listSourcemaps({
  sourcemapPath: 'SOURCE_MAP_FULL_PATH',
  javascriptUrl: 'JS_URL',
  applicationId: YOUR_NEW_RELIC_APP_ID,
  apiKey: 'YOUR_NEW_RELIC_USER_API_KEY',
}, function (err, res) { console.log(err || res.body)})

* After:
    var listSourcemaps = require(‘@newrelic/publish-sourcemap’).listSourcemaps

    listSourcemaps({
      applicationId: <var>YOUR_NEW_RELIC_APP_ID</var>,
      apiKey: '<var>YOUR_NEW_RELIC_USER_API_KEY</var>',
      limit: [Max number of results to return || 20]: ,
      offset: [Number of results to skip before returning || 0]: ,
    }, function (err, res) { console.log(err || res.body)})
@CLAassistant
Copy link

CLAassistant commented Oct 25, 2021

CLA assistant check
All committers have signed the CLA.

@github-actions github-actions bot added this to Hero to triage in Docs PRs and Issues Oct 25, 2021
@github-actions
Copy link

Hi @afvalenciab 👋
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.

@zuluecho9 zuluecho9 moved this from Hero to triage to In progress/being reviewed (by Hero or any TW) in Docs PRs and Issues Oct 25, 2021
@zuluecho9 zuluecho9 self-assigned this Oct 25, 2021
@gatsby-cloud
Copy link

gatsby-cloud bot commented Oct 25, 2021

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: 27m

@zuluecho9 zuluecho9 self-requested a review October 25, 2021 20:30
@zuluecho9
Copy link
Contributor

@afvalenciab Hi Andres. Could you by chance give us a little more information on why you suggested that change? I'm trying to get some input from source map-knowledgeable people but in meantime I thought a little more detail about what you were thinking might help me/us get to the bottom of this.

And thank you very much for your suggestions!

@zuluecho9 zuluecho9 added content requests related to docs site content from_external Identifies issues/PRs from non-Relics labels Oct 27, 2021
@zuluecho9
Copy link
Contributor

@afvalenciab Actually, I talked to support and they approved this, so thank you much for that.

zuluecho9
zuluecho9 previously approved these changes Oct 27, 2021
@zuluecho9 zuluecho9 merged commit 0c32af2 into newrelic:develop Oct 27, 2021
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_external Identifies issues/PRs from non-Relics
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants