Skip to content

Update node README.md - #964

Merged
tianon merged 3 commits into
docker-library:masterfrom
styfle:patch-1
Jul 31, 2017
Merged

Update node README.md#964
tianon merged 3 commits into
docker-library:masterfrom
styfle:patch-1

Conversation

@styfle

@styfle styfle commented Jul 19, 2017

Copy link
Copy Markdown
Contributor

@styfle styfle mentioned this pull request Jul 19, 2017
Closed
SimenB
SimenB reviewed Jul 20, 2017
View reviewed changes
Comment thread node/README.md Outdated
node_modules
```

We have assembled a [Best Practices Guide](./docs/BestPractices.md) for those using these images on a daily basis.

@SimenB SimenB Jul 20, 2017

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

Will a relative link resolve correctly?

@styfle styfle Jul 20, 2017

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Good point! Probably not. I fixed this.

@tianon

tianon commented Jul 20, 2017

Copy link
Copy Markdown
Member

Please take a look at the CI failure -- this needs to be updated in content.md instead. (Almost all the README.md files here are generated, as the comment at the top of each file notes.)

@tianon

tianon commented Jul 20, 2017

Copy link
Copy Markdown
Member

Also, we use a fork of markdownfmt (see ./markdownfmt.sh in the root of this repo, and Travis's output) -- please follow the formatting it requires/suggests.

@SimenB

SimenB commented Jul 21, 2017

Copy link
Copy Markdown

If there are changes to the output after running markdownfmt, please PR those backe to node-docker as well 🙂

@styfle

styfle commented Jul 21, 2017

Copy link
Copy Markdown
Contributor Author

@tianon @SimenB I updated the PR so the README.md is unchanged.
Hopefully this works as expected.

dog

@styfle

styfle commented Jul 25, 2017

Copy link
Copy Markdown
Contributor Author

The command ".travis/check-markdownfmt.sh" exited with 1.

What's wrong with the format this time?

@SimenB

SimenB commented Jul 25, 2017

Copy link
Copy Markdown

Can you run it locally?

@styfle

styfle commented Jul 25, 2017

Copy link
Copy Markdown
Contributor Author

@SimenB No, it doesn't seem to work with git bash on windows.

styfle@WINDOWS-PC MINGW64 /d/code/docker-docs (patch-1)
$ .travis/check-markdownfmt.sh
xargs: markdownfmt: No such file or directory

@SimenB

SimenB commented Jul 25, 2017

Copy link
Copy Markdown

Doing go get -u github.com/shurcooL/markdownfmt and ~/go/bin/markdownfmt -d node/license.md and ~/go/bin/markdownfmt -d node/content.md exits with 0, so I don't know what's wrong...

@SimenB

SimenB commented Jul 26, 2017

Copy link
Copy Markdown

I also tried ./markdownfmt.sh node/*.md (which uses a docker image) with no change

@tianon
tianon merged commit 96e7f3e into docker-library:master Jul 31, 2017
@styfle
styfle deleted the patch-1 branch August 1, 2017 13:03
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@tianon tianon tianon approved these changes
+1 more reviewer
@SimenB SimenB SimenB left review comments
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@styfle @tianon @SimenB