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

Restructured the layout of the current documentation #312

Merged
merged 12 commits into from
Sep 12, 2023

Conversation

Roseline-Bassey
Copy link
Contributor

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

This PR is an implementation of the proposed docs structure #306 for the Notary Project.

The documentation layout has been restructured in this order :

Project overview
Contributing.md
Notation >

Troubleshooting

Developer documentation (Securely develop plugins for Notation, Securely deploying Notation, Experimental features, and Notary project specifications and requirements have been moved to developer docs)

FAQ

@netlify
Copy link

netlify bot commented Jul 12, 2023

Deploy Preview for notarydev ready!

Name Link
🔨 Latest commit 12f160b
🔍 Latest deploy log https://app.netlify.com/sites/notarydev/deploys/64ff6e831bbd520008770d97
😎 Deploy Preview https://deploy-preview-312--notarydev.netlify.app
📱 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.

@Roseline-Bassey Roseline-Bassey changed the title restructured docs layout restructured the layout of the current documentation Jul 12, 2023
@Roseline-Bassey Roseline-Bassey changed the title restructured the layout of the current documentation Restructured the layout of the current documentation Jul 12, 2023
Copy link
Collaborator

@zr-msft zr-msft left a comment

Choose a reason for hiding this comment

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

@Roseline-Bassey

Thank you for making this PR.

Overall i'm fine with the changes for now, but there a couple changes:

  • Create content/en/docs/notation/developer
  • Move experimental-features.md, secure-deployment.md, and secure-plugin-development.md under content/en/docs/notation/developer
  • Rename content/en/docs/developer-docs -> content/en/docs/developer

There are some other minor things i'm considering if we should change or not, but I can send a follow up PR after this is merged if needed.

@zr-msft
Copy link
Collaborator

zr-msft commented Jul 12, 2023

fixes #306

@Roseline-Bassey
Copy link
Contributor Author

Hi, @zr-msft, thanks for the comment. I have updated the PR to incorporate your suggestions. Please kindly review.

zr-msft
zr-msft previously approved these changes Jul 13, 2023
Copy link
Collaborator

@zr-msft zr-msft left a comment

Choose a reason for hiding this comment

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

Nice work. LGTM

@Roseline-Bassey
Copy link
Contributor Author

Thank you, @zr-msft

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

@zr-msft
Copy link
Collaborator

zr-msft commented Jul 17, 2023

@Roseline-Bassey you'll need to rebase your branch for this PR and resolve any conflicts before we can merge this

@Roseline-Bassey Roseline-Bassey force-pushed the refactoring-docs-branch branch 2 times, most recently from 0aca556 to 334f21b Compare July 18, 2023 11:00
@Roseline-Bassey
Copy link
Contributor Author

Hi, @zr-msft
I have rebased and force-pushed to my branch. On my local Git, the rebase output shows that it "Successfully rebased and updated refs/heads/refactoring-docs-branch." There was no conflict on my local git after rebasing and before submitting the pull request but on this PR page GitHub says: 'This branch has conflicts that must be resolved" I am wondering if I pushed the PR wrongly and what can I do to resolve the conflict.

@zr-msft
Copy link
Collaborator

zr-msft commented Jul 18, 2023

Hi, @zr-msft I have rebased and force-pushed to my branch. On my local Git, the rebase output shows that it "Successfully rebased and updated refs/heads/refactoring-docs-branch." There was no conflict on my local git after rebasing and before submitting the pull request but on this PR page GitHub says: 'This branch has conflicts that must be resolved" I am wondering if I pushed the PR wrongly and what can I do to resolve the conflict.

did you fetch the latest from upstream?

git fetch upstream
git rebase upstream/main

@Roseline-Bassey
Copy link
Contributor Author

On the main branch, I executed
git fetch upstream

Then on my branch, I executed:
git rebase main

@zr-msft
Copy link
Collaborator

zr-msft commented Jul 18, 2023

On the main branch, I executed git fetch upstream

Then on my branch, I executed: git rebase main

you need to run git rebase upstream/main on your branch. You ran the equivalent of git rebase origin/main

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

zr-msft
zr-msft previously approved these changes Aug 25, 2023
FeynmanZhou
FeynmanZhou previously approved these changes Sep 11, 2023
@FeynmanZhou
Copy link
Member

Hi @Roseline-Bassey , the updated version looks good to me. Thanks for your patience. Could you ps resolve the conflict?

@FeynmanZhou
Copy link
Member

@zr-msft @Roseline-Bassey I feel this article could be moved to the chapter "User guides" since only Notation users may take care of this configuration. What's your opinion?
image

@Roseline-Bassey
Copy link
Contributor Author

Yes, I agree. The article can be included in the how-to guides under the User Guides. @FeynmanZhou

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
Collaborator

@zr-msft zr-msft 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 merged commit 9b88d58 into notaryproject:main Sep 12, 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.

6 participants