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

Create a FAQ to describe difference among notary, TUF, Notary Project specification, and notation #328

Merged
merged 16 commits into from
Aug 10, 2023

Conversation

Roseline-Bassey
Copy link
Contributor

@Roseline-Bassey Roseline-Bassey commented Jul 27, 2023

This PR adds a new section in faq.md to clarify the difference between Notary, Notary v2, Notation, TUF, and Notary Project.

It fixes #323

I haven't included a link to the glossary page in the last line because PR #326 is still under review and has not been merged yet. I will update this PR with the link once #326 is merged.

@netlify
Copy link

netlify bot commented Jul 27, 2023

Deploy Preview for notarydev ready!

Name Link
🔨 Latest commit 3bf5409
🔍 Latest deploy log https://app.netlify.com/sites/notarydev/deploys/64d46d4403d58e0008e30c0c
😎 Deploy Preview https://deploy-preview-328--notarydev.netlify.app/docs/faq
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

PTAL

Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @Roseline-Bassey , left a comment.

content/en/docs/faq.md Show resolved Hide resolved
zr-msft
zr-msft previously approved these changes Aug 2, 2023
zr-msft
zr-msft previously approved these changes Aug 3, 2023
@yizha1 yizha1 changed the title Documented the difference between Notary, Notation, TUF, and Notary P… Create a FAQ to describe difference among notary, TUF, Notary Project specification, and notation Aug 4, 2023
content/en/docs/faq.md Outdated Show resolved Hide resolved
@Roseline-Bassey Roseline-Bassey changed the title Create a FAQ to describe difference among notary, TUF, Notary Project specification, and notation Added a new section in faq.md to describe difference among notary, TUF, Notary Project specification, and notation Aug 4, 2023
@Roseline-Bassey Roseline-Bassey changed the title Added a new section in faq.md to describe difference among notary, TUF, Notary Project specification, and notation Create a FAQ to describe difference among notary, TUF, Notary Project specification, and notation Aug 4, 2023
content/en/docs/faq.md Outdated Show resolved Hide resolved
@FeynmanZhou FeynmanZhou self-requested a review August 8, 2023 03:50
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @Roseline-Bassey. It looks much better now.

content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
yizha1
yizha1 previously approved these changes Aug 8, 2023
Copy link
Contributor

@yizha1 yizha1 left a comment

Choose a reason for hiding this comment

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

Thanks @Roseline-Bassey

LGTM

@yizha1 yizha1 requested review from toddysm and zr-msft August 8, 2023 12:30
FeynmanZhou
FeynmanZhou previously approved these changes Aug 8, 2023
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link

@Two-Hearts Two-Hearts left a comment

Choose a reason for hiding this comment

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

LGTM

zr-msft
zr-msft previously approved these changes Aug 9, 2023
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
content/en/docs/faq.md Outdated Show resolved Hide resolved
@yizha1 yizha1 dismissed stale reviews from zr-msft, FeynmanZhou, and themself via c2cff14 August 10, 2023 03:29
FeynmanZhou
FeynmanZhou previously approved these changes Aug 10, 2023
Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM. Thanks

Signed-off-by: Yi Zha <[email protected]>
Signed-off-by: Yi Zha <[email protected]>
content/en/docs/faq.md Outdated Show resolved Hide resolved
Signed-off-by: Yi Zha <[email protected]>
Copy link

@gokarnm gokarnm left a comment

Choose a reason for hiding this comment

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

LGTM!

Copy link
Member

@FeynmanZhou FeynmanZhou left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Contributor

@toddysm toddysm left a comment

Choose a reason for hiding this comment

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

We can merge in this state. There are minor cosmetic changes that we can fix later on.

Copy link
Contributor

@priteshbandi priteshbandi left a comment

Choose a reason for hiding this comment

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

LGTM

@priteshbandi priteshbandi merged commit 7e5d708 into notaryproject:main Aug 10, 2023
5 checks passed
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.

Describe the difference between notary, TUF, Notary Project specification, and notation in faq.md
10 participants