Skip to content
This repository has been archived by the owner on Nov 30, 2022. It is now read-only.

Add deprecation warning #1429

Merged
merged 5 commits into from
Oct 21, 2022
Merged

Add deprecation warning #1429

merged 5 commits into from
Oct 21, 2022

Conversation

TheAndrewJackson
Copy link
Contributor

@TheAndrewJackson TheAndrewJackson commented Oct 17, 2022

Purpose

Add a deprecation warning to let users know that the Fidesops repo is no longer being developed and lets them know where to go instead. Currently it only logs the warning on startup but the warning could logged more frequent if desired.

Screen Shot 2022-10-17 at 12 31 15

Changes

  • Add deprecation warning

Checklist

  • Update CHANGELOG.md file
    • Merge in main so the most recent CHANGELOG.md file is being appended to
    • Add description within the Unreleased section in an appropriate category. Add a new category from the list at the top of the file if the needed one isn't already there.
    • Add a link to this PR at the end of the description with the PR number as the text. example: #1
  • Applicable documentation updated (guides, quickstart, postman collections, tutorial, fidesdemo, database diagram.
  • If docs updated (select one):
    • documentation complete, or draft/outline provided (tag docs-team to complete/review on this branch)
    • documentation issue created (tag docs-team to complete issue separately)
  • Good unit test/integration test coverage
  • This PR contains a DB migration. If checked, the reviewer should confirm with the author that the down_revision correctly references the previous migration before merging
  • The Run Unsafe PR Checks label has been applied, and checks have passed, if this PR touches any external services

Ticket

Fixes #1422

Comment on lines 239 to 240
"Fidesops has been deprecated. The codebase has merged into the Fides repo. Located at "
"https://github.com/ethyca/fides"
Copy link
Contributor Author

Choose a reason for hiding this comment

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

The current warning message wording is mainly here to serve as a starting point. Do you either @seanpreston or @ThomasLaPiana any specific wording you'd prefer over what is currently there?

Copy link
Contributor

Choose a reason for hiding this comment

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

maybe also link to the docs site? we don't have the official migration guide up yet to link to unfortunately, but I think having links to both would be helpful

Copy link
Contributor

Choose a reason for hiding this comment

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

This wording works for me. Adding something to the README and docs is necessary too. @conceptualshark do you have any opinions here?

@TheAndrewJackson TheAndrewJackson self-assigned this Oct 17, 2022
@TheAndrewJackson TheAndrewJackson marked this pull request as ready for review October 17, 2022 16:38
@ThomasLaPiana
Copy link
Contributor

@TheAndrewJackson thanks for tackling this!

@seanpreston
Copy link
Contributor

@TheAndrewJackson / @ThomasLaPiana I was thinking we might also want to label the repository too, or at least update the README and description.

Screenshot 2022-10-19 at 09 54 15

@ThomasLaPiana
Copy link
Contributor

@seanpreston I might be wrong here (@NevilleS can confirm) but I think we're going to private it? At least I assumed that was the ultimate goal

@NevilleS
Copy link
Contributor

That'd make sense to move it to private, or archived/similar. Let's wait a month or two though, we've got other things to focus on first 👍

@TheAndrewJackson
Copy link
Contributor Author

@NevilleS Does updating the readme and repo labels makes sense since the archival won't happen for a month or two?

@TheAndrewJackson TheAndrewJackson merged commit efd16e2 into main Oct 21, 2022
@TheAndrewJackson TheAndrewJackson deleted the 1422_deprecation_warning branch October 21, 2022 15:18
@TheAndrewJackson
Copy link
Contributor Author

@seanpreston It looks like I may not have permission to update the repo description and labels. Could you do that?
Screen Shot 2022-10-21 at 11 19 51

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add deprecation warning for Fidesops
4 participants