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.

Sign up for GitHub

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

Jump to bottom

Update 3rd party component docs : By Jan 29th #895

Closed
jpvajda opened this issue Oct 26, 2020 · 4 comments · Fixed by #1070
Closed

Update 3rd party component docs : By Jan 29th #895

jpvajda opened this issue Oct 26, 2020 · 4 comments · Fixed by #1070
Assignees
@jerelmiller @jpvajda @timglaser
Labels
documentation Improvements or additions to documentation sp:5 Story Point(s): 5 sustaining
Projects
Developer Enablement Team

Comments

@jpvajda
Copy link
Contributor

jpvajda commented Oct 26, 2020 •
edited
Loading

As a NR1 Programmability developer, I want that the technical documentation (developer.newrelic.com) is accurate and current, so that I know exactly what I can use during development.

Background:

Currently, the technical documentation of the NR1 SDK in 3rd party documentation site is generated by using the 1st party documentation bundle. This is done by manually excluding features that are not part of the 3rd party SDK.

Acceptance criteria:

  1. Use this app to get the diff of 1st vs 3rd party functionality
  2. generate the correct bundle functionality
  3. The JavaScript bundle to generate the documentation should be identical to the 1st party mechanism.
  4. .The JavaScript bundle should only contain the SDK components and APIs that are exposed for 3rd party development.

Out of scope:

Any automation to automatically update the JS bundle in the documentation website.
@jpvajda jpvajda added documentation Improvements or additions to documentation enhancement New feature or request labels Oct 26, 2020
@jpvajda jpvajda added this to Proposed in Developer Enablement Team Dec 2, 2020
@zstix zstix moved this from Proposed to To do in Developer Enablement Team Dec 11, 2020
@jpvajda
Copy link
Contributor Author

jpvajda commented Dec 16, 2020

with the prop and function changes outlined here: #1033 we'll need to work @mjesun and his team to pull in a 3rd party bundle with these updates by Dec 31st.

@jpvajda jpvajda moved this from To do to Proposed in Developer Enablement Team Dec 18, 2020
@jpvajda
Copy link
Contributor Author

jpvajda commented Dec 21, 2020

We now have until Feb 28th for the depreciation outlined in #1033 but it would be nice to pull the new bundle data in soon as it's been a while since our last update.

@jpvajda jpvajda changed the title Integrate with new 3rd party automated docs bundler for documentation accuracy Integrate with new 3rd party automated docs bundler for documentation accuracy: By Feb 28th Dec 28, 2020
@jpvajda jpvajda mentioned this issue Jan 8, 2021
Closed
11 tasks
@jpvajda jpvajda moved this from Proposed to To do in Developer Enablement Team Jan 8, 2021
@jpvajda
Copy link
Contributor Author

jpvajda commented Jan 11, 2021

Repolinter PR: https://github.com/newrelic/.github/pull/24/files

@jpvajda jpvajda added the sp:5 Story Point(s): 5 label Jan 14, 2021
@jpvajda jpvajda assigned timglaser and jpvajda and unassigned jpvajda Jan 14, 2021
@jpvajda jpvajda moved this from To do to In progress in Developer Enablement Team Jan 14, 2021
@jpvajda jpvajda changed the title Integrate with new 3rd party automated docs bundler for documentation accuracy: By Feb 28th Integrate with new 3rd party automated docs bundler for documentation accuracy: By Jan 29th Jan 14, 2021
@jpvajda jpvajda changed the title Integrate with new 3rd party automated docs bundler for documentation accuracy: By Jan 29th Update 3rd party component docs : By Jan 29th Jan 14, 2021
@jpvajda jpvajda removed estimate needed enhancement New feature or request labels Jan 14, 2021
@jpvajda
Copy link
Contributor Author

jpvajda commented Jan 14, 2021

I've begun the process of finding out the best way to get the docs bundle update we need and reached out to @mjesun.

@timglaser timglaser mentioned this issue Jan 27, 2021
Merged
@jerelmiller jerelmiller linked a pull request Jan 27, 2021 that will close this issue
Update component docs version #1070
Merged
Developer Enablement Team automation moved this from In progress to Done Jan 27, 2021
@jpvajda jpvajda mentioned this issue Oct 4, 2021
Closed
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@jerelmiller jerelmiller

@jpvajda jpvajda

@timglaser timglaser

Labels
documentation Improvements or additions to documentation sp:5 Story Point(s): 5 sustaining
Projects
Developer Enablement Team
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Update component docs version newrelic/developer-website
4 participants
@jerelmiller @jpvajda @zstix @timglaser