Awesome :) On Wed, Jan 21, 2015 at 11:08 AM, Veena Basavaraj <[email protected]> wrote:
> very cool Gwen, we should give this a try if it is easier to update it.! > > > > > Best, > *./Vee* > > On Wed, Jan 21, 2015 at 9:51 AM, Gwen Shapira <[email protected]> > wrote: > > > I took the liberty of testing the idea out. > > > > Here's our docs as built from the most recent commits in Sqoop2 branch: > > http://sqoop2.readthedocs.org/en/latest/ > > > > Including, for example, instructions on how to load external connectors. > > > > Now if we'll iterate on making the docs look better, it will actually > > be visible :) > > > > Gwen > > > > On Tue, Jan 20, 2015 at 10:44 PM, Abraham Elmahrek <[email protected]> > > wrote: > > > Gwen, > > > > > > This seems like a cool idea. We can also make the docs look much > cleaner > > > for this as well. > > > > > > -Abe > > > > > > On Tue, Jan 20, 2015 at 7:08 PM, Gwen Shapira <[email protected]> > > wrote: > > > > > >> Hi Sqoopers, > > >> > > >> I think we all agree that while our docs are useful, they can use some > > >> improvement - not just in terms of content, but also in terms of > > >> style, usefulness and the process around updating them. > > >> > > >> Right now, docs are updated in trunk when we add new features > > >> (usually), but these updates are not posted anywhere - so if someone > > >> builds from trunk, they have to build the docs and use them locally. > > >> > > >> When we do a release, we build the docs, copy the result into SVN and > > >> push this to our website. > > >> > > >> Looks a bit clunky to me :) > > >> > > >> I found a nice project called that can help: https://readthedocs.org/ > > >> > > >> This is a documentation hosting site that supports git, supports > > >> sphinx, and allows tagging and versioning of the documentation. > > >> > > >> Looks like it can improve our process and make things easier for us > > >> and our users. > > >> > > >> What do you guys think? > > >> Any other suggestions on how to make docs better? > > >> > > >> Gwen > > >> > > >
