You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jetspeed-dev@portals.apache.org by David Le Strat <dl...@yahoo.com> on 2005/11/21 00:33:15 UTC
[j2] Site Documentation Changes
All,
I made some changes to the Jetspeed site that I would
like to review with you all before committing.
I published the site at:
http://people.apache.org/~dlestrat/j2-final/index.html
Please provide your feedback. As documented in
http://issues.apache.org/jira/browse/JS2-83
I restructured the navigation and centralized the
generic documentation into guides that reference when
appropriate the components documentation located in
/component/xxx/xdocs.
If we agree on the format, I will start creating
subtasks in
http://issues.apache.org/jira/browse/JS2-389 for
people to sign up. We have quite a bit of work to do
for the documentation content. There is some good
content in the WIKI that we will need to incorporate
in the formal documentation as well.
I look forward to your feedback.
Regards,
David Le Strat
________________________
David Le Strat
Blogging @ http://dlsthoughts.blogspot.com
__________________________________
Yahoo! Mail - PC Magazine Editors' Choice 2005
http://mail.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
Re: [j2] Site Documentation Changes
Posted by Philip Mark Donaghy <ph...@gmail.com>.
Testing known and unkown configurations is also a helpful topic that can be
developed on a wiki. The wiki is the ideal place for user and developer
contributions. Sorry this is getting off topic. But a document on know
configurations can be included in the site doc.
Philip
On 11/21/05, Philip Mark Donaghy <ph...@gmail.com> wrote:
>
> I have been working on documentation as well. I use the wiki as a
> whiteboard and then I write xdocs from it (manually unfortunately). I think
> the new format is nice. I would expect to see the current page highlighted
> in the menu. Maven.apache.org <http://Maven.apache.org> does this.
>
> I have some images that I captured that would be helpful in the
> guide-decorators.html document.
> http://issues.apache.org/jira/browse/JS2-409
>
> There is a guide to decorators that I wrote here,
> http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient/CustomizeThePortletDecorator
>
> And the documentation definitely needs a quick guide for developers that
> are impatient and want to build and run fast. This is source oriented.
> http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient
>
> I don't think that the binary quick guide needs references to subversion.
> Hopefully it can be simplified.
>
> FAQ documentation should be compiled directly from the user mailing list.
>
> A good guide to contributions help orient people that are interested in
> developing modules, documentation, etc. This usually is in the following
> order. Help users on the mailing list, submit bugs and patches, write
> documentation, build often from scratch.
>
> Let me know how I can help. Raphael and Santiago can give comment on how
> many beers I can drink without falling over. I will also be in San Diego.
> Looking forward to meeting you all.
>
> Philip
>
> On 11/20/05, David Le Strat <dl...@yahoo.com> wrote:
> >
> > All,
> >
> > I made some changes to the Jetspeed site that I would
> > like to review with you all before committing.
> >
> > I published the site at:
> >
> > http://people.apache.org/~dlestrat/j2-final/index.html
> > <http://people.apache.org/%7Edlestrat/j2-final/index.html>
> >
> > Please provide your feedback. As documented in
> > http://issues.apache.org/jira/browse/JS2-83
> >
> > I restructured the navigation and centralized the
> > generic documentation into guides that reference when
> > appropriate the components documentation located in
> > /component/xxx/xdocs.
> >
> > If we agree on the format, I will start creating
> > subtasks in
> > http://issues.apache.org/jira/browse/JS2-389 for
> > people to sign up. We have quite a bit of work to do
> > for the documentation content. There is some good
> > content in the WIKI that we will need to incorporate
> > in the formal documentation as well.
> >
> > I look forward to your feedback.
> >
> > Regards,
> >
> > David Le Strat
> >
> > ________________________
> > David Le Strat
> > Blogging @ http://dlsthoughts.blogspot.com
> >
> >
> >
> >
> > __________________________________
> > Yahoo! Mail - PC Magazine Editors' Choice 2005
> > http://mail.yahoo.com
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
> > For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
> >
> >
>
>
> --
> Philip Donaghy
> donaghy.blogspot.com <http://donaghy.blogspot.com> del.icio.us/donaghy<http://del.icio.us/donaghy>
> connection.oreilly.com/users/profile.public.php?user_id=4371<http://connection.oreilly.com/users/profile.public.php?user_id=4371>
> www.linkedin.com/profile?viewProfile=&key=1811119<http://www.linkedin.com/profile?viewProfile=&key=1811119>
> www.capferret.org <http://www.capferret.org>
> Skype: philipmarkdonaghy
> Office: +33 5 56 60 88 02
> Mobile: +33 6 20 83 22 62
--
Philip Donaghy
donaghy.blogspot.com <http://donaghy.blogspot.com>
del.icio.us/donaghy<http://del.icio.us/donaghy>
connection.oreilly.com/users/profile.public.php?user_id=4371<http://connection.oreilly.com/users/profile.public.php?user_id=4371>
www.linkedin.com/profile?viewProfile=&key=1811119<http://www.linkedin.com/profile?viewProfile=&key=1811119>
www.capferret.org <http://www.capferret.org>
Skype: philipmarkdonaghy
Office: +33 5 56 60 88 02
Mobile: +33 6 20 83 22 62
Re: [j2] Site Documentation Changes
Posted by David Le Strat <dl...@yahoo.com>.
Philip,
Thanks for the feedback, we will definitely need to
incorporate the changes you suggest. What I would
like to do next, after we get some more feedback is
to:
1. Commit the changes I made to CVS.
2. Incorporate the work that was done on the WIKI.
3. Set up detailed subtasks of pages for people to
sign up and contribute documentation. And provide
patches for specific pages.
Hope this makes sense.
Regards,
David Le Strat
--- Philip Mark Donaghy <ph...@gmail.com>
wrote:
> I have been working on documentation as well. I use
> the wiki as a whiteboard
> and then I write xdocs from it (manually
> unfortunately). I think the new
> format is nice. I would expect to see the current
> page highlighted in the
> menu. Maven.apache.org <http://Maven.apache.org>
> does this.
>
> I have some images that I captured that would be
> helpful in the
> guide-decorators.html document.
> http://issues.apache.org/jira/browse/JS2-409
>
> There is a guide to decorators that I wrote here,
>
http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient/CustomizeThePortletDecorator
>
> And the documentation definitely needs a quick guide
> for developers that are
> impatient and want to build and run fast. This is
> source oriented.
>
http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient
>
> I don't think that the binary quick guide needs
> references to subversion.
> Hopefully it can be simplified.
>
> FAQ documentation should be compiled directly from
> the user mailing list.
>
> A good guide to contributions help orient people
> that are interested in
> developing modules, documentation, etc. This usually
> is in the following
> order. Help users on the mailing list, submit bugs
> and patches, write
> documentation, build often from scratch.
>
> Let me know how I can help. Raphael and Santiago can
> give comment on how
> many beers I can drink without falling over. I will
> also be in San Diego.
> Looking forward to meeting you all.
>
> Philip
>
> On 11/20/05, David Le Strat <dl...@yahoo.com>
> wrote:
> >
> > All,
> >
> > I made some changes to the Jetspeed site that I
> would
> > like to review with you all before committing.
> >
> > I published the site at:
> >
> >
>
http://people.apache.org/~dlestrat/j2-final/index.html
> >
> > Please provide your feedback. As documented in
> > http://issues.apache.org/jira/browse/JS2-83
> >
> > I restructured the navigation and centralized the
> > generic documentation into guides that reference
> when
> > appropriate the components documentation located
> in
> > /component/xxx/xdocs.
> >
> > If we agree on the format, I will start creating
> > subtasks in
> > http://issues.apache.org/jira/browse/JS2-389 for
> > people to sign up. We have quite a bit of work to
> do
> > for the documentation content. There is some good
> > content in the WIKI that we will need to
> incorporate
> > in the formal documentation as well.
> >
> > I look forward to your feedback.
> >
> > Regards,
> >
> > David Le Strat
> >
> > ________________________
> > David Le Strat
> > Blogging @ http://dlsthoughts.blogspot.com
> >
> >
> >
> >
> > __________________________________
> > Yahoo! Mail - PC Magazine Editors' Choice 2005
> > http://mail.yahoo.com
> >
> >
>
---------------------------------------------------------------------
> > To unsubscribe, e-mail:
> jetspeed-dev-unsubscribe@portals.apache.org
> > For additional commands, e-mail:
> jetspeed-dev-help@portals.apache.org
> >
> >
>
>
> --
> Philip Donaghy
> donaghy.blogspot.com <http://donaghy.blogspot.com>
> del.icio.us/donaghy<http://del.icio.us/donaghy>
>
connection.oreilly.com/users/profile.public.php?user_id=4371<http://connection.oreilly.com/users/profile.public.php?user_id=4371>
>
www.linkedin.com/profile?viewProfile=&key=1811119<http://www.linkedin.com/profile?viewProfile=&key=1811119>
> www.capferret.org <http://www.capferret.org>
> Skype: philipmarkdonaghy
> Office: +33 5 56 60 88 02
> Mobile: +33 6 20 83 22 62
>
________________________
David Le Strat
Blogging @ http://dlsthoughts.blogspot.com
__________________________________________________
Do You Yahoo!?
Tired of spam? Yahoo! Mail has the best spam protection around
http://mail.yahoo.com
---------------------------------------------------------------------
To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
Re: [j2] Site Documentation Changes
Posted by Philip Mark Donaghy <ph...@gmail.com>.
I have been working on documentation as well. I use the wiki as a whiteboard
and then I write xdocs from it (manually unfortunately). I think the new
format is nice. I would expect to see the current page highlighted in the
menu. Maven.apache.org <http://Maven.apache.org> does this.
I have some images that I captured that would be helpful in the
guide-decorators.html document. http://issues.apache.org/jira/browse/JS2-409
There is a guide to decorators that I wrote here,
http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient/CustomizeThePortletDecorator
And the documentation definitely needs a quick guide for developers that are
impatient and want to build and run fast. This is source oriented.
http://wiki.apache.org/portals/Jetspeed2/QuickstartForTheImpatient
I don't think that the binary quick guide needs references to subversion.
Hopefully it can be simplified.
FAQ documentation should be compiled directly from the user mailing list.
A good guide to contributions help orient people that are interested in
developing modules, documentation, etc. This usually is in the following
order. Help users on the mailing list, submit bugs and patches, write
documentation, build often from scratch.
Let me know how I can help. Raphael and Santiago can give comment on how
many beers I can drink without falling over. I will also be in San Diego.
Looking forward to meeting you all.
Philip
On 11/20/05, David Le Strat <dl...@yahoo.com> wrote:
>
> All,
>
> I made some changes to the Jetspeed site that I would
> like to review with you all before committing.
>
> I published the site at:
>
> http://people.apache.org/~dlestrat/j2-final/index.html
>
> Please provide your feedback. As documented in
> http://issues.apache.org/jira/browse/JS2-83
>
> I restructured the navigation and centralized the
> generic documentation into guides that reference when
> appropriate the components documentation located in
> /component/xxx/xdocs.
>
> If we agree on the format, I will start creating
> subtasks in
> http://issues.apache.org/jira/browse/JS2-389 for
> people to sign up. We have quite a bit of work to do
> for the documentation content. There is some good
> content in the WIKI that we will need to incorporate
> in the formal documentation as well.
>
> I look forward to your feedback.
>
> Regards,
>
> David Le Strat
>
> ________________________
> David Le Strat
> Blogging @ http://dlsthoughts.blogspot.com
>
>
>
>
> __________________________________
> Yahoo! Mail - PC Magazine Editors' Choice 2005
> http://mail.yahoo.com
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: jetspeed-dev-unsubscribe@portals.apache.org
> For additional commands, e-mail: jetspeed-dev-help@portals.apache.org
>
>
--
Philip Donaghy
donaghy.blogspot.com <http://donaghy.blogspot.com>
del.icio.us/donaghy<http://del.icio.us/donaghy>
connection.oreilly.com/users/profile.public.php?user_id=4371<http://connection.oreilly.com/users/profile.public.php?user_id=4371>
www.linkedin.com/profile?viewProfile=&key=1811119<http://www.linkedin.com/profile?viewProfile=&key=1811119>
www.capferret.org <http://www.capferret.org>
Skype: philipmarkdonaghy
Office: +33 5 56 60 88 02
Mobile: +33 6 20 83 22 62