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

Fix use of "structured" vs "unstructured" #496

Closed
wants to merge 1 commit into from
Closed

Fix use of "structured" vs "unstructured" #496

wants to merge 1 commit into from

Conversation

jimrazmus
Copy link

@jimrazmus jimrazmus commented Oct 13, 2020

The guidance and description are inconsistent. This change corrects that inconsistency.

Why:

The inconsistency between the guidance and its description is confusing.

What's being changed:

The inconsistency between the guidance and its description.

Check off the following:

The guidance and description are inconsistent. This change corrects that inconsistency.
@welcome
Copy link

welcome bot commented Oct 13, 2020

Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines.

@janiceilene
Copy link
Contributor

Thanks for opening a PR @jimrazmus! Changing the first word from "structured" to "unstructured" changes the meaning of this section of the article, so I'm going to close this PR.

@janiceilene
Copy link
Contributor

If you haven't already, you can add yourself to the list of contributors by creating a new comment in this PR using these instructions. Thanks again! ✨

@jimrazmus
Copy link
Author

The title of the section reads "Never use structured data as a secret" but then goes on to talk about unstructured data leading to redaction failures. So what I take away is to never use structured or unstructured data in secrets. It that the intent of the section? The examples call out JSON, XML, and YAML. Are those examples meant to speak to the title of the section in regards to structured data or the preceding sentence regarding unstructured data?

@janiceilene
Copy link
Contributor

You were totally right about this change @jimrazmus and closing this PR was my mistake. I'm sorry about that! It ended up being fixed in another PR with some additional context in this comment #1036 (comment).

Thank you for following up with a helpful and kind explanation of why your suggestion was important!

@jimrazmus
Copy link
Author

@all-contributors please add @jimrazmus for documentation

jnidzwetzki pushed a commit to jnidzwetzki/docs that referenced this pull request Oct 6, 2022
Co-authored-by: Jacob Prall <prall.jacob@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants