You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tomee.apache.org by David Blevins <da...@visi.com> on 2007/08/17 00:34:39 UTC
Documentation and wiki area
I'm going through our docs and making a jira for each of them.
Hoping we can at track what things need to be updated and how and
maybe get some volunteers to execute on that. At the very least
it'll ensure that we have reviewed the entire site and know what is
out of date and needs to be updated.
A second thing is it seems we might finally want a second wiki space
for things that really don't need to be on the website. Thinking of
a few of the "whiteboard" pages we have, the "hungry exception" page,
our board reports and things of that nature. It isn't so bad to have
them in the main wiki, but it is slightly annoying to have to
mentally "ignore" them when doing big organization tasks like this.
Also, I didn't even realize but the autoexport plugin creates a space-
index.html page with every single wiki page on it and these pages
show up there too -- it'd be nice if they didn't clutter the index.
http://openejb.apache.org/space-index.html
Going to try and clean things up without over doing it -- over
organizing is just as terrible.
-David
Re: Documentation and wiki area
Posted by Manu George <ma...@gmail.com>.
Hey I am the first to reply. Let me grab the first three. I am
assigning them to myself. If someone else wants them let me know and i
will re-assign :)
On 8/18/07, David Blevins <da...@visi.com> wrote:
>
> On Aug 17, 2007, at 8:00 PM, David Blevins wrote:
>
> > I'm most the way through the site and hope to get the rest of the
> > way and post my "editorial" comments in one jira per page. Going
> > to be like 80 of them. I hope to prioritize them too.
> >
>
> Ok. Here it is. More comments welcome -- throw 'em on the issue or
> on the list. Feel free to ask for more details on the list, good
> place for learning.
>
> All hands on deck! :) If you have time to take one of these and fix
> it up, even a little bit, great!!
>
> [OPENEJB-629] Documentation Review and Cleanup
> Blocker [OPENEJB-636] doc: deploy-tool.html
> http://issues.apache.org/jira/browse/OPENEJB-636
>
> Blocker [OPENEJB-658] doc: quickstart.html
> http://issues.apache.org/jira/browse/OPENEJB-658
>
> Blocker [OPENEJB-660] doc: startup.html
> http://issues.apache.org/jira/browse/OPENEJB-660
>
> Critical [OPENEJB-634] doc: configuration.html
> http://issues.apache.org/jira/browse/OPENEJB-634
>
> Critical [OPENEJB-637] doc: deployment-id.html
> http://issues.apache.org/jira/browse/OPENEJB-637
>
> Critical [OPENEJB-655] doc: new-instructions.html
> http://issues.apache.org/jira/browse/OPENEJB-655
>
> Critical [OPENEJB-659] doc: remote-server.html
> http://issues.apache.org/jira/browse/OPENEJB-659
>
> Critical [OPENEJB-664] doc: validation-tool.html
> http://issues.apache.org/jira/browse/OPENEJB-664
>
> Major [OPENEJB-631] doc: collapsed-ear-on-linux.html
> http://issues.apache.org/jira/browse/OPENEJB-631
>
> Major [OPENEJB-632] doc: collapsed-ear.html
> http://issues.apache.org/jira/browse/OPENEJB-632
>
> Major [OPENEJB-633] doc: common-errors.html
> http://issues.apache.org/jira/browse/OPENEJB-633
>
> Major [OPENEJB-635] doc: containers.html
> http://issues.apache.org/jira/browse/OPENEJB-635
>
> Major [OPENEJB-638] doc: deployments.html
> http://issues.apache.org/jira/browse/OPENEJB-638
>
> Major [OPENEJB-639] doc: details-on-openejb-jar.html
> http://issues.apache.org/jira/browse/OPENEJB-639
>
> Major [OPENEJB-641] doc: embedding-openejb.html
> http://issues.apache.org/jira/browse/OPENEJB-641
>
> Major [OPENEJB-642] doc: embedding.html
> http://issues.apache.org/jira/browse/OPENEJB-642
>
> Major [OPENEJB-645] doc: faq.html
> http://issues.apache.org/jira/browse/OPENEJB-645
>
> Major [OPENEJB-646] doc: hello-world.html
> http://issues.apache.org/jira/browse/OPENEJB-646
>
> Major [OPENEJB-647] doc: homebasediscussion.html
> http://issues.apache.org/jira/browse/OPENEJB-647
>
> Major [OPENEJB-648] doc: index.html
> http://issues.apache.org/jira/browse/OPENEJB-648
>
> Major [OPENEJB-651] doc: jndi-names.html
> http://issues.apache.org/jira/browse/OPENEJB-651
>
> Major [OPENEJB-652] doc: local-server.html
> http://issues.apache.org/jira/browse/OPENEJB-652
>
> Major [OPENEJB-653] doc: logging.html
> http://issues.apache.org/jira/browse/OPENEJB-653
>
> Major [OPENEJB-657] doc: openejb-per-tomcat-installation.html
> http://issues.apache.org/jira/browse/OPENEJB-657
>
> Major [OPENEJB-661] doc: tomcat-ejb-refs.html
> http://issues.apache.org/jira/browse/OPENEJB-661
>
> Major [OPENEJB-662] doc: tomcat-objectfactory.html
> http://issues.apache.org/jira/browse/OPENEJB-662
>
> Major [OPENEJB-663] doc: tomcat.html
> http://issues.apache.org/jira/browse/OPENEJB-663
>
> Major [OPENEJB-665] doc: webapp-based-ejbs.html
> http://issues.apache.org/jira/browse/OPENEJB-665
>
> Minor [OPENEJB-643] doc: examples.html
> http://issues.apache.org/jira/browse/OPENEJB-643
>
> Minor [OPENEJB-654] doc: mailing-lists.html
> http://issues.apache.org/jira/browse/OPENEJB-654
>
> Trivial [OPENEJB-640] doc: ejbcontext-whiteboard.html
> http://issues.apache.org/jira/browse/OPENEJB-640
>
> Trivial [OPENEJB-644] doc: executables.html
> http://issues.apache.org/jira/browse/OPENEJB-644
>
> Trivial [OPENEJB-649] doc: jaxb2-java-inheritance.html
> http://issues.apache.org/jira/browse/OPENEJB-649
>
> Trivial [OPENEJB-650] doc: jndi-name-config.html
> http://issues.apache.org/jira/browse/OPENEJB-650
>
> Trivial [OPENEJB-656] doc: openejb-3.html
> http://issues.apache.org/jira/browse/OPENEJB-656
>
>
> -David
>
>
Re: Documentation and wiki area
Posted by David Blevins <da...@visi.com>.
On Aug 17, 2007, at 8:00 PM, David Blevins wrote:
> I'm most the way through the site and hope to get the rest of the
> way and post my "editorial" comments in one jira per page. Going
> to be like 80 of them. I hope to prioritize them too.
>
Ok. Here it is. More comments welcome -- throw 'em on the issue or
on the list. Feel free to ask for more details on the list, good
place for learning.
All hands on deck! :) If you have time to take one of these and fix
it up, even a little bit, great!!
[OPENEJB-629] Documentation Review and Cleanup
Blocker [OPENEJB-636] doc: deploy-tool.html
http://issues.apache.org/jira/browse/OPENEJB-636
Blocker [OPENEJB-658] doc: quickstart.html
http://issues.apache.org/jira/browse/OPENEJB-658
Blocker [OPENEJB-660] doc: startup.html
http://issues.apache.org/jira/browse/OPENEJB-660
Critical [OPENEJB-634] doc: configuration.html
http://issues.apache.org/jira/browse/OPENEJB-634
Critical [OPENEJB-637] doc: deployment-id.html
http://issues.apache.org/jira/browse/OPENEJB-637
Critical [OPENEJB-655] doc: new-instructions.html
http://issues.apache.org/jira/browse/OPENEJB-655
Critical [OPENEJB-659] doc: remote-server.html
http://issues.apache.org/jira/browse/OPENEJB-659
Critical [OPENEJB-664] doc: validation-tool.html
http://issues.apache.org/jira/browse/OPENEJB-664
Major [OPENEJB-631] doc: collapsed-ear-on-linux.html
http://issues.apache.org/jira/browse/OPENEJB-631
Major [OPENEJB-632] doc: collapsed-ear.html
http://issues.apache.org/jira/browse/OPENEJB-632
Major [OPENEJB-633] doc: common-errors.html
http://issues.apache.org/jira/browse/OPENEJB-633
Major [OPENEJB-635] doc: containers.html
http://issues.apache.org/jira/browse/OPENEJB-635
Major [OPENEJB-638] doc: deployments.html
http://issues.apache.org/jira/browse/OPENEJB-638
Major [OPENEJB-639] doc: details-on-openejb-jar.html
http://issues.apache.org/jira/browse/OPENEJB-639
Major [OPENEJB-641] doc: embedding-openejb.html
http://issues.apache.org/jira/browse/OPENEJB-641
Major [OPENEJB-642] doc: embedding.html
http://issues.apache.org/jira/browse/OPENEJB-642
Major [OPENEJB-645] doc: faq.html
http://issues.apache.org/jira/browse/OPENEJB-645
Major [OPENEJB-646] doc: hello-world.html
http://issues.apache.org/jira/browse/OPENEJB-646
Major [OPENEJB-647] doc: homebasediscussion.html
http://issues.apache.org/jira/browse/OPENEJB-647
Major [OPENEJB-648] doc: index.html
http://issues.apache.org/jira/browse/OPENEJB-648
Major [OPENEJB-651] doc: jndi-names.html
http://issues.apache.org/jira/browse/OPENEJB-651
Major [OPENEJB-652] doc: local-server.html
http://issues.apache.org/jira/browse/OPENEJB-652
Major [OPENEJB-653] doc: logging.html
http://issues.apache.org/jira/browse/OPENEJB-653
Major [OPENEJB-657] doc: openejb-per-tomcat-installation.html
http://issues.apache.org/jira/browse/OPENEJB-657
Major [OPENEJB-661] doc: tomcat-ejb-refs.html
http://issues.apache.org/jira/browse/OPENEJB-661
Major [OPENEJB-662] doc: tomcat-objectfactory.html
http://issues.apache.org/jira/browse/OPENEJB-662
Major [OPENEJB-663] doc: tomcat.html
http://issues.apache.org/jira/browse/OPENEJB-663
Major [OPENEJB-665] doc: webapp-based-ejbs.html
http://issues.apache.org/jira/browse/OPENEJB-665
Minor [OPENEJB-643] doc: examples.html
http://issues.apache.org/jira/browse/OPENEJB-643
Minor [OPENEJB-654] doc: mailing-lists.html
http://issues.apache.org/jira/browse/OPENEJB-654
Trivial [OPENEJB-640] doc: ejbcontext-whiteboard.html
http://issues.apache.org/jira/browse/OPENEJB-640
Trivial [OPENEJB-644] doc: executables.html
http://issues.apache.org/jira/browse/OPENEJB-644
Trivial [OPENEJB-649] doc: jaxb2-java-inheritance.html
http://issues.apache.org/jira/browse/OPENEJB-649
Trivial [OPENEJB-650] doc: jndi-name-config.html
http://issues.apache.org/jira/browse/OPENEJB-650
Trivial [OPENEJB-656] doc: openejb-3.html
http://issues.apache.org/jira/browse/OPENEJB-656
-David
Re: Documentation and wiki area
Posted by David Blevins <da...@visi.com>.
On Aug 17, 2007, at 10:11 AM, Karan Malhi wrote:
>> A second thing is it seems we might finally want a second wiki space
>> for things that really don't need to be on the website.
> I think it is a good idea. Wiki needs to be monitored closely because
> somebody can easily come up and add something to the site which may
> belong to the "second wiki".
>
> FYI, I will start working on the docs starting this weekend (and a few
> hours everyday next week). So if you have something in mind for rapid
> cleanup , please share it so that I hit the right areas of the wiki. I
> am thinking of working on the users guide to start with. Will be
> putting stuff under the NEW_DOCUMENTATION, unless you suggest
> otherwise.
I'm most the way through the site and hope to get the rest of the way
and post my "editorial" comments in one jira per page. Going to be
like 80 of them. I hope to prioritize them too.
-David
Re: Documentation and wiki area
Posted by Karan Malhi <ka...@gmail.com>.
> A second thing is it seems we might finally want a second wiki space
> for things that really don't need to be on the website.
I think it is a good idea. Wiki needs to be monitored closely because
somebody can easily come up and add something to the site which may
belong to the "second wiki".
FYI, I will start working on the docs starting this weekend (and a few
hours everyday next week). So if you have something in mind for rapid
cleanup , please share it so that I hit the right areas of the wiki. I
am thinking of working on the users guide to start with. Will be
putting stuff under the NEW_DOCUMENTATION, unless you suggest
otherwise.
--
Karan Singh Malhi