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

OPENNLP-999: [WIP] website using JBake #163

Closed
wants to merge 2 commits into from
Closed

OPENNLP-999: [WIP] website using JBake #163

wants to merge 2 commits into from

Conversation

wcolen
Copy link
Member

@wcolen wcolen commented Apr 17, 2017

Thank you for contributing to Apache OpenNLP.

In order to streamline the review of the contribution we ask you
to ensure the following steps have been taken:

For all changes:

  • Is there a JIRA ticket associated with this PR? Is it referenced
    in the commit message?

  • Does your PR title start with OPENNLP-XXXX where XXXX is the JIRA number you are trying to resolve? Pay particular attention to the hyphen "-" character.

  • Has your PR been rebased against the latest commit within the target branch (typically master)?

  • Is your initial contribution a single, squashed commit?

For code changes:

  • Have you ensured that the full suite of tests is executed via mvn clean install at the root opennlp folder?
  • Have you written or updated unit tests to verify your changes?
  • If adding new dependencies to the code, are these dependencies licensed in a way that is compatible for inclusion under ASF 2.0?
  • If applicable, have you updated the LICENSE file, including the main LICENSE file in opennlp folder?
  • If applicable, have you updated the NOTICE file, including the main NOTICE file found in opennlp folder?

For documentation related changes:

  • Have you ensured that format looks appropriate for the output in which it is rendered?

Note:

Please ensure that once the PR is submitted, you check travis-ci for build issues and submit an update to your PR as soon as possible.

@kinow
Copy link
Member

kinow commented Apr 17, 2017

New site layout is looking tidy and neat! Some pages like mailing lists could get some more formatting to distinguish the different mailing lists, the manuals probably could be updated later as well, but looking better than actual IMO.

For others wanting to give it a try; running mvn site will create the old site, so instead you want to run (as is mentioned in the README included in the pull request) mvn clean package jbake:inline -Djbake.port=8080 -Djbake.listenAddress=0.0.0.0

Takes a few minutes, but then you will have the web site running (similar to jekyll run, though not sure if equally similar to jekyll run --watch). Below some screen shots of the web site in regular size, and in mobile/compact size.

Regular size

Mobile size

Cheers
Bruno

@coveralls
Copy link

Coverage Status

Coverage remained the same at 56.243% when pulling 480e715 on wcolen:opennlp-site into f8fbfc9 on apache:master.

@kinow
Copy link
Member

kinow commented Apr 17, 2017

though not sure if equally similar to jekyll run --watch

Yup, same behaviour. Changed one template file, and it automatically re-loaded to display the most up to date file :-) Liking JBake so far.

Now template use new Bootstrap classes

closes wcolen/opennlp#1
@wcolen wcolen closed this May 5, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
3 participants