Dockerfile introduced

[typekpb]

No description provided.

[MikeRalphson]

Thanks for the PR. The Dockerfile looks a little generic to me (though I'm no expert). Wouldn't we need to expose a volume mapping so people can specify the input file and get at the output?

[typekpb]

you're right, but usage is kind of case-specific. For example, if I follow the official Example, it could be done like:

docker run -it --rm -v ${PWD}:/usr/src/app/petstore3.json:ro -v ${PWD}/md/:/usr/src/app/md/ widdershins:latest /bin/sh -c "node widdershins /usr/src/app/petstore3.json --search false --language_tabs 'ruby:Ruby' 'python:Python' --summary -o /usr/src/app/md/petstore3.html.md"

[MikeRalphson]

I think we would need an example added to either the README.md, a docs/docker.md file or the wiki...

Can I ask (I know I'm biased) but why use Docker to run node.js programs at all? It's very easy to install node on every platform I've ever tried it on...

[typekpb]

README.md file updates provided (with TODOs for dockerhub org/link)

why docker? because then docker is the only dependency we need to install to our documentation pipeline. And widdershins is not the only tool we use. And we don't need to care about the updates as docker pull does the job

[jalaziz]

Thanks for the PR. The Dockerfile looks a little generic to me (though I'm no expert). Wouldn't we need to expose a volume mapping so people can specify the input file and get at the output?

I would discourage specifying a volume in the Dockerfile. It's trivial to document that a volume could be used (via CLI or whatever), but specifying a volume in the Dockerfile itself can result in volume leaking if anyone inherits from this docker image and specifies their own volumes. Docker currently doesn't allow you to remove volumes from base images despite a long running issue asking for that behavior.

[typekpb]

@MikeRalphson any chance to get this one processed?

[MikeRalphson]

@typekpb sorry, yes, don't see why not, but do we need a .dockerignore file to prevent copying any existing node_modules or .git directories into the image?

[typekpb]

@MikeRalphson .dockerignore introduced

[typekpb]

seems to have low prio, right?

[MikeRalphson]

Sorry no, it will be included in the next release, but the features for that are still being worked on.

[adrianlungu]

Is this still on the roadmap ?

[steveannett]

@MikeRalphson will this be added as a feature soon? I'd really appreciate having the Dockerfile added as it would make certain build pipelines easier. Thank you for the awesome stuff you've built.