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.

Sign up for GitHub

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

Jump to bottom

Proposed Documentation Structure for Notary Project #306

Closed
Roseline-Bassey opened this issue Jul 10, 2023 · 1 comment
Closed

Proposed Documentation Structure for Notary Project #306

Roseline-Bassey opened this issue Jul 10, 2023 · 1 comment
Milestone
1.1.0

Comments

@Roseline-Bassey
Copy link
Contributor

Roseline-Bassey commented Jul 10, 2023 •
edited
Loading

Hi, Notary Maintainers

I'd like to request your feedback on the structure of the proposed docs.
Here's an overview of the proposed structure:

Project Overview
Contributing.md
Notation

  • Quick-start guides.md
  • Installation guides
  • Tutorials
  • How-to-guides
  • Concepts
  • CLI Reference
  • Glossary.md

Troubleshooting
Developer Documentation
Frequently Asked Questions

The link to the Google docs can be found here
This was referenced Jul 11, 2023
Closed
Closed
Merged
@yizha1 yizha1 added this to the 1.1.0 milestone Sep 9, 2023
zr-msft pushed a commit that referenced this issue Sep 12, 2023
@Roseline-Bassey
Restructured the layout of the current documentation (#312)
9b88d58 
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 >

- Quick-start guides.md
- Installation guides
- Tutorials
- How-to-guides
- Concepts ( this only contains the [Notation directory structure for
system
configuration](https://notaryproject.dev/docs/concepts/directory-structure/)
now)
- CLI Reference
- Glossary.md ( some terminologies which I will define in my later PR
have been added here)

Troubleshooting

Developer documentation ([Securely develop plugins for
Notation](https://notaryproject.dev/docs/concepts/secure-plugin-development/),
[Securely deploying
Notation](https://notaryproject.dev/docs/concepts/secure-deployment/),
[Experimental
features](https://notaryproject.dev/docs/concepts/experimental-features/),
and [Notary project specifications and
requirements](https://notaryproject.dev/docs/concepts/specs-requirements/)
have been moved to developer docs)

FAQ

---------

Signed-off-by: Roseline <[email protected]>
@zr-msft
Copy link
Collaborator

zr-msft commented Sep 12, 2023

This issue has been resolved by #312

@zr-msft zr-msft closed this as completed Sep 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
1.1.0
Development

No branches or pull requests
3 participants
@zr-msft @Roseline-Bassey @yizha1