-
Notifications
You must be signed in to change notification settings - Fork 2.2k
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
Adding notary docs #483
Adding notary docs #483
Conversation
60f37bf
to
50249ea
Compare
Maybe could use a link to the actual notary docs? Other than that, LGTM. |
Just need updates here to adjust for the combined repo. |
@yosifkit anything specific? I thought I had made the necessary updates but I may have missed something. |
50249ea
to
a1ee145
Compare
oh, sorry, realized I hadn't pushed |
@@ -0,0 +1,3 @@ | |||
The Notary server is a front line metadata server for the Notary client. | |||
Notary signer is an internal service that supports Notary server by | |||
providing a more secure key management and signing service. |
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.
This is limited by the Docker Hub to one line and only 100 characters.
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.
Oh, damn. I thought I remembered it being 100 words (and figured it was guideline). Will come up with something shorter but it's basically going to be useless at that length.
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.
a1ee145
to
ccacc28
Compare
- [Notary Signer](#notary_signer) | ||
- [Database Migrations](#database_migrations) | ||
|
||
# How to use this repository<a name="how_to_use_this_repository"></a> |
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.
Unfortunately the Docker Hub does not currently render any HTML and doesn't even automake anchors for headings like github. 😿
ccacc28
to
d0a83a9
Compare
@@ -0,0 +1,82 @@ | |||
%%LOGO%% |
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.
For this one to work, you'll need to add either notary/logo.png
or notary/logo.svg
BTW 😄
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.
I figured I'd leave it in and when we have a logo I'll add it, rather than having to look it up later. It doesn't error right? It just doesn't insert a logo if none exists?
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.
The script will replace it with an empty line but that would produce invalid markdown according to markdownfmt so it would cause the job to fail.
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.
😞 removed it
ee2cb23
to
78553fc
Compare
LGTM pending the travis build. 👍 |
Travis finally finished and wants a couple minor changes. |
78553fc
to
5df9a80
Compare
Signed-off-by: David Lawrence <[email protected]> (github: endophage)
5df9a80
to
4900b6c
Compare
Got a little sick of waiting -- this build should've triggered by now. $ curl -fsSL 'https://raw.githubusercontent.com/endophage/docs/notary_docs/notary/content.md' | ./markdownfmt.sh -d
$ LGTM |
Thanks! |
PR for images here: docker-library/official-images#1423
Signed-off-by: David Lawrence [email protected] (github: endophage)