community-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Niclas Hedhman <nic...@hedhman.org>
Subject Re: Hosting Searchable Release Specific Documentation
Date Wed, 01 Jul 2015 15:43:08 GMT
Well, in Apache Zest, we generate versioned documentation with the normal
build process, and that is then committed into the SVN site/content in its
own version-named directory. Documentation that is somewhat independent of
a release, such a "community stuff", are outside this.

Neo4j (not Apache) used a similar process and even generated the docs into
Maven artifacts, along with testsuite results.

Cheers
Niclas

On Tue, Jun 30, 2015 at 8:10 PM, Suresh Marru <smarru@apache.org> wrote:

> Hi All,
>
> Can I get some advice on how projects deal with hosting release specific
> documentation? In addition to the CMS and Wiki, I am exploring alternatives
> which have a good search built-in. I preciously came across ASF projects
> hosting documentation on read the docs [1] and floss manuals [2] (sorry I
> could not trace all the links of projects using them, but [3] and [4] are
> examples). I read the thread on github pages [5], but it did not have a
> conclusive end.
>
> I am looking for something immediate, any suggestions please? It will be
> great if there is a precedence so we could just refer or even better
> plagiarize the scripts or approaches.
>
> Thanks,
> Suresh
>
> [1] - https://readthedocs.org/ <https://readthedocs.org/>
> [2] - http://en.flossmanuals.net/ <http://en.flossmanuals.net/>
> [3] - https://readthedocs.org/projects/cloudstack-administration/ <
> https://readthedocs.org/projects/cloudstack-administration/>
> [4] - https://readthedocs.org/projects/trafficserver/ <
> https://readthedocs.org/projects/trafficserver/>
> [5] - http://markmail.org/thread/bmbi65q7zdiej6dj <
> http://markmail.org/thread/bmbi65q7zdiej6dj>
>
>


-- 
Niclas Hedhman, Software Developer
http://zest.apache.org - New Energy for Java

Mime
  • Unnamed multipart/alternative (inline, None, 0 bytes)
View raw message