-
Notifications
You must be signed in to change notification settings - Fork 62
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
docs: redesign docs structure to improve navigation #897
Conversation
Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
Codecov ReportPatch and project coverage have no change.
Additional details and impacted files@@ Coverage Diff @@
## main #897 +/- ##
=======================================
Coverage 54.95% 54.95%
=======================================
Files 81 81
Lines 4791 4791
=======================================
Hits 2633 2633
Misses 1881 1881
Partials 277 277 ☔ View full report in Codecov by Sentry. |
@duffney FYI. There is a new repository created for the Ratify website: https://github.com/deislabs/ratify-web/. We will migrate the docs from the Ratify repo to the website repo soon |
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.
Thanks for restructuring Readme, left a minor comment. thanks!
Will the docs be migrated? And will any docs remain in this repo? If not, then this PR might not be necessary. |
Co-authored-by: Akash Singhal <akashksinghal98@gmail.com> Signed-off-by: Josh Duffney <jduffney@microsoft.com>
Signed-off-by: Josh Duffney <jduffney@microsoft.com>
@duffney Thanks for the improvements! would you mind signing the CLA agreement. We can merge it then. |
@microsoft-github-policy-service agree company="Microsoft" |
@FeynmanZhou @duffney Hi all 👋 AWS had a few links into the |
Hey @jlbutler, I'll let @FeynmanZhou answer this question. I'm not sure what the plan is with the docs that exist within the repo since the website was launched. |
@duffney @jlbutler We will discuss the docs migration in the Ratify community meeting this Wednesday. I think @jlbutler you may need to replace the original link with https://ratify.dev/docs/1.0.0-rc.6/Examples/ratify-on-aws on the AWS doc website after the migration is completed. We will inform you to help review and validate the content on the Ratify website after the migration is completed in a few days. |
Signed-off-by: Joshua Duffney <jduffney@microsoft.com> Signed-off-by: Josh Duffney <jduffney@microsoft.com> Co-authored-by: Akash Singhal <akashksinghal98@gmail.com> Co-authored-by: Akash Singhal <akashsinghal@microsoft.com> Co-authored-by: Susan Shi <huish@microsoft.com>
In this PR I've reorganized the docs folder to make it easier to navigate the documentation.
An ask for the reviewer:
I don't have enough context yet to determine which docs are out-of-date and should be updated vs docs that are out-of-date and need to be archived. Please review the documents within the
docs/quickstarts
anddocs/reference
and let me know in the comments of the PR if a doc needs to be moved to archive.