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

Adding notary docs #483

Merged
merged 1 commit into from
Feb 29, 2016
Merged

Adding notary docs #483

merged 1 commit into from
Feb 29, 2016

Conversation

endophage
Copy link
Contributor

PR for images here: docker-library/official-images#1423

Signed-off-by: David Lawrence [email protected] (github: endophage)

@diogomonica
Copy link

Maybe could use a link to the actual notary docs? Other than that, LGTM.

@yosifkit
Copy link
Member

Just need updates here to adjust for the combined repo.

@endophage
Copy link
Contributor Author

@yosifkit anything specific? I thought I had made the necessary updates but I may have missed something.

@endophage
Copy link
Contributor Author

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.
Copy link
Member

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.

Copy link
Contributor Author

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.

Copy link
Member

@tianon tianon Feb 26, 2016 via email

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

- [Notary Signer](#notary_signer)
- [Database Migrations](#database_migrations)

# How to use this repository<a name="how_to_use_this_repository"></a>
Copy link
Member

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

@@ -0,0 +1,82 @@
%%LOGO%%
Copy link
Member

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 😄

Copy link
Contributor Author

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?

Copy link
Member

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.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

😞 removed it

@endophage endophage force-pushed the notary_docs branch 2 times, most recently from ee2cb23 to 78553fc Compare February 26, 2016 22:38
@yosifkit
Copy link
Member

LGTM pending the travis build. 👍

@yosifkit
Copy link
Member

Travis finally finished and wants a couple minor changes.

Signed-off-by: David Lawrence <[email protected]> (github: endophage)
@tianon
Copy link
Member

tianon commented Feb 29, 2016

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

tianon added a commit that referenced this pull request Feb 29, 2016
@tianon tianon merged commit bb0b8c3 into docker-library:master Feb 29, 2016
@endophage
Copy link
Contributor Author

Thanks!

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.

4 participants