This is an automated email from the ASF dual-hosted git repository. btellier pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/james-project.git
commit a0c2d8f93fffb3559c3321d37166a0100b340d06 Author: Juhan Aasaru <[email protected]> AuthorDate: Thu Sep 24 14:45:36 2020 +0300 JAMES-3187 move releasing and publishing website into separate sections. Code review fix (not needed 8080 port). --- README.adoc | 74 ++----------------------------- docs/modules/community/pages/release.adoc | 17 +++++++ docs/modules/community/pages/website.adoc | 51 +++++++++++++++++++++ 3 files changed, 71 insertions(+), 71 deletions(-) diff --git a/README.adoc b/README.adoc index 3ac6b06..1641073 100644 --- a/README.adoc +++ b/README.adoc @@ -161,7 +161,7 @@ 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 -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 + $ 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 You need a running *ElasticSearch* in docker. To achieve this run: @@ -490,73 +490,5 @@ James comes with a https://james.apache.org/documentation.html[Documentation] an == 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 - -See details on http://www.apache.org/dev/publishing-maven-artifacts.html - -In short, just follow the 'standard' process: - -* Prepare pom for release -* publish snapshot -* prepare release -* stage the release for a vote (don't forget to close the staging repository) -* vote -* release - -Don't forget to add your key to https://downloads.apache.org/james/KEYS - - $ ssh people.apache.org - $ cd /www/www.apache.org/dist/james - +* link:docs/modules/community/pages/website.adoc[How to build and publish the website] +* link:docs/modules/community/pages/release.adoc[How to release via maven release plugin] diff --git a/docs/modules/community/pages/release.adoc b/docs/modules/community/pages/release.adoc new file mode 100644 index 0000000..65d81ba --- /dev/null +++ b/docs/modules/community/pages/release.adoc @@ -0,0 +1,17 @@ += How to create an official Apache James release + +Read details about http://www.apache.org/dev/publishing-maven-artifacts.html[Publishing Maven releases to Maven Central Repository] + +In short, just follow the 'standard' process: + +* prepare pom for release +* publish snapshot +* prepare release +* stage the release for a vote (don't forget to close the staging repository) +* vote +* release + +Don't forget to add your key to https://downloads.apache.org/james/KEYS + + $ ssh people.apache.org + $ cd /www/www.apache.org/dist/james diff --git a/docs/modules/community/pages/website.adoc b/docs/modules/community/pages/website.adoc new file mode 100644 index 0000000..0cd130a --- /dev/null +++ b/docs/modules/community/pages/website.adoc @@ -0,0 +1,51 @@ += Building and publishing 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 --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
