6:09 a.m.
Hi All,
One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
If we the repos we should adopt of specific convention for the files and the names. i.e.
BUILD.md, and/or DEPENDENCIES.md.
Wdyt?
Thanks,
Jay
6:47 a.m.
I personally don't trust text files that claim to list library
dependencies, as there's always a chance they are out-of-sync with build
scripts. I just go straight to pom.xml or deploy instructions.
just my 2c
- marko
On Mon, Nov 5, 2012 at 1:09 PM, Jay Balunas <jbalunas(a)redhat.com> wrote:
Hi All,
One thing we need to be sure to document is the details of our build
process and dependencies for each of libraries and repos.
The question is whether to centralize these or keep them with each of the
respective repos? Thoughts?
If we the repos we should adopt of specific convention for the files and
the names. i.e. BUILD.md, and/or DEPENDENCIES.md.
Wdyt?
Thanks,
Jay
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
7:33 a.m.
IMO it does not hurt to list dependencies in a README.md file
of course, for java weenies, pom is the source of truth.
JS and iOS are different...
On Monday, November 5, 2012, Marko Strukelj wrote:
I personally don't trust text files that claim to list library
dependencies, as there's always a chance they are out-of-sync with build
scripts. I just go straight to pom.xml or deploy instructions.
just my 2c
- marko
On Mon, Nov 5, 2012 at 1:09 PM, Jay Balunas <jbalunas@redhat.com<javascript:_e({},
'cvml', 'jbalunas(a)redhat.com');>
> wrote:
> Hi All,
>
> One thing we need to be sure to document is the details of our build
> process and dependencies for each of libraries and repos.
>
> The question is whether to centralize these or keep them with each of the
> respective repos? Thoughts?
>
> If we the repos we should adopt of specific convention for the files and
> the names. i.e. BUILD.md, and/or DEPENDENCIES.md.
>
> Wdyt?
>
> Thanks,
> Jay
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev(a)lists.jboss.org <javascript:_e({}, 'cvml',
> 'aerogear-dev(a)lists.jboss.org');>
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
--
Sent from Gmail Mobile
8:32 a.m.
For Android this is kind of a non issue. The dependency tree/list can be generated from
the pom file any time.
----- Original Message -----
From: "Jay Balunas" <jbalunas(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 7:09:13 AM
Subject: [aerogear-dev] Details on the build process and dependencies
Hi All,
One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
If we the repos we should adopt of specific convention for the files and the names. i.e.
BUILD.md, and/or DEPENDENCIES.md.
Wdyt?
Thanks,
Jay
8:35 a.m.
On Nov 5, 2012, at 9:32 AM, Summers Pittman <supittma(a)redhat.com> wrote:
For Android this is kind of a non issue. The dependency tree/list
can be generated from the pom file any time.
Would a new user know how to do that? maybe a guide to show them how
----- Original Message -----
From: "Jay Balunas" <jbalunas(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 7:09:13 AM
Subject: [aerogear-dev] Details on the build process and dependencies
Hi All,
One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
If we the repos we should adopt of specific convention for the files and the names. i.e.
BUILD.md, and/or DEPENDENCIES.md.
Wdyt?
Thanks,
Jay
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
8:41 a.m.
Would a new user know how to do that? maybe a guide to show them how
Dependency management is just something Maven "does". I've written
(and am waiting on the PR to go through) gobs of docs on how to get this set up.
New users won't care what their deps are because Maven will download and build against
what it needs automatically.
----- Original Message -----
From: "Lucas Holmquist" <lholmqui(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 9:35:03 AM
Subject: Re: [aerogear-dev] Details on the build process and dependencies
On Nov 5, 2012, at 9:32 AM, Summers Pittman <supittma(a)redhat.com> wrote:
For Android this is kind of a non issue. The dependency tree/list
can be generated from the pom file any time.
Would a new user know how to do that? maybe a guide to show them how
----- Original Message -----
From: "Jay Balunas" <jbalunas(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 7:09:13 AM
Subject: [aerogear-dev] Details on the build process and dependencies
Hi All,
One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
If we the repos we should adopt of specific convention for the files and the names. i.e.
BUILD.md, and/or DEPENDENCIES.md.
Wdyt?
Thanks,
Jay
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
8:44 a.m.
On Nov 5, 2012, at 9:41 AM, Summers Pittman <supittma(a)redhat.com> wrote:
> Would a new user know how to do that? maybe a guide to show them
how
Dependency management is just something Maven "does". I've written (and am
waiting on the PR to go through) gobs of docs on how to get this set up.
New users won't care what their deps are because Maven will download and build
against what it needs automatically.
right, i was referring to actually generating the dependency tree/list
----- Origina
l Message -----
From: "Lucas Holmquist" <lholmqui(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 9:35:03 AM
Subject: Re: [aerogear-dev] Details on the build process and dependencies
On Nov 5, 2012, at 9:32 AM, Summers Pittman <supittma(a)redhat.com> wrote:
> For Android this is kind of a non issue. The dependency tree/list can be generated
from the pom file any time.
>
> Would a new user know how to do that? maybe a guide to show them how
> ----- Original Message -----
> From: "Jay Balunas" <jbalunas(a)redhat.com>
> To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
> Sent: Monday, November 5, 2012 7:09:13 AM
> Subject: [aerogear-dev] Details on the build process and dependencies
>
> Hi All,
>
> One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
>
> The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
>
> If we the repos we should adopt of specific convention for the files and the names.
i.e. BUILD.md, and/or DEPENDENCIES.md.
>
> Wdyt?
>
> Thanks,
> Jay
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
9:21 a.m.
right, i was referring to actually generating the dependency
tree/list
Oh, I was thinking of at most making it a part of the build (IE
generating a DEPENDENCIES.md doc)
----- Original Message -----
From: "Lucas Holmquist" <lholmqui(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 9:44:18 AM
Subject: Re: [aerogear-dev] Details on the build process and dependencies
On Nov 5, 2012, at 9:41 AM, Summers Pittman <supittma(a)redhat.com> wrote:
> Would a new user know how to do that? maybe a guide to show them
how
Dependency management is just something Maven "does". I've written (and am
waiting on the PR to go through) gobs of docs on how to get this set up.
New users won't care what their deps are because Maven will download and build
against what it needs automatically.
----- Origina
l Message -----
From: "Lucas Holmquist" <lholmqui(a)redhat.com>
To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
Sent: Monday, November 5, 2012 9:35:03 AM
Subject: Re: [aerogear-dev] Details on the build process and dependencies
On Nov 5, 2012, at 9:32 AM, Summers Pittman <supittma(a)redhat.com> wrote:
> For Android this is kind of a non issue. The dependency tree/list can be generated
from the pom file any time.
>
> Would a new user know how to do that? maybe a guide to show them how
> ----- Original Message -----
> From: "Jay Balunas" <jbalunas(a)redhat.com>
> To: "AeroGear Developer Mailing List" <aerogear-dev(a)lists.jboss.org>
> Sent: Monday, November 5, 2012 7:09:13 AM
> Subject: [aerogear-dev] Details on the build process and dependencies
>
> Hi All,
>
> One thing we need to be sure to document is the details of our build process and
dependencies for each of libraries and repos.
>
> The question is whether to centralize these or keep them with each of the respective
repos? Thoughts?
>
> If we the repos we should adopt of specific convention for the files and the names.
i.e. BUILD.md, and/or DEPENDENCIES.md.
>
> Wdyt?
>
> Thanks,
> Jay
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
9:34 a.m.
Hello all,
Just to jump in the discussion
maven dependency:tree
is well-known I think but just add it to the technical doc of the project.
On a more general topic on documentation, I think it will be good to use
gh-pages.
You could have a general page for AeroGear which list all project and then
have gh-pages documentation per project. This is how I presented it :
http://3musket33rs.github.com/
and for one project
http://3musket33rs.github.com/html5-mobile-scaffolding/
Besides with gh-pages you can have templates or you could use miven site
report. In my sample I used Grails doc report.
Just to share with you my views...
Cheers,
Corinne.
On 5 November 2012 15:44, Lucas Holmquist <lholmqui(a)redhat.com> wrote:
On Nov 5, 2012, at 9:41 AM, Summers Pittman <supittma(a)redhat.com> wrote:
>> Would a new user know how to do that? maybe a guide to show them how
> Dependency management is just something Maven "does". I've written
(and
am waiting on the PR to go through) gobs of docs on how to get this set up.
> New users won't care what their deps are because Maven will download and
build against what it needs automatically.
>
right, i was referring to actually generating the dependency tree/list
> ----- Origina
> l Message -----
> From: "Lucas Holmquist" <lholmqui(a)redhat.com>
> To: "AeroGear Developer Mailing List"
<aerogear-dev(a)lists.jboss.org>
> Sent: Monday, November 5, 2012 9:35:03 AM
> Subject: Re: [aerogear-dev] Details on the build process and dependencies
>
>
> On Nov 5, 2012, at 9:32 AM, Summers Pittman <supittma(a)redhat.com> wrote:
>
>> For Android this is kind of a non issue. The dependency tree/list can
be generated from the pom file any time.
>>
>
>> Would a new user know how to do that? maybe a guide to show them how
>
>
>> ----- Original Message -----
>> From: "Jay Balunas" <jbalunas(a)redhat.com>
>> To: "AeroGear Developer Mailing List"
<aerogear-dev(a)lists.jboss.org>
>> Sent: Monday, November 5, 2012 7:09:13 AM
>> Subject: [aerogear-dev] Details on the build process and dependencies
>>
>> Hi All,
>>
>> One thing we need to be sure to document is the details of our build
process and dependencies for each of libraries and repos.
>>
>> The question is whether to centralize these or keep them with each of
the respective repos? Thoughts?
>>
>> If we the repos we should adopt of specific convention for the files
and the names. i.e. BUILD.md, and/or DEPENDENCIES.md.
>>
>> Wdyt?
>>
>> Thanks,
>> Jay
>> _______________________________________________
>> aerogear-dev mailing list
>> aerogear-dev(a)lists.jboss.org
>> https://lists.jboss.org/mailman/listinfo/aerogear-dev
>
>
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
> _______________________________________________
> aerogear-dev mailing list
> aerogear-dev(a)lists.jboss.org
> https://lists.jboss.org/mailman/listinfo/aerogear-dev
_______________________________________________
aerogear-dev mailing list
aerogear-dev(a)lists.jboss.org
https://lists.jboss.org/mailman/listinfo/aerogear-dev
11:35 a.m.
On Nov 5, 2012, at 1:34 PM, Corinne Krych wrote:
Hello all,
Just to jump in the discussion
maven dependency:tree
is well-known I think but just add it to the technical doc of the project.
On a more general topic on documentation, I think it will be good to use gh-pages.
You could have a general page for AeroGear which list all project and then have gh-pages
documentation per project. This is how I presented it :
http://3musket33rs.github.com/
and for one project
http://3musket33rs.github.com/html5-mobile-scaffolding/
Besides with gh-pages you can have templates or you could use miven site report. In my
sample I used Grails doc report.
We thought on that before but it's a pain when
you have to consolidate stuff and keep several versions in parallel, so basically we use
the same tool (jekyll) but host at our own servers.
-- qmx
4607
days inactive
4607
days old
9 comments
7 participants
participants (7)
-
Corinne Krych -
Douglas Campos -
Jay Balunas -
Lucas Holmquist -
Marko Strukelj -
Matthias Wessendorf -
Summers Pittman