hawq-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Shivram Mani <shivram.m...@gmail.com>
Subject Re: HAWQ Documentation Source
Date Fri, 29 Jul 2016 18:08:02 GMT
+1 on markdown and release specific doc site.

On Wed, Jul 20, 2016 at 8:37 AM, David Yozie <dyozie@pivotal.io> wrote:

> We're starting an effort to open source the Apache HAWQ end-user
> documentation. Because it's still early in the process, it would be great
> to get feedback as to how to make the documentation easy to work with, and
> easy to contribute to.  Here's the basic proposal so far:
>
>    - All Apache HAWQ documentation source will be made available in
>    MarkDown format, for ease-of-use in making doc contributions.
>    - We'd like to make the docs available in a new git repo, such as git://
>    git.apache.org/incubator-hawq-docs.git
>    <http://git.apache.org/incubator-hawq-docs.git>
>    - With each new Apache HAWQ software release, a new HTML site will be
>    generated and hosted on the main project site. For example:
>    http://hawq.incubator.apache.org/docs/
>    <http://hawq.incubator.apache.org/docs/><release-version>/
>    - Instructions and supporting files will be made available so that
>    anyone can build HTML from the MD source using the open source
> bookbinder
>    <https://github.com/pivotal-cf/bookbinder> project.
>    - Content-wise, the open source docs will be very similar to the current
>    Pivotal HDB docs. Pivotal will continue to single source the open Apache
>    HAWQ docs in order to create the HDB docs site.
>
> Let me know if you have any suggestions or concerns regarding the above.
>
> Thanks!
>
> -David
>



-- 
shivram mani

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