[MRG] Improve docs on Dockerfile escape hatch#1271
[MRG] Improve docs on Dockerfile escape hatch#1271MattF-NSIDC wants to merge 4 commits intojupyterhub:mainfrom
Conversation
sphinx-doc/sphinx#11094 `extlinks` config expects a formatting slug in the caption portion of its config. Without it, Sphinx 6.x throws: Exception occurred: File "/path/to/site-packages/sphinx/ext/extlinks.py", line 103, in role title = caption % part TypeError: not all arguments converted during string formatting
|
Thanks for submitting your first pull request! You are awesome! 🤗 |
When creating a Dockerfile from redirecting debug output, `repo2docker` sees the initially-empty `Dockerfile` and that influences its output (since `Dockerfile` is empty, `repo2docker` outputs nothing).
|
I experienced some unexpected behavior and added a warning to the docs ☝️ |
|
I feel like more documentation is needed. When I create a When I remove those steps, later steps fail because |
|
The debug output is just for debugging, it's not intended to be buildable since you also need the full context that's created on the fly, and I don't think we should recommend it as a way to create a Dockerfile. I've got a playground/proof-of-concept in https://github.com/manics/repo2shellscript if you're interested in seeing the full complexity. |
|
Thanks @manics! Is there anything that can be documented about migrating from a config-file based build to a Dockerfile-based build? Does |
…ped past me I did not see the "Can I use repo2docker to bootstrap my own Dockerfile?" FAQ the first time through. I've linked it from the part that I _did_ see so hopefully the next person through (maybe me in 6 months) won't have the same misunderstanding!
|
Here's how I solved my problem: CryoInTheCloud/hub-image#65 As you know, I totally missed the "Can I use repo2docker to bootstrap my own Dockerfile?" FAQ on my first time through 😆 I've added a link to it where I would have seen it my first time through and replaced my bad suggestions with hopefully better ones, in addition to a new FAQ to resolve the specific problem with |
| .. note:: | ||
| If a Dockerfile is present, all other configuration files will be ignored. | ||
| With Dockerfiles, a regular Docker build will be performed. All other | ||
| configuration files will be ignored. |
There was a problem hiding this comment.
@manics I'd like to add a sentence here clarifying what value repo2docker is providing to the user in this case. e.g. All other configuration files will be ignored, but 'repo2docker' will still ___? Thoughts?
Thanks for your input on this change :)
4 participants
I was struggling to find how to get the generated Dockerfile contents. When I found it, I thought I'd open a PR to add a link from the first place I looked for the next person who struggles :)