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

chore: Remove examples/shim #2484

Merged
merged 5 commits into from
Aug 19, 2024

Conversation

amychisholm03
Copy link
Contributor

@amychisholm03 amychisholm03 commented Aug 16, 2024

Removed the examples/shim folder, added instrumentation.md to redirect users, and updated jsdoc

@amychisholm03 amychisholm03 linked an issue Aug 16, 2024 that may be closed by this pull request
@amychisholm03 amychisholm03 changed the title chore: remove examples/shim chore: Remove examples/shim Aug 16, 2024
Copy link
Member

@bizob2828 bizob2828 left a comment

Choose a reason for hiding this comment

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

You need to add a jsdoc.json so we can have a page in https://newrelic.github.io/node-newrelic/ that will publish this markdown.

If you run npm run public-docs this now fails because it's expecting examples/shim. you can just update the public-docs script to include documentation/examples.md

@amychisholm03 amychisholm03 marked this pull request as ready for review August 19, 2024 18:07
jsumners-nr
jsumners-nr previously approved these changes Aug 19, 2024
Copy link
Contributor

@jsumners-nr jsumners-nr 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 over here. npm run public-docs results in the desired output as far as I can tell.

@@ -0,0 +1,14 @@
# node-newrelic examples
Copy link
Member

Choose a reason for hiding this comment

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

not sure you need this. because when it renders in a tutorial it has a title

Copy link
Member

Choose a reason for hiding this comment

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

this header is still there

Copy link
Member

@bizob2828 bizob2828 left a comment

Choose a reason for hiding this comment

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

found one thing

examples/instrumentation.md Outdated Show resolved Hide resolved
Co-authored-by: Bob Evans <robert.evans25@gmail.com>
@amychisholm03 amychisholm03 merged commit 40d1f5c into newrelic:main Aug 19, 2024
17 checks passed
@amychisholm03 amychisholm03 deleted the remove-examples-shim branch August 19, 2024 20:42
@bizob2828 bizob2828 added the documentation Improvements or additions to documentation label Aug 26, 2024
@github-actions github-actions bot mentioned this pull request Aug 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Delete examples/shim folder
3 participants