-
Notifications
You must be signed in to change notification settings - Fork 59
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
Restructured the layout of the current documentation #312
Conversation
✅ Deploy Preview for notarydev ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
, andsecure-plugin-development.md
undercontent/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.
fixes #306 |
Hi, @zr-msft, thanks for the comment. I have updated the PR to incorporate your suggestions. Please kindly review. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice work. LGTM
Thank you, @zr-msft |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL
@Roseline-Bassey you'll need to rebase your branch for this PR and resolve any conflicts before we can merge this |
0aca556
to
334f21b
Compare
Hi, @zr-msft |
did you fetch the latest from upstream?
|
On the Then on my branch, I executed: |
you need to run |
334f21b
to
2283732
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
PTAL
Hi @Roseline-Bassey , the updated version looks good to me. Thanks for your patience. Could you ps resolve the conflict? |
@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? |
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
981e278
43f8446
to
981e278
Compare
Yes, I agree. The article can be included in the how-to guides under the User Guides. @FeynmanZhou |
Signed-off-by: Roseline <[email protected]>
Signed-off-by: Roseline <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
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