Interesting.
When we distribute our release artifact, the release notes contain the
spec, which references the api docs contained in the release artifact.
I spent quite a bit of time tidying up last release. I know your doing
this for the website, so it's a different concern. But I wonder if we
can have relative links, or something, so we don't end up diverging the
website spec docs from those we distribute with the release? Perhaps we
can populate the website with the last release API for the spec to
reference, rather than linking to the latest hudson build?
Don't know really, just thinking aloud.
Keep up the good work.
Cheers,
Peter.
Tom Hobbs wrote:
Hi Wade,
Thanks for the suggestion. I've just recently uploaded all of the
original Jini Specs and other documentation into our new CMS. It's
still in the staging environment at the moment because I still haven't
converted it all to our CMS markup from it's original HTML.
You're absolutely right, a link to the specs straight from the home
page is a good thing to have. Currently I'm removing all the links to
the API docs from the specs, mostly because I know that they'll all be
broken. I have a cunning plan to add links from every class mentioned
in the specs to the latest API docs using sed and grep - and probably
awk as well.
A link straight to the API docs from the home page would also be good.
Cheers,
Tom
On Thu, Dec 9, 2010 at 3:05 PM, Wade Chandler
<[email protected]> wrote:
All,
I believe it would be good to some how work in a link to the latest builds
river/src-doc/static/index.html on the web site under the documentation links.
This could possibly be per a link "Development Release Documentation" or
"Release Documentation" or maybe "Documentation and Specifications"; perhaps
better and more simply "River Documentation". It may not be formatted as the
rest of the site yet, but it still gets that valuable information out there for
anyone just now looking at River with a couple clicks on the web site. The
specifications really get to the heart of what it is and tries to accomplish in
my opinion. Too there are the manual pages plus the getting started page though
some of the lower links don't work (manual pages being some), and I assume this
is due to part of the build not copying things around and generating all the
JavaDocs. I haven't had time to look at the build to see if there is a target
which will copy those docs around an fix those issues or not. Regardless, I
think those things would be good to have visible directly from the web site
without one having to download anything first.
Thoughts?
Thanks,
Wade
==================
Wade Chandler
Software Engineer and Developer
NetBeans Dream Team Member and Contributor
http://wiki.netbeans.org/wiki/view/NetBeansDreamTeam
http://www.netbeans.org
