Overhaul README.md in this repository #3860
Labels
docker
Issues related to our docker files and docker scripts
documentation
Issues that request updates to our documentation
jenkins
Issues that enhance or fix our jenkins server
macos
Issues that affect or relate to the MAC OS
testing
Issues that enhance or fix our test suites
There have been very few updates to the top level README.md in the temurin-build and ci-jenkins-pipelines repositories, and so we should look at them and see if they are "fit for purpose" and whether the information on here that we present to our user base is (a) useful (b) accurate and (c) fit for purpose.
I've started with an overhaul of the ci-jenkins-pipelines README.md in adoptium/ci-jenkins-pipelines#1048 but here are some discussion points for the one in here:
-D
option on makejdk-any-platform.sh to automatically build in a new container image to avoid discouraging podman users (Also, why do we have this section yet also reference the dockerfile generator in the "build natively" section? Is this likely to be confusing to first time users?) NOTE: This is converted to-D
in https://github.com/adoptium/temurin-build/pull/3796/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5test/functional/buildAndPackage/README.md
?docs
directory in this repository which no longer exists which should be updated or removed.Overall we should also try and tidy up our recommendations on where things affecting the builds should be changed e.g. configure-args etc. since we do have multiple places where these can be set. (There's some info on this, but more discussion would be useful)
The text was updated successfully, but these errors were encountered: