chibenwa commented on a change in pull request #247: URL: https://github.com/apache/james-project/pull/247#discussion_r492626464
########## File path: README.adoc ########## @@ -576,3 +509,76 @@ By default James is configured without LDAP support. == Know more about James design James comes with a https://james.apache.org/documentation.html[Documentation] and https://github.com/linagora/james-project/tree/master/src/adr[Architectural Decision Records]. + +== Articles for James community + +=== How to build and publish the website Review comment: I propose to be moving these files to `/docs/modules/community/pages/website.md` and add a link to it in the README. ########## File path: README.adoc ########## @@ -161,18 +161,18 @@ You need a running *rabbitmq* in docker. To achieve this run: You need a running *s3* compatible objectstorage in docker. To achieve this run: - $ docker run -d --env 'REMOTE_MANAGEMENT_DISABLE=1' --env 'SCALITY_ACCESS_KEY_ID=accessKey1' --env 'SCALITY_SECRET_ACCESS_KEY=secretKey1' --name=s3 zenko/cloudserver:8.2.6 + $ docker run -d -p 8080:8000 --env 'REMOTE_MANAGEMENT_DISABLE=1' --env 'SCALITY_ACCESS_KEY_ID=accessKey1' --env 'SCALITY_SECRET_ACCESS_KEY=secretKey1' --name=s3 zenko/cloudserver:8.2.6 Review comment: Adding back the port binding seems unrelated with the commit title `JAMES-3187 remove separate chapters "Handling attachment indexing"` ########## File path: README.adoc ########## @@ -576,3 +509,76 @@ By default James is configured without LDAP support. == Know more about James design James comes with a https://james.apache.org/documentation.html[Documentation] and https://github.com/linagora/james-project/tree/master/src/adr[Architectural Decision Records]. + +== Articles for James community + +=== How to build and publish the website + +The source code of website https://james.apache.org[james.apache.org] is located in src/homepage. +Here are the instructions how to publish new changes to the website. + +1. Install Apache Maven 3.0.2+ and make its binary 'mvn' available on your PATH. +See http://maven.apache.org/download.html#Installation. +2. run "mvn clean site" +3. Test the built site in your browser from the {path}/target/site folder +4. If everything looks OK, deploy the site using "mvn clean site-deploy". +5. Wait for the changes to replicate to the Apache web server or setup 140.211.11.10:80 as +a proxy to review the changes (described here: http://www.apache.org/dev/project-site.html) + +To deploy the technical reports use the "-Psite-reports" profile. + +For wagon-ssh-external configuration see +http://maven.apache.org/plugins/maven-deploy-plugin/examples/deploy-ssh-external.html + +You can alternatively use a docker container to build the website : + +You need to build the homepage by: + + $ docker build -t james/homepage dockerfiles/site/homepage + $ docker run -v $PWD:/origin -v $PWD/site:/destination james/homepage master + +In order to test the homepage, you can use this command: + + $ docker run --rm -v $PWD/site:/srv/jekyll -p 4000:4000 -it jekyll/minimal:3.8.3 jekyll serve + +the site will be available at http://localhost:4000/ + +Then you build the other pages by: + + $ docker build -t james/site dockerfiles/site/website + $ docker run -v $PWD/.m2:/root/.m2 -v $PWD:/origin -v $PWD/site:/destination james/site master + +If you need to update the current site, checkout the branch asf-site from Apache git: + + $ git clone https://git-wip-us.apache.org/repos/asf/james-site.git + $ cd james-site + $ git checkout origin/asf-site -b asf-site + +And replace in the previous commands `$PWD/site` by `<james-site-clone-directory>/content`, for example: + + $ docker run -v $PWD:/origin -v $PWD/../james-site/content:/destination james/homepage master + $ docker run -v $PWD/.m2:/root/.m2 -v $PWD/../james-site/content:/origin -v $PWD/site:/destination james/site master + +Then just push the new site: + + $ cd ../james-site + $ git push origin asf-site + +=== How to release via maven release plugin Review comment: I propose to be moving these files to `/docs/modules/community/pages/release.md` and add a link to it in the README. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
