David, looks a great proposal, this will ease the dev & doc synchronization a lot.
Cheers Lei On Fri, May 26, 2017 at 6:25 AM, David Yozie <[email protected]> wrote: > Great - my proposal then is to merge the full contents of the > incubator-hawq-docs master branch into a new "hawq-docs" subdirectory of > the incubator-hawq source repo. This is to avoid any conflicts with the > existing "docs" directory, which contains SGML files used for command-line > tool help. > > After that, I can modify the README in incubator-hawq-docs to point to the > correct location and/or make it a read-only repo. > > Let me know if there are any concerns about the above, or other suggestions > for managing the docs source alongside the code. > > Thanks, > > -David > > On Thu, May 25, 2017 at 11:28 AM, Shivram Mani <[email protected]> > wrote: > > > David, that would be great ! > > We could address incubator-hawq-site docs later given the nature of its > > document source. > > > > On Wed, May 24, 2017 at 2:43 PM, David Yozie <[email protected]> wrote: > > > >> Shivram: I was just about to propose moving the incubator-hawq-docs > >> source into a subdirectory of incubator-hawq. That organization seems > to > >> be more common with Apache projects and I'm hopeful that having docs > source > >> alongside the code will encourage more doc contributions (ie. PRs with > both > >> the code changes and doc changes). > >> > >> Most of the docs on incubator-hawq-site are just HTML files generated > >> from the source. I don't think we'd necessarily want to combine that > >> compiled output alongside source. > >> > >> -David > >> > >> On Wed, May 24, 2017 at 2:07 PM, Shivram Mani <[email protected]> > >> wrote: > >> > >>> Why can't we integrate the hawq docs > >>> <https://github.com/apache/incubator-hawq-docs> and the hawq incubator > >>> site > >>> docs <https://github.com/apache/incubator-hawq-site/> repositories as > >>> part > >>> of the incubator hawq repository <https://github.com/apache/inc > >>> ubator-hawq> > >>> ? Its a bit cumbersome for new committers who intend to contribute to > >>> docs > >>> to keep track of three different repositories and also request for > >>> permission on each of them. > >>> > >>> -- > >>> shivram mani > >>> > >> > >> > > > > > > -- > > shivram mani > > >
