You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@marmotta.apache.org by Andy Seaborne <an...@apache.org> on 2012/12/05 14:54:31 UTC
Apache infrastructure resources
Here is a check list of resources that I assembled from the proposal.
If it looks OK, I'll start to raise the JIRA and subJIRA for the
"immediate" items as soon as possible.
== Immediate
1/ Mailing lists - done.
2/ JIRA for Marmotta
This will need an named administrator who can set the JIRA area up fr
the project. A volunteer please?
3/ GIT
4/ website
It's the link that gets handled out a lot so getting something in place
is always good even if it is a basic page and "coming soon".
svnpubsub is the publishing mechanism used by Apache; it pushes the
content out from a svn repo the front-facing servers.
How the content gets into the svn repo is the projects responsibility.
(FYI: Jena uses CMS, other projects use maven site)
http://incubator.apache.org/guides/mentor.html#create-website
NB http://marmotta.incubator.apache.org/ already returns 404
== And then
Then there are: (I'm looking for owners for these)
A/ Wiki for internal documentation purposes
The project has a choice:
1/ MoinMoin
2/ cwiki
Is a wiki part of your current practice? If so, what about transfer of
content? If not, do you want to delay getting it while a choice is agreed?
B/ Jenkins, if you want a CI build process
C/ org.apache.marmotta on Nexus
For snapshot builds and releases.
D/ Blog to improve the project dissemination
Is there a current one? Or is this an additional nice to have (=> less
urgent until the project has a picture of how it will get used).
Andy
Re: Apache infrastructure resources
Posted by Andy Seaborne <an...@apache.org>.
On 05/12/12 14:33, Sergio Fernández wrote:
>> B/ Jenkins, if you want a CI build process
>
> I would say yes.
>
> BTW, email reports to where? By default many projects send to
> dev@marmotta, but I'd prefer commits@marmotta for those reports. Same
> decision for Jira.
Definitely send Hudson email to commits@. It can be a bit noisy - it's
a big complicated deployment and if it's having a bad day, jobs fail
because of transitory problems.
For JIRA, it's another form of discussion. commits@ is usually seen as
a place for tracking as needed (AKA people don't look all the time!) but
JIRA discussions and new JIRA raised are much more like email threads so
sending them to dev@ would be more usual.
Andy
Re: Apache infrastructure resources
Posted by Jakob Frank <ja...@apache.org>.
On Wed, 2012-12-05 at 22:40 +0100, Sebastian Schaffert wrote:
> > cwiki is a confluence wiki host:
> >
> > http://cwiki.apache.org/
> Then everything is perfect anyways :-)
As far as I understood [1], Confluence was an option for a project's
website, not for the wiki.
The idea is to edit pages in confluence and then have a static export of
the pages to be served. But anyway, confluence is not supported any
more, its phasing out. [2]
For the wiki I'd prefer moinmoin.
Best,
Jakob
[1] http://www.apache.org/dev/cms.html#confluence-limitations
[2] http://www.apache.org/dev/cms.html#confluence-phaseout
Re: Apache infrastructure resources
Posted by Sebastian Schaffert <ss...@apache.org>.
2012/12/5 Andy Seaborne <an...@apache.org>
> On 05/12/12 15:18, Sebastian Schaffert wrote:
>
>> Hi all,
>>
>> I agree with all of Sergio's points.
>>
>> MoinMoin is second-best since we cannot have Confluence. :) The current
>> wiki content is in the Google Code wiki, it should not be too difficult to
>> migrate it.
>>
>
> cwiki is a confluence wiki host:
>
> http://cwiki.apache.org/
Then everything is perfect anyways :-)
>
>
> This not a recommendation - just information.
>
> You can use confluence to produce the main website (I understand - not
> been involved in a project that has).
>
>
I would not recommend it. We are using Confluence for our group wiki, but
producing a custom webseite with it not looking like a wiki is hard :-)
Greetings,
Sebastian
Re: Apache infrastructure resources
Posted by Sebastian Schaffert <ss...@apache.org>.
Hi Andy,
thanks for all the work, it is really appreciated.
Developer list is ok, we will talk with Dietmar so he registers with the
mailing list and Jira.
Greetings,
Sebastian
2012/12/6 Andy Seaborne <an...@apache.org>
> Infrastructure request:
>
> https://issues.apache.org/**jira/browse/INFRA-5608<https://issues.apache.org/jira/browse/INFRA-5608>
>
> As I'm a newbie at this, I may not have supplied to the necessary
> information so it may take a round or two of discussion on the JIRAs.
>
> It covers:
>
> GIT
> JIRA
> Nexus
>
> ** GIT commiters - I used your Apache ids unless I could find it.
>
> Rupert, I've used your Apache id rwesten as listed on
> http://incubator.apache.org/**projects/marmotta.html<http://incubator.apache.org/projects/marmotta.html>,
> not your registration to the private list - hope that's the right thing to
> do.
>
> ** Nexus: this is a separate log-in system. Sergio is the request admin.
> The inital developer list is (JIRA ids) andy.seaborne, wikier, fchrist,
> wastl, rwesten, jakob -- others wil need to be added later (I couldn't see
> the rest of you so I guess you haven't got JIRA ids - or I missed you in
> which case apologies).
>
> ** svnpubsub:
>
> We'll need more details because if the project is using GIT, we need to
> work out how to get stuff into SVN.
>
> Rather than hold up everything else I went ahead with the request so the
> important stuff progresses.
>
> Andy
>
>
Re: Apache infrastructure resources
Posted by Andy Seaborne <an...@apache.org>.
Infrastructure request:
https://issues.apache.org/jira/browse/INFRA-5608
As I'm a newbie at this, I may not have supplied to the necessary
information so it may take a round or two of discussion on the JIRAs.
It covers:
GIT
JIRA
Nexus
** GIT commiters - I used your Apache ids unless I could find it.
Rupert, I've used your Apache id rwesten as listed on
http://incubator.apache.org/projects/marmotta.html, not your
registration to the private list - hope that's the right thing to do.
** Nexus: this is a separate log-in system. Sergio is the request
admin. The inital developer list is (JIRA ids) andy.seaborne, wikier,
fchrist, wastl, rwesten, jakob -- others wil need to be added later (I
couldn't see the rest of you so I guess you haven't got JIRA ids - or I
missed you in which case apologies).
** svnpubsub:
We'll need more details because if the project is using GIT, we need to
work out how to get stuff into SVN.
Rather than hold up everything else I went ahead with the request so the
important stuff progresses.
Andy
Re: Apache infrastructure resources
Posted by Bertrand Delacretaz <bd...@apache.org>.
On Wed, Dec 5, 2012 at 10:35 PM, Andy Seaborne <an...@apache.org> wrote:
>... You can use confluence to produce the main website...
IIUC this option is being phased out by Apache infra, the goal (again
IIUC) is to have all project websites generated via svnpubsub or the
Apache CMS.
-Bertrand
Re: Apache infrastructure resources
Posted by Andy Seaborne <an...@apache.org>.
On 05/12/12 15:18, Sebastian Schaffert wrote:
> Hi all,
>
> I agree with all of Sergio's points.
>
> MoinMoin is second-best since we cannot have Confluence. :) The current
> wiki content is in the Google Code wiki, it should not be too difficult to
> migrate it.
cwiki is a confluence wiki host:
http://cwiki.apache.org/
This not a recommendation - just information.
You can use confluence to produce the main website (I understand - not
been involved in a project that has).
> Regarding GIT I would even insist a bit, because there are many advantages,
> especially the branching and merging functionalities. We are already using
> this quite a bit with Mercurial.
>
> Regarding the website we have our designer already working on a logo, and I
> suggest we use "mvn site" to automatically generate it, because this will
> already create a lot of documentation.
>
> Greetings,
>
> Sebastian
>
Re: Apache infrastructure resources
Posted by Sebastian Schaffert <ss...@apache.org>.
Hi Andy,
2012/12/5 Andy Seaborne <an...@apache.org>
> On 05/12/12 16:42, Sebastian Schaffert wrote:
>
>> 2012/12/5 Fabian Christ <ch...@googlemail.com>
>>
>> 2012/12/5 Sebastian Schaffert <ss...@apache.org>
>>>
>>> Regarding the website we have our designer already working on a logo,
>>>>
>>> and I
>>>
>>>> suggest we use "mvn site" to automatically generate it, because this
>>>> will
>>>> already create a lot of documentation.
>>>>
>>>>
>>> So you do not plan to use the Apache CMS [1] for the website? Or do you
>>> plan to generate things from Maven for the Apache CMS?
>>>
>>> It is just a question. I have no experience in generating complete
>>> websites
>>> from Maven or how to combine it with the ASF CMS. Would be nice to see.
>>>
>>>
>> Many projects already do this. If the Maven "site" reporting is configured
>> properly in the Maven build file, this can generate very good and
>> extensive
>> web pages for a project. The Maven site itself is a good example (
>> http://maven.apache.org/).
>>
>> The advantage of this approach is that we would not need to maintain
>> documentation and source code separately, and it is easy to include
>> automatically generated documentation parts like the Javadoc, REST API,
>> License Report, or Developer Information in the web page.
>>
>> So I would try going this approach. :-)
>>
>> Greetings,
>>
>> Sebastian
>>
>>
>>
>> [1] http://www.apache.org/dev/cms.**html<http://www.apache.org/dev/cms.html>
>>>
>>> --
>>> Fabian
>>> http://twitter.com/fctwitt
>>>
>>>
>>
> </mentor>
>
> The website has two distinct faces : inward to the project and it's
> processes, and the maven plugins are good at doing this with reports, but
> also outward to users for documentation and maven really does not do much
> for that aspect in my experience.
>
> In a separate site, there is some stuff that needs to be kept in step with
> versions but, with careful writing, it's not very much.
>
> The outward facing documentation, and I mean more than just javadoc, often
> has a different lifecycle than the inward-looking project reports.
>
Of course. I did not mean that the default configuration of "mvn site"
should replace a proper webpage (it is a more-or-less useless listing of
facts). But properly configured, it is possible to let maven create the
complete webpage with proper documentation using a kind-of markup language.
The advantage I see is just the one mentioned in the link you sent: you
keep the documentation close to the code.
>
> CMS is great for maintenance - read the website, see something to fix,
> press "edit" and do it there and then in the browser. The bulk content is
> markdown+tables.
>
> It may be possible to combine - look at other projects and ask them if
> they look interesting.
>
Agreed. I am not completely fixed on "mvn site", it just looked like a good
approach to me. ;-)
Greetings,
Sebastian
Re: Apache infrastructure resources
Posted by Sergio Fernández <wi...@apache.org>.
OK, I think we'd need to achieve an agreement on this asp. I'll move the
discussion to the public mailing list.
On 11/12/12 14:29, Nandana Mihindukulasooriya wrote:
> Hi,
>
> On Tue, Dec 11, 2012 at 10:41 AM, Sergio Fernández<wi...@apache.org>wrote:
>>
>>
>> Anyway, as I reported in INFRA-5624 [3], the project URL still returns
>> 404. But first they need to know [4] if we'll use CMS or svnpubsub-based
>> site. Not sure if we could change this in the future... but at least I'd
>> like to put something like "coming soon" there meanwhile we wait until the
>> other resources (git, jira and so on).
>>
>
> I just had a chat in the #asfinfra about the this issue INFRA-5624
> (website) where it is dependent on INFRA-5610 (Git repo). Daniel Shahaf
> explained to me that there are three separate things git repos [1], svn
> subtree, git mirror of svn subtree [2]. However, svn subtree is mandatory.
> We can have code in git repo, site in svn subtree (with a git-svn mirror).
>
> They are waiting for us to provide our choice between CMS and svnpubsub.
> About whether we can change it in the future, they said it will double the
> work of the infra team so it is better if we can decide the one we want in
> the long-run.
>
> Best Regards,
> Nandana
>
> [1] - https://git-wip-us.apache.org/
> [2] - http://git.apache.org/
>
--
Sergio Fernández
Re: Apache infrastructure resources
Posted by Nandana Mihindukulasooriya <na...@apache.org>.
Hi,
On Tue, Dec 11, 2012 at 10:41 AM, Sergio Fernández <wi...@apache.org>wrote:
>
>
> Anyway, as I reported in INFRA-5624 [3], the project URL still returns
> 404. But first they need to know [4] if we'll use CMS or svnpubsub-based
> site. Not sure if we could change this in the future... but at least I'd
> like to put something like "coming soon" there meanwhile we wait until the
> other resources (git, jira and so on).
>
I just had a chat in the #asfinfra about the this issue INFRA-5624
(website) where it is dependent on INFRA-5610 (Git repo). Daniel Shahaf
explained to me that there are three separate things git repos [1], svn
subtree, git mirror of svn subtree [2]. However, svn subtree is mandatory.
We can have code in git repo, site in svn subtree (with a git-svn mirror).
They are waiting for us to provide our choice between CMS and svnpubsub.
About whether we can change it in the future, they said it will double the
work of the infra team so it is better if we can decide the one we want in
the long-run.
Best Regards,
Nandana
[1] - https://git-wip-us.apache.org/
[2] - http://git.apache.org/
Re: Apache infrastructure resources
Posted by Sergio Fernández <wi...@apache.org>.
Hi,
maven site uses a quite simple syntax known as APT ("Almost Plain Text")
[1], simpler but less powerful than MarkDown. For the moment we didn't
have time to play so much with in in LMF, only for the welcome page of
the site [2]. So still not sure what is the right option... specially
some important bugs generating more than one report, or at least we were
not able to properly configured (for instance to publish both javadoc
and rest api reports).
Anyway, as I reported in INFRA-5624 [3], the project URL still returns
404. But first they need to know [4] if we'll use CMS or svnpubsub-based
site. Not sure if we could change this in the future... but at least I'd
like to put something like "coming soon" there meanwhile we wait until
the other resources (git, jira and so on).
Cheers,
Sergio
[1] http://maven.apache.org/doxia/references/apt-format.html
[2]
https://code.google.com/p/lmf/source/browse/src/site/apt/index.apt?name=default
[3] http://issues.apache.org/jira/browse/INFRA-5624
[4] http://www.apache.org/dev/infra-contact#what-we-need-to-know
On 05/12/12 22:32, Andy Seaborne wrote:
> The website has two distinct faces : inward to the project and it's
> processes, and the maven plugins are good at doing this with reports,
> but also outward to users for documentation and maven really does not do
> much for that aspect in my experience.
>
> In a separate site, there is some stuff that needs to be kept in step
> with versions but, with careful writing, it's not very much.
>
> The outward facing documentation, and I mean more than just javadoc,
> often has a different lifecycle than the inward-looking project reports.
>
> CMS is great for maintenance - read the website, see something to fix,
> press "edit" and do it there and then in the browser. The bulk content
> is markdown+tables.
>
> It may be possible to combine - look at other projects and ask them if
> they look interesting.
>
> Jena uses CMS - we wanted a separate, designed information architecture,
> one of the project members (Ian) was keen to do it that way and he did
> the bulk of the work. It used HTML content converted to markdown.
>
> Andy
>
> A pro-maven link:
> http://blog.akquinet.de/2012/04/12/maven-sites-reloaded/
>
>
--
Sergio Fernández
Re: Apache infrastructure resources
Posted by Andy Seaborne <an...@apache.org>.
On 05/12/12 16:42, Sebastian Schaffert wrote:
> 2012/12/5 Fabian Christ <ch...@googlemail.com>
>
>> 2012/12/5 Sebastian Schaffert <ss...@apache.org>
>>
>>> Regarding the website we have our designer already working on a logo,
>> and I
>>> suggest we use "mvn site" to automatically generate it, because this will
>>> already create a lot of documentation.
>>>
>>
>> So you do not plan to use the Apache CMS [1] for the website? Or do you
>> plan to generate things from Maven for the Apache CMS?
>>
>> It is just a question. I have no experience in generating complete websites
>> from Maven or how to combine it with the ASF CMS. Would be nice to see.
>>
>
> Many projects already do this. If the Maven "site" reporting is configured
> properly in the Maven build file, this can generate very good and extensive
> web pages for a project. The Maven site itself is a good example (
> http://maven.apache.org/).
>
> The advantage of this approach is that we would not need to maintain
> documentation and source code separately, and it is easy to include
> automatically generated documentation parts like the Javadoc, REST API,
> License Report, or Developer Information in the web page.
>
> So I would try going this approach. :-)
>
> Greetings,
>
> Sebastian
>
>
>
>> [1] http://www.apache.org/dev/cms.html
>>
>> --
>> Fabian
>> http://twitter.com/fctwitt
>>
>
</mentor>
The website has two distinct faces : inward to the project and it's
processes, and the maven plugins are good at doing this with reports,
but also outward to users for documentation and maven really does not do
much for that aspect in my experience.
In a separate site, there is some stuff that needs to be kept in step
with versions but, with careful writing, it's not very much.
The outward facing documentation, and I mean more than just javadoc,
often has a different lifecycle than the inward-looking project reports.
CMS is great for maintenance - read the website, see something to fix,
press "edit" and do it there and then in the browser. The bulk content
is markdown+tables.
It may be possible to combine - look at other projects and ask them if
they look interesting.
Jena uses CMS - we wanted a separate, designed information architecture,
one of the project members (Ian) was keen to do it that way and he did
the bulk of the work. It used HTML content converted to markdown.
Andy
A pro-maven link:
http://blog.akquinet.de/2012/04/12/maven-sites-reloaded/
Re: Apache infrastructure resources
Posted by Sebastian Schaffert <se...@gmail.com>.
2012/12/5 Fabian Christ <ch...@googlemail.com>
> 2012/12/5 Sebastian Schaffert <ss...@apache.org>
>
> > Regarding the website we have our designer already working on a logo,
> and I
> > suggest we use "mvn site" to automatically generate it, because this will
> > already create a lot of documentation.
> >
>
> So you do not plan to use the Apache CMS [1] for the website? Or do you
> plan to generate things from Maven for the Apache CMS?
>
> It is just a question. I have no experience in generating complete websites
> from Maven or how to combine it with the ASF CMS. Would be nice to see.
>
Many projects already do this. If the Maven "site" reporting is configured
properly in the Maven build file, this can generate very good and extensive
web pages for a project. The Maven site itself is a good example (
http://maven.apache.org/).
The advantage of this approach is that we would not need to maintain
documentation and source code separately, and it is easy to include
automatically generated documentation parts like the Javadoc, REST API,
License Report, or Developer Information in the web page.
So I would try going this approach. :-)
Greetings,
Sebastian
> [1] http://www.apache.org/dev/cms.html
>
> --
> Fabian
> http://twitter.com/fctwitt
>
Re: Apache infrastructure resources
Posted by Fabian Christ <ch...@googlemail.com>.
2012/12/5 Sebastian Schaffert <ss...@apache.org>
> Regarding the website we have our designer already working on a logo, and I
> suggest we use "mvn site" to automatically generate it, because this will
> already create a lot of documentation.
>
So you do not plan to use the Apache CMS [1] for the website? Or do you
plan to generate things from Maven for the Apache CMS?
It is just a question. I have no experience in generating complete websites
from Maven or how to combine it with the ASF CMS. Would be nice to see.
[1] http://www.apache.org/dev/cms.html
--
Fabian
http://twitter.com/fctwitt
Re: Apache infrastructure resources
Posted by Sebastian Schaffert <ss...@apache.org>.
Hi all,
I agree with all of Sergio's points.
MoinMoin is second-best since we cannot have Confluence. :) The current
wiki content is in the Google Code wiki, it should not be too difficult to
migrate it.
Regarding GIT I would even insist a bit, because there are many advantages,
especially the branching and merging functionalities. We are already using
this quite a bit with Mercurial.
Regarding the website we have our designer already working on a logo, and I
suggest we use "mvn site" to automatically generate it, because this will
already create a lot of documentation.
Greetings,
Sebastian
Re: Apache infrastructure resources
Posted by Sergio Fernández <wi...@apache.org>.
Hi,
On 05/12/12 14:54, Andy Seaborne wrote:
> Here is a check list of resources that I assembled from the proposal. If
> it looks OK, I'll start to raise the JIRA and subJIRA for the
> "immediate" items as soon as possible.
>
> == Immediate
>
> 1/ Mailing lists - done.
>
> 2/ JIRA for Marmotta
>
> This will need an named administrator who can set the JIRA area up fr
> the project. A volunteer please?
I can take it (my username there is wikier too).
>
> 3/ GIT
Let see if we can use it ;-)
> 4/ website
>
> It's the link that gets handled out a lot so getting something in place
> is always good even if it is a basic page and "coming soon".
I can prepare something quickly.
As soon as we have Jira, I'll create all tasks related with the public
image of the project.
> svnpubsub is the publishing mechanism used by Apache; it pushes the
> content out from a svn repo the front-facing servers.
>
> How the content gets into the svn repo is the projects responsibility.
> (FYI: Jena uses CMS, other projects use maven site)
Something to discuss. Maven site has the clear benefit of keeping
synchronized the development with the information at the webpage, but on
the other hand this means less flexibility. Personally I don't have a
clear opinion right now.
> NB http://marmotta.incubator.apache.org/ already returns 404
>
> == And then
>
> Then there are: (I'm looking for owners for these)
>
> A/ Wiki for internal documentation purposes
> The project has a choice:
> 1/ MoinMoin
> 2/ cwiki
MoinMoin: +1
> Is a wiki part of your current practice? If so, what about transfer of
> content? If not, do you want to delay getting it while a choice is agreed?
>
> B/ Jenkins, if you want a CI build process
I would say yes.
BTW, email reports to where? By default many projects send to
dev@marmotta, but I'd prefer commits@marmotta for those reports. Same
decision for Jira.
> C/ org.apache.marmotta on Nexus
>
> For snapshot builds and releases.
Perfect.
> D/ Blog to improve the project dissemination
>
> Is there a current one? Or is this an additional nice to have (=> less
> urgent until the project has a picture of how it will get used).
Leave it for second phase, since this is something "nice to have, yes.
Cheers,
--
Sergio Fernández