This is an automated email from the ASF dual-hosted git repository. rcordier pushed a commit to branch staging in repository https://gitbox.apache.org/repos/asf/james-site.git
commit 762eadbf7ed844b0c1f0fdcb84d6b3dfa51b4b35 Author: Jean Helou <[email protected]> AuthorDate: Sat Apr 3 03:07:54 2021 +0200 Improve james-site readme (#12) Integrate build instructions in a more easily discoverable location Explain the way branches are organized and the role of the 4 primary branches. --- CONTRIBUTING.adoc | 37 +++++++++++++++++++++++++++++++++++++ README.adoc | 15 +-------------- 2 files changed, 38 insertions(+), 14 deletions(-) diff --git a/CONTRIBUTING.adoc b/CONTRIBUTING.adoc new file mode 100644 index 000000000..f714123a3 --- /dev/null +++ b/CONTRIBUTING.adoc @@ -0,0 +1,37 @@ += Contributing + +This repository is part of https://james.apache.org/[Apache James] project. + +The sources are available here https://gitbox.apache.org/repos/asf#james and mirrored to Github. + +This repository contains 4 branches with specific roles: + +- `asf-site` contains the files which are effectively deployed to `https://james.apache.org` +- `asf-staging` contains the files which are deployed to `https://james.staged.apache.org` +- `live` is automatically built by a job one the [CI server](https://builds.apache.org/job/james/job/ApacheJames-Website/job/live/) +- `staging` is automatically built by a job one the [CI server](https://builds.apache.org/job/james/job/ApacheJames-Website/job/staging/) + +Content pushed to `asf-site` and `asf-staging` is automatically published by +an ASF process akin to github or gitlab pages. This process can be configured +using the [.asf.yaml](https://cwiki.apache.org/confluence/display/INFRA/git+-+.asf.yaml+features) +file. + +The output of the `staging` branch build is pushed to the `asf-staging` branch, +by the CI job and thus is automatically deployed to https://james.staged.apache.org/. + +The output of the `live` branch build is ultimately meant to be pushed to the +`asf-site` branch by the corresponding CI job and thus will automatically be +deployed to https://james.apache.org/. + +However at the time of this writing, the documentation website is being reorganized and +migrated to antora. Thus the link between `live` and `asf-site` is not enabled yet but it +is the target. + +PRs to this repository should generally target the `staging` branch. + += LICENSING + +The website must not be published as Apache Release. +The reason is the antora ui-bundle uses MPL 2.0 license and we can't mix it with ASF 2.0 + https://issues.apache.org/jira/browse/LEGAL-530 . + diff --git a/README.adoc b/README.adoc deleted file mode 100644 index 650a688df..000000000 --- a/README.adoc +++ /dev/null @@ -1,14 +0,0 @@ -= Apache James website - -This repository is part of https://james.apache.org/[Apache James] project. - -The sources are available here https://gitbox.apache.org/repos/asf#james and mirrored to Github. - -This repository is used for storing (some) content for https://james.apache.org[Apache James] website. - -It's also used to build and publish the website. - -Please see https://james.apache.org/james-site/latest/index.html[online documentation website] or the `docs/` folder. - -IMPORTANT: The website must not be published as Apache Source files. -The reason is the antora ui-bundle uses MPL 2.0 license and we can't mix it with ASF 2.0 https://issues.apache.org/jira/browse/LEGAL-530 . diff --git a/README.adoc b/README.adoc new file mode 120000 index 000000000..4d3039cdd --- /dev/null +++ b/README.adoc @@ -0,0 +1 @@ +docs/modules/ROOT/pages/index.adoc \ No newline at end of file --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
