Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[CAMEL-11501] Update README #22

Merged
merged 2 commits into from Mar 12, 2019

Conversation

@christophd
Copy link
Contributor

christophd commented Mar 8, 2019

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 node_modules works fine though.

Also introduced an optional Maven build process because of these reasons:

  • Build is more stable as it always uses the same versions of yarn and node
  • Build combines Antora UI theme build and Hugo site generation in one single build
  • Users not familiar with node, yarn, gulp and so on can easily build the UI (only Maven required)

The README describes both ways to build the website with and without Maven.

@oscerd
oscerd approved these changes Mar 8, 2019
@zregvart

This comment has been minimized.

Copy link
Contributor

zregvart commented Mar 9, 2019

We control the version of yarn via .yarnrc, so no matter what version of yarn you have installed the version we have in the repository is used. See:

yarn-path ".yarn/releases/yarn-1.14.0.js"

yarn-path ".yarn/releases/yarn-1.14.0-0.js"

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 .nvmrc to do so:

I'd rather see an investment in existing build toolset Node/Yarn/gulp than adding another build tool.

@christophd

This comment has been minimized.

Copy link
Contributor Author

christophd commented Mar 11, 2019

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

@christophd christophd force-pushed the christophd:issue/CAMEL-11501/create-readme branch from 460e547 to 7fffe03 Mar 11, 2019
@christophd

This comment has been minimized.

Copy link
Contributor Author

christophd commented Mar 11, 2019

@zregvart please have another look. Force pushed my changes according to your feedback to this PR

Copy link
Contributor

zregvart left a comment

Awesome 👍 thanks!

@zregvart zregvart merged commit 3b8f70a into apache:master Mar 12, 2019
1 check passed
1 check passed
continuous-integration/jenkins/pr-merge This commit looks good
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.