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

[Platform Deprecations] Scope out the changes needed for 3rd-party-apps #291

Closed
2 tasks
rudouglas opened this issue Oct 4, 2021 · 9 comments · Fixed by #296
Closed
2 tasks

[Platform Deprecations] Scope out the changes needed for 3rd-party-apps #291

rudouglas opened this issue Oct 4, 2021 · 9 comments · Fixed by #296

Comments

@rudouglas
Copy link
Contributor

rudouglas commented Oct 4, 2021

Description

Schema properties are being deprecated.
Users of affected nerdlets should be notified 12 months in advance via warnings logged in the console of applications. Then 1 month before deprecation red error toasts are posted in the platform UI when the nerdlet is loaded.

Screenshot 2021-10-04 at 19 22 35

This posts these toast messages for customers as well so there have been support tickets around them, as they've caused some confusion.

We will need to scope out the work needed on our end to alter or remove the affected properties. These are generally located in the nr1.json schema of a nerdlet.

Some examples are actionCategory being removed and entities changing to context.entities.

Example PR with changes:

newrelic/nr1-event-stream#59

Acceptance Criteria

  • The work to implement the needed changes is scoped and ticketed
  • Assess what changes need to be made to our workflow so we can address these in good time
@rudouglas rudouglas created this issue from a note in Developer Enablement Team (Tentative next) Oct 4, 2021
@rudouglas rudouglas added the eng label Oct 4, 2021
@jpvajda
Copy link

jpvajda commented Oct 4, 2021

References to when we did this before and some related issues:

newrelic/developer-website#1033
newrelic/developer-website#895

The ideal is we setup automation to automatically update the JS bundle for our SDK documentation and also automate the deprecation of components in the 3rd party app ecosystem.

@jpvajda jpvajda added this to the [DevEn] Sprint 14 milestone Oct 4, 2021
@jpvajda jpvajda added P2 bug Something isn't working opensource enablement labels Oct 4, 2021
@jpvajda jpvajda removed this from the [DevEn] Sprint 14 milestone Oct 4, 2021
@jpvajda
Copy link

jpvajda commented Oct 4, 2021

I think now that we have a 2 month grace period we can look at this in the next sprint.

@jpvajda jpvajda added this to the [DevEn] Sprint 15 milestone Oct 4, 2021
@jpvajda jpvajda removed this from the [DevEn] Sprint 15 milestone Oct 8, 2021
@rudouglas rudouglas moved this from Tentative next to In progress in Developer Enablement Team Oct 11, 2021
@rudouglas rudouglas added this to the [DevEn] Sprint 15 milestone Oct 11, 2021
@rudouglas rudouglas self-assigned this Oct 12, 2021
@rudouglas rudouglas linked a pull request Oct 12, 2021 that will close this issue
@rudouglas rudouglas moved this from In progress to In review in Developer Enablement Team Oct 12, 2021
@rudouglas rudouglas moved this from In review to In progress in Developer Enablement Team Oct 12, 2021
@rudouglas
Copy link
Contributor Author

Example Issue created by the action rudouglas#2

@jpvajda Still TBD on this is how often this should run etc, at the moment it's triggered manually

I also need permissions to add secrets to the repo, both NR_QUERY_KEY ID and NR_ACCOUNT_ID are required for querying the data

@jpvajda
Copy link

jpvajda commented Oct 12, 2021

@rudouglas nice, will this issue be sent this way to all repos where this is occuring? Or are you going to specifically customize the issue to relate to the repo?

For example: will I see this entire checklist of problems is all repos? I'd prefer if we just specified which problem exists in the specific repo.

@jpvajda
Copy link

jpvajda commented Oct 12, 2021

We discussed how we'd actually determine when to run this job, and send notices to the repo maintainers to take action.

  • use the event data provided to the platform to create an issue to the correct repo
  • set up the job to run periodically
  • other?

Other ideas:

@rudouglas
Copy link
Contributor Author

@jpvajda at the moment it should just create a single issue in this repo (nr1-catalog) with a list of all apps and issues reported, if you would rather a separate issue in each repo that could be done pretty easily, slap a deprecation label on them and push them to the 3rd party project board

@jpvajda
Copy link

jpvajda commented Oct 14, 2021

@rudouglas that single issue approach is great! How do we get notified this issue is created though since we don't spend a lot of time in that repo.

@rudouglas
Copy link
Contributor Author

@jpvajda we could get it added to our Board would be the best way 🤷

@jpvajda
Copy link

jpvajda commented Oct 14, 2021

@rudouglas this is the way ▶️

@rudouglas rudouglas moved this from In progress to In review in Developer Enablement Team Oct 15, 2021
Developer Enablement Team automation moved this from In review to Done Oct 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging a pull request may close this issue.

2 participants