Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.Sign up
[CAMEL-11501] Update README #22
This PR updates both root README and antora-ui-camel README in order to describe the build process and where to add someones changes.
I had to remove pnp install config as it always failed on my machine. I am sure this is because of some newer node and yarn versions on my machine. Plain old yarn with
Also introduced an optional Maven build process because of these reasons:
The README describes both ways to build the website with and without Maven.
We control the version of yarn via
I would like not to have another build tool in the mix. Having Node and Yarn should suffice. Yarn doesn't currently support Node 11, and that's why we encounter issues using it. Note that on the Node site version 10 is LTS and "Recommended For Most Users", so I think it's a good decision to stick with that version. Adding Maven to the mix is just another tool that we have to take on and maintain, and I'd like to keep the project as simple as it can be. Using PnP is much more beneficial than using the latest Node version. With PnP we can cache Node modules outside of the git repository which drastically speeds up the build on CI where the build runs on different nodes without any opportunity for caching, so all Node modules are re-downloaded/build.
To use a fixed Node version I believe nvm is often used. Antora theme already contains
I'd rather see an investment in existing build toolset Node/Yarn/gulp than adding another build tool.
I can confirm that the PnP errors were related to me using Node v11 instead of Node v10. With Node v10 everything works out fine. I will add this to the README as well.
So I will bring back PnP and I will also remove the Maven build from this PR and perhaps open a new one with that Maven build option (as I still see some benefit from it that we can discuss in another PR).
Let me fix these things and force push to this PR