more clarity in the documentation between local / CI testing, usage and support
preparation to add information about running Docker, so that the structures will be able to fit. (The plan is to mark the CI examples which use Docker and add explicit instructions about running the repo in Docker locally.)
Change
This PR restructures the README section about running tests.
It starts from a set of instructions to clone and run, which can be simply copied and pasted. It explains then in more detail about options and what happens behind the scenes.
Local testing and CI testing are clearly separated.
Documentation and getting help are also separated from the instructions about running tests.
The link to the 5 year old CHANGELOG_OLD.md in the README is also removed as this is now very old and no longer needed / helpful. The file itself is left in place
Goals
In the README the goals are:
Change
This PR restructures the README section about running tests.
It starts from a set of instructions to clone and run, which can be simply copied and pasted. It explains then in more detail about options and what happens behind the scenes.
Local testing and CI testing are clearly separated.
Documentation and getting help are also separated from the instructions about running tests.
The link to the 5 year old CHANGELOG_OLD.md in the
README
is also removed as this is now very old and no longer needed / helpful. The file itself is left in place