add use-cases-wp.doc to compliance folder #1308
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: hubbert Smith <[email protected]>
✅ Deploy Preview for tag-security ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Hey @hubbertsmith, since this is an empty file I'm gonna change this PR to a draft for now. When you have content committed and ready for review, all you'll need to do is add a description to the PR and take it out of draft mode. |
|
Cool. No problem
I'll attach the doc shortly
…On Fri, Jul 5, 2024, 8:45 PM Eddie Knight ***@***.***> wrote:
Hey @hubbertsmith <https://github.com/hubbertsmith>, since this is an
empty file I'm gonna change this PR to a draft for now. When you have
content committed and ready for review, all you'll need to do is add a
description to the PR and take it out of draft mode.
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR5LA6HDW7H76LRBQKLZK5K5XAVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJRGU4TSMZYGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Hi , I attached the compliance whitepaper document in comments ... I was
unable to find another method to attach (I have limited GIT privs)
LMK if i should do it differently. and feel free to lend a hand to put the
doc where it needs to be
…On Fri, Jul 5, 2024 at 8:45 PM Eddie Knight ***@***.***> wrote:
Hey @hubbertsmith <https://github.com/hubbertsmith>, since this is an
empty file I'm gonna change this PR to a draft for now. When you have
content committed and ready for review, all you'll need to do is add a
description to the PR and take it out of draft mode.
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR5LA6HDW7H76LRBQKLZK5K5XAVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJRGU4TSMZYGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Thanks, @hubbertsmith! So, GitHub is designed primarily for code and text-based files. Word (.doc) files are binary formats that GitHub can't render or preview directly in the web interface. Couple steps: Convert to Markdown:
Add to Your Branch:
If the document must remain in Word format, you can still add it to the repository, but users will need to download it to view the content |
|
thanks for your kind response
i use .md all the time
this is a DOC file, it has ms-word formatting/tables/toc. Doc files can be
reviewed by a clone. can we go that way?
***@***.*** | 385 321 0757 | LinkedIN
<https://www.linkedin.com/in/hubbertsmith/>
*CEO, ***@***.*** Ops *
* ... i4 Zero Exfil accelerates data-driven innovation. Prevents data
breach in minutes not months. ... Even credentialed users and 3rd parties
cannot walk away with data. *
https://calendly.com/hubbert/60min
…On Sat, Jul 6, 2024 at 12:26 PM Andrés Vega ***@***.***> wrote:
Thanks, @hubbertsmith <https://github.com/hubbertsmith>! So, GitHub is
designed primarily for code and text-based files. Word (.doc) files are
binary formats that GitHub can't render or preview directly in the web
interface.
Couple steps:
Convert to Markdown:
1. Open your Word document
2. Copy the content
3. Paste into a markdown editor (e.g., VS Code with markdown
extension, online tools like StackEdit)
4. Format your content using markdown syntax:
- Use # for headings (e.g., # Heading 1, ## Heading 2)
- Use - for bullet points
- Use 1. 2. 3. for numbered lists
- Enclose text in ** for bold, * for italic
5. Save the file with a .md extension (e.g., compliance_usecases.md)
Add to Your Branch:
1. Ensure you're on your hubbertsmith:patch-1 branch
2. Add the new markdown file to your repository
3. Commit the changes
4. Push to your branch on GitHub
If the document must remain in Word format, you can still add it to the
repository, but users will need to download it to view the content
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR6HXQMJONYN36V56BLZLAZEVAVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJRHA2DEMBSGE>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
Thank you for your explanation. I understand your situation better now. However, I want to clarify a few points about our repository practices: We don't currently have any .doc files in our repository. Instead, we use links to Google Docs and PDFs for content with complex formatting. PDFs are proofed and designed by CNCF tech writers which can be done by opening a ticket with them. For your document, we suggest the following options: If you prefer to keep it as a .doc file, please note that while Git can version control .doc files, it won't be able to show meaningful diffs on GitHub's web interface. This makes reviewing changes more difficult. If you decide to stick with the .doc format for now, we can certainly work with that. You can add it to your hubbertsmith:patch-1 branch, and reviewers will need to clone the repository and open it with Word to review it fully. Let me know which option you prefer, or if you have any questions about these approaches. We're here to help make this process as smooth as possible for you. |
|
Hiya.
Happy to do this. Google doc is a great suggestion.
What's the upload link?
…On Sat, Jul 6, 2024, 12:57 PM Andrés Vega ***@***.***> wrote:
Thank you for your explanation. I understand your situation better now.
However, I want to clarify a few points about our repository practices:
We don't currently have any .doc files in our repository. Instead, we use
links to Google Docs and PDFs for content with complex formatting. PDFs are
proofed and designed by CNCF tech writers which can be done by opening a
ticket with them.
For your document, we suggest the following options:
a. Convert the file to a Google Doc and provide a link in the README.md
file. This maintains formatting while allowing easy access and
collaborative editing.
b. Convert to markdown. While you mentioned formatting, tables, and ToC as
potential issues, these are actually quite manageable in markdown. I'd be
happy to assist you with this conversion early next week if you'd like.
If you prefer to keep it as a .doc file, please note that while Git can
version control .doc files, it won't be able to show meaningful diffs on
GitHub's web interface. This makes reviewing changes more difficult. If you
decide to stick with the .doc format for now, we can certainly work with
that. You can add it to your hubbertsmith:patch-1 branch, and reviewers
will need to clone the repository and open it with Word to review it fully.
Let me know which option you prefer, or if you have any questions about
these approaches. We're here to help make this process as smooth as
possible for you.
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR2NP47O7FN6SUXAQKTZLA4X3AVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJRHA2TSNBTGU>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
I've taken the liberty of uploading your file to our shared Google Drive and granting you editor rights. You can now access and edit the document here: https://docs.google.com/document/d/1l_4HHtYVXG2dG5Y1WRzmMrdt_IcTqMHPL8u6ZQ1Zc9A |
|
my hero, thank you so much
I will add the link to the compliance/readme.md
CHEERS
h
***@***.*** | 385 321 0757 | LinkedIN
<https://www.linkedin.com/in/hubbertsmith/>
*CEO, ***@***.*** Ops *
* ... i4 Zero Exfil accelerates data-driven innovation. Prevents data
breach in minutes not months. ... Even credentialed users and 3rd parties
cannot walk away with data. *
https://calendly.com/hubbert/60min
…On Sat, Jul 6, 2024 at 1:09 PM Andrés Vega ***@***.***> wrote:
I've taken the liberty of uploading your file to our shared Google Drive
and granting you editor rights. You can now access and edit the document
here:
https://docs.google.com/document/d/1l_4HHtYVXG2dG5Y1WRzmMrdt_IcTqMHPL8u6ZQ1Zc9A
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>,
or unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR423P674LT5AO2NO4DZLA6HVAVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDEMJRHA3DSOBUGA>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
|
hi Andres, I updated this doc ... is there anything else I should do to
follow process and work nicely with others?
***@***.*** | 385 321 0757 | LinkedIN
<https://www.linkedin.com/in/hubbertsmith/>
*CEO, ***@***.*** Ops *
* ... i4 Zero Exfil accelerates data-driven innovation. Prevents data
breach in minutes not months. ... Even credentialed users and 3rd parties
cannot walk away with data. *
https://calendly.com/hubbert/60min
…On Tue, Jul 9, 2024 at 7:42 AM Andrés Vega ***@***.***> wrote:
Closed #1308 <#1308>.
—
Reply to this email directly, view it on GitHub
<#1308 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AMQIVR7VV5DTNF32GTFPNFLZLPSCRAVCNFSM6AAAAABKJX6OJOVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJTGQ2DANRTGQZTANQ>
.
You are receiving this because you were mentioned.Message ID:
***@***.***>
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.