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

docs: redesign docs structure to improve navigation #897

Merged
merged 7 commits into from
Jul 6, 2023
Merged

docs: redesign docs structure to improve navigation #897

merged 7 commits into from
Jul 6, 2023

Conversation

duffney
Copy link
Contributor

@duffney duffney commented Jun 20, 2023

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 and docs/reference and let me know in the comments of the PR if a doc needs to be moved to archive.

Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
Signed-off-by: Joshua Duffney <jduffney@microsoft.com>
@akashsinghal akashsinghal changed the title Redesign Ratify docs structure to improve navigation docs: redesign docs structure to improve navigation Jun 20, 2023
@codecov
Copy link

codecov bot commented Jun 20, 2023

Codecov Report

Patch and project coverage have no change.

Comparison is base (1a0130f) 54.95% compared to head (d7818c6) 54.95%.

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.
📢 Do you have feedback about the report comment? Let us know in this issue.

docs/README.md Outdated Show resolved Hide resolved
@FeynmanZhou
Copy link
Collaborator

@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

Copy link
Collaborator

@susanshi susanshi left a 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!

docs/README.md Outdated Show resolved Hide resolved
@duffney
Copy link
Contributor Author

duffney commented Jun 29, 2023

@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

Will the docs be migrated? And will any docs remain in this repo? If not, then this PR might not be necessary.

duffney and others added 3 commits June 29, 2023 08:41
Co-authored-by: Akash Singhal <akashksinghal98@gmail.com>
Signed-off-by: Josh Duffney <jduffney@microsoft.com>
Signed-off-by: Josh Duffney <jduffney@microsoft.com>
@akashsinghal
Copy link
Collaborator

@duffney Thanks for the improvements! would you mind signing the CLA agreement. We can merge it then.

@duffney
Copy link
Contributor Author

duffney commented Jul 6, 2023

@microsoft-github-policy-service agree company="Microsoft"

@susanshi susanshi enabled auto-merge (squash) July 6, 2023 23:23
@susanshi susanshi merged commit c3b7f6e into ratify-project:main Jul 6, 2023
@jlbutler
Copy link

@FeynmanZhou @duffney Hi all 👋

AWS had a few links into the examples directory here, which is now quickstarts, so we have some broken links. I think we should link out to the new docs site, will everything here be migrated there at some point? I'd like to review the AWS content, and maybe sort out the best way to present the ratify-with-aws.md and ratify-with-aws-signer.md content.

@duffney
Copy link
Contributor Author

duffney commented Jul 17, 2023

@FeynmanZhou @duffney Hi all 👋

AWS had a few links into the examples directory here, which is now quickstarts, so we have some broken links. I think we should link out to the new docs site, will everything here be migrated there at some point? I'd like to review the AWS content, and maybe sort out the best way to present the ratify-with-aws.md and ratify-with-aws-signer.md content.

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.

@FeynmanZhou
Copy link
Collaborator

FeynmanZhou commented Jul 17, 2023

@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.

bspaans pushed a commit to bspaans/ratify that referenced this pull request Oct 17, 2023
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>
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