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

Adding Redaction and Compliance docs #45373

Merged
merged 22 commits into from
Mar 21, 2025

Conversation

mariamgerges
Copy link
Contributor

@mariamgerges mariamgerges commented Mar 18, 2025

@dotnetrepoman dotnetrepoman bot added this to the March 2025 milestone Mar 18, 2025
@mariamgerges mariamgerges marked this pull request as ready for review March 18, 2025 13:50
@mariamgerges mariamgerges requested a review from a team as a code owner March 18, 2025 13:50
@mariamgerges mariamgerges requested review from IEvangelist and removed request for a team March 18, 2025 14:22
@dariusclay
Copy link

@IEvangelist this is for the data classification and redaction extensions in dotnet/extensions. Thank you @mariamgerges for taking this on!

Question I have, is location within the toc -- I would expect it to be under Runtime Libraries Overview, but want to hear some opinions from the folks here.

@IEvangelist
Copy link
Member

@IEvangelist this is for the data classification and redaction extensions in dotnet/extensions. Thank you @mariamgerges for taking this on!

Question I have, is location within the toc -- I would expect it to be under Runtime Libraries Overview, but want to hear some opinions from the folks here.

Hi @dariusclay - yeah, I agree it should be under the Runtime libraries TOC instead. This is neither diagnostics nor instrumentation. I'll review this in a bit. Great job @mariamgerges

@mariamgerges
Copy link
Contributor Author

I moved the files and updated the Runtime libraries TOC.

@mariamgerges
Copy link
Contributor Author

@IEvangelist The OPS status checker build step is failing, and I don't understand why, can you help?

@IEvangelist
Copy link
Member

@IEvangelist The OPS status checker build step is failing, and I don't understand why, can you help?

It's a safety net, we have that check in place to fail when the OpenPublishing.Build check has warnings. I don't think any of these are related to your PR, so you're good.

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

This is looking great, lots of nits to help improve this already awesome content. Let's get these suggestions in and I'll do another small review.

@IEvangelist
Copy link
Member

IEvangelist commented Mar 19, 2025

Just a quick heads up @mariamgerges - when you use tabs, you need specify also close them out with a ---. This comes after the two headings in this case. See here: https://learn.microsoft.com/en-us/help/platform/tabbed-conceptual-overview?toc=%2Fhelp%2Fplatform%2Ftoc.json&bc=%2Fhelp%2Fplatform%2Fbreadcrumb%2Ftoc.json&tabs=linux%2Cazure-cli

@IEvangelist
Copy link
Member

This is really shaping up nicely. I think we might want to make a few more tweaks. We could benefit from an Overview article that speaks to the benefits of these libraries and their overall compliance objectives. Then, in the compliance article, let's pivot a bit, moving the Redaction bits into the redaction article, and shifting this to be more about data classification. Then the TOC would look more like this:

  • Compliance
    • Overview
    • Data classification
    • Redaction

@mariamgerges
Copy link
Contributor Author

This is really shaping up nicely. I think we might want to make a few more tweaks. We could benefit from an Overview article that speaks to the benefits of these libraries and their overall compliance objectives. Then, in the compliance article, let's pivot a bit, moving the Redaction bits into the redaction article, and shifting this to be more about data classification. Then the TOC would look more like this:

  • Compliance

    • Overview
    • Data classification
    • Redaction

I updated the docs, created an overview article and a separate doc for data classification and moved the redaction bits to the data redaction doc and updated the TOC

Copy link
Member

@IEvangelist IEvangelist left a comment

Choose a reason for hiding this comment

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

Looking much better, we have a few more things to improve then we can ship this!

@IEvangelist IEvangelist merged commit 624c702 into main Mar 21, 2025
8 checks passed
@IEvangelist IEvangelist deleted the mariamaziz/redaction-compliance-docs branch March 21, 2025 17:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants