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

Add express-gateway docs #1144

Merged
merged 8 commits into from
Jan 11, 2019
Merged

Add express-gateway docs #1144

merged 8 commits into from
Jan 11, 2019

Conversation

XVincentX
Copy link
Contributor

@XVincentX XVincentX commented Feb 6, 2018

This PR will add the required documentation to make Express Gateway land in the official program images.

@XVincentX
Copy link
Contributor Author

@yosifkit @tianon

Is there any way I can speed up this and make it happen?

Copy link
Member

@tianon tianon left a comment

Choose a reason for hiding this comment

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

A few minor comments -- also, you'll want to check Travis for markdownfmt fixes (which can be applied automatically via ./markdownfmt.sh -w express-gateway/content.md from a checkout of this repo, if you wanted to take the easy way out, but sometimes it does interesting things so it needs to be reviewed afterwards to make sure it's still what you intended). 👍

express-gateway/README-short.txt Outdated Show resolved Hide resolved
express-gateway/content.md Outdated Show resolved Hide resolved
express-gateway/content.md Outdated Show resolved Hide resolved
express-gateway/content.md Outdated Show resolved Hide resolved
@XVincentX
Copy link
Contributor Author

@tianon I addressed all the comments — however the markdown format checking is failing but to be honest I do not really understand its reason. Can you give me a hint?

@yosifkit
Copy link
Member

yosifkit commented Jan 9, 2019

Looks like a couple things:

  • list items need to be formatted with tabs
    -	item
  • italics needs to be star a * rather than underscore _ (bold should be two star)
  • lines next to each other need to either have a empty line between them to be considered different paragraphs, or be one line to be a single paragraph
    • i.e., paragraphs need to be a single line and have a single empty line between paragraphs

@XVincentX
Copy link
Contributor Author

Oh I understood only now that the error message was instead a diff that was trying to help me!

I should have fixed all the issues. @yosifkit @tianon

@tianon tianon merged commit ab1f378 into docker-library:master Jan 11, 2019
@XVincentX
Copy link
Contributor Author

This is so great! Thanks a lot!

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.

3 participants