Updating Adding Tools section in EXTENDING_DOCKER.adoc #607
Conversation
| ---- | ||
| tool: | ||
| git: | ||
| installations: | ||
| - name: git | ||
| home: /usr/bin/git | ||
| ---- |
There was a problem hiding this comment.
I think maybe it would be better to inform the user of the perspective you are coming from throughout, so they could avoid the pitfall wherein they follow your instructions as is and would likely be getting errors due to setup config issues. For example in here, you could add that say for macOS users who would ordinarily install their git using Homebrew or brew, their git path would alternatively or additionally be something like /opt/homebrew/bin/git. As is the code would not work for some macOS and Windows users.
There was a problem hiding this comment.
Here we are installing git in jenkinsfile-runner docker image which is linux based, so I think there is no need to specify the installation paths for macOS or windows users.
There was a problem hiding this comment.
You will have to explain at least something like "the jenkinsfile-runner docker image is linux-based", or people will not be aware of it.
There was a problem hiding this comment.
I think the one who knows jenkins, can easily understand this, and also isn't it obvious that it is Linux based docker image for anyone using jenkinsfile-runner docker image?
There was a problem hiding this comment.
Well we have to consider new-comers to Jenkins as well like yourself.
There was a problem hiding this comment.
yeah, you are right but see all docker images created from base images like ubuntu, centos and these are linux based and since here this is the Docker doc for jenkinsfile-runner, so I guess there is no need to mention anything like here.
docs/using/EXTENDING_DOCKER.adoc
Outdated
| home: /usr/bin/git | ||
| ---- | ||
|
|
||
| Now you can run a Jenkinsfile having `git` as a stage like given below |
There was a problem hiding this comment.
It would be better to state what is the intention of this Jenkinsfile content, since some contributors will inevitably be newbies. You can for example say something like "The following is to illustrate a 'Hello, World' example by way of a Jenksinsfile...". Otherwise it would take time for the user of this guide to guess the context of this bit of documentation.
There was a problem hiding this comment.
Any update about this PR?
| ---- | ||
| docker run --rm -v $(pwd)/Jenkinsfile:/workspace/Jenkinsfile -v $(pwd)/jenkins.yaml:/usr/share/jenkins/ref/casc/jenkins.yaml jenkinsfile-runner:my-image | ||
| ---- | ||
| Here `jenkinsfile-runner:my-image` is custom docker image created from above Dockerfile. |
There was a problem hiding this comment.
Instead of concluding with this line, you could extend to other cases by generalising or providing a list of the names of the other tools (as we have discussed on Gitter before), which they could try using the same procedure. Otherwise it appears like this is only useful for the git tool alone. With more details the user of the documentation would not feel lost as the stud may appear incomplete to some who would like to learn more. It would indeed be a very nice documentation if the desired effect could be described in detail, perhaps with screenshots to capture the intended outcome.
docs/using/EXTENDING_DOCKER.adoc
Outdated
| } | ||
| } | ||
| ---- | ||
| You can then run `jenkinsfile-runner` like this |
There was a problem hiding this comment.
Better use more formal language like "You can then run jenkinsfile-runner like the following:" or "You can then run jenkinsfile-runner like what is shown below:" then using the more colloquial phrase "like this" as in casual conversation. Using a colon would definitely help with the punctuation.
|
Sorry I definitely missed the last update |
This is a simple demo for how to add tools in jenkinsfile-runner. Same can be applied to add other tools.