Comments (3)
Indeed, although if the documentation is outside the Dockerfile (and then lost) it's not very useful. Given there are projects that just grab/save Dockerfile and not surrounding context, I think Dockerfile comments are fairly important, and external to that a bonus. So they both are important.
from ten-simple-rules-dockerfiles.
@vsoch Thank you for your quick reply.
If a project documents everything in mark down files, possibly the documentation of the Dockerfile should be there as well. Also if the Dockerfile is generated automatically, it makes not much sense to have documentation there.
I see another risk that higher concepts are forgotten when documenting in Dockerfile instead of specification (in projects that have such). Often people document in Dockerfile (or other files) only "what happens inside", but not why it is needed, where the outputs go to and so on.
Of course you can always use it wrongly, such as copying a Dockerfile without its README.md :)
Of course I agree that documentation is important, but creating a rule to allow to "just grab/save Dockerfile and not surrounding context" does not sound suited to me.
from ten-simple-rules-dockerfiles.
Yes, but you are missing the case where an automated tool has scraped a bunch of repos to find the Dockerfile and save them separately, without context (I've done this several times).
from ten-simple-rules-dockerfiles.
Related Issues (20)
- ENV and ARG HOT 3
- Source code for figure
- Rules 6 & 7 HOT 9
- Improve and clarify bind mounts vs. volumes HOT 3
- Publish a bookdown rendering
- Content beyond the paper HOT 1
- New projects, packages, ideas for follow ups, new revisions, etc. HOT 10
- Build current master PDF with GitHub action, not with Travis HOT 1
- (Comment) Rule 0 - Don't use docker HOT 6
- Comments about rule 2: "Build upon existing images" HOT 3
- comment about rule 3: "Format for clarity" HOT 6
- comments about rule 5: "Specify software versions" HOT 4
- comment about rule 6: "Use version control" HOT 3
- comments about rule 7: "Mount dataset at run time" HOT 9
- comments about rule 8: "Make the image one-click runnable" HOT 5
- comments about rule 9 "Order the instructions" HOT 1
- comments about rule 10 "Regularly use and rebuild containers" HOT 9
- Comments about Rule 1 "Use available tools" HOT 1
- Related work HOT 2
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from ten-simple-rules-dockerfiles.