You are viewing a plain text version of this content. The canonical link for it is here.
Posted to notifications@james.apache.org by GitBox <gi...@apache.org> on 2021/04/02 14:10:59 UTC
[GitHub] [james-site] jeantil opened a new pull request #12: Improve james-site readme
jeantil opened a new pull request #12:
URL: https://github.com/apache/james-site/pull/12
I found it pretty difficult to locate the important steps to build the repository and what the various branche were about. I therefore propose this PR which reorganizes the code and documents my findings
One downside it that it changes README.adoc to be a symbolic link to docs/module/ROOT/index.adoc. On current machines it should work on all OSes since even windows supports symbolic links but I haven't tried it.
Unfortunately github doesn't support [adoc include directives](https://github.com/github/markup/issues/1095) and I was unable to make antora resolve the README (but maybe it can be done)
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-812876610
I'm ok with `merge staging on live, hard reset staging to live`
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] jeantil commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
jeantil commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-814127544
I can do the merge part with a PR, but you will have to handle the hard reset :)
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on a change in pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on a change in pull request #12:
URL: https://github.com/apache/james-site/pull/12#discussion_r606259329
##########
File path: 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/live/)
Review comment:
The link is the same than above.
##########
File path: docs/modules/ROOT/pages/index.adoc
##########
@@ -2,7 +2,7 @@
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.
+It's also used to build and publish the website. foo
Review comment:
Oups?
##########
File path: 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/live/)
+
+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 Source files.
Review comment:
```suggestion
The website must not be includes in an Apache Release.
```
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] jeantil commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
jeantil commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-812835532
Yes howerver there is a small issue : 7b56e2a3b is only on live and not on staging we need to get it on both in a way that then lets us merge staging into live.
There are various ways to do this :
- remove 7b56e2a3b from live, put it on staging, merge staging on live
- merge staging on live, hard reset staging to live
- merge live on staging then staging on live (not my favorite but it works)
I also suggest changing the "default" branch of this repo to staging so that by default the merge requests get targeted at staging and not live.
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa merged pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa merged pull request #12:
URL: https://github.com/apache/james-site/pull/12
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-814216326
Ok let's do that.
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] jeantil commented on a change in pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
jeantil commented on a change in pull request #12:
URL: https://github.com/apache/james-site/pull/12#discussion_r606289358
##########
File path: 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/live/)
Review comment:
fixedup
##########
File path: docs/modules/ROOT/pages/index.adoc
##########
@@ -2,7 +2,7 @@
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.
+It's also used to build and publish the website. foo
Review comment:
fixedup
##########
File path: 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/live/)
+
+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 Source files.
Review comment:
fixedup
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-812770210
We should mabe mirror these changes on the live branch too?
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-814557045
`hard reset staging to live` -> done
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa commented on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa commented on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-812876532
I see...
Can't we rebase stagin on live (and force push it) ?
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org
[GitHub] [james-site] chibenwa removed a comment on pull request #12: Improve james-site readme
Posted by GitBox <gi...@apache.org>.
chibenwa removed a comment on pull request #12:
URL: https://github.com/apache/james-site/pull/12#issuecomment-812876532
I see...
Can't we rebase stagin on live (and force push it) ?
--
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:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: notifications-unsubscribe@james.apache.org
For additional commands, e-mail: notifications-help@james.apache.org