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

docs: annotates the PII tables in Aspects as per OEP-30 #569

Merged
merged 1 commit into from
Jan 18, 2024

Conversation

pomegranited
Copy link
Contributor

Description

Adds PII annotation docstrings to the PII tables created by Aspects.

Supporting information

Relates to openedx/openedx-aspects#106

Reference: OEP-30 PII Markup and Auditing

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jan 18, 2024
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited! Please note that it may take us up to several weeks or months to complete a review and merge your PR.

Feel free to add as much of the following information to the ticket as you can:

  • supporting documentation
  • Open edX discussion forum threads
  • timeline information ("this must be merged by XX date", and why that is)
  • partner information ("this is a course on edx.org")
  • any other information that can help Product understand the context for the PR

All technical communication about the code itself will be done via the GitHub pull request interface. As a reminder, our process documentation is here.

Please let us know once your PR is ready for our review and all tests are green.

@itsjeyd itsjeyd added the core contributor PR author is a Core Contributor (who may or may not have write access to this repo). label Jan 18, 2024
Copy link
Contributor

@Ian2012 Ian2012 left a comment

Choose a reason for hiding this comment

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

Doesn't this need a workflow and a pii_report file?

Will approve to not block it

@bmtcril
Copy link
Contributor

bmtcril commented Jan 18, 2024

I don't know of any repos currently using the OEP-30 tooling right now, but we do occasionally pull these reports off of the annotations alone so I think this is good enough for now. One thing on my list for this year is to sort out OEP-30 and try to drive some meaningful change there (or abandon it if people don't want the overhead). I think this is good and useful, in the current state, though.

@bmtcril bmtcril merged commit 867e7a0 into main Jan 18, 2024
6 checks passed
@bmtcril bmtcril deleted the jill/pii-annotation branch January 18, 2024 20:00
@openedx-webhooks
Copy link

@pomegranited 🎉 Your pull request was merged! Please take a moment to answer a two question survey so we can improve your experience in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core contributor PR author is a Core Contributor (who may or may not have write access to this repo). open-source-contribution PR author is not from Axim or 2U
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

5 participants