You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@impala.apache.org by Jim Apple <jb...@cloudera.com> on 2016/11/14 21:37:21 UTC
New tool for building Impala: dita-ot
The Impala user docs are hopefully going to be added to the master
branch soon. THey are built using a tool called "dita-ot". I have
added it to the impala-setup repo that we tell new developers to use
to get their environment configured.
If you want to install this tool, you can manually follow the chef
recipe in that change to impala-setup:
UNZIP_LOCATION=$(mktemp -d)
cd "${UNZIP_LOCATION}"
wget https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip
unzip dita-ot-2.3.3.zip
sudo cp -r dita-ot-2.3.3 /opt/
cd ~
rm -rf "${UNZIP_LOCATION}"
echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
Once the docs are in, I am anticipating sending a patch to add a
"make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
buildall.sh
Re: New tool for building Impala: dita-ot
Posted by Jim Apple <jb...@cloudera.com>.
Also, the subject of the this email should be "New tool for building
Impala DOCS: dita-ot". The build of everything else should remain the
same.
On Mon, Nov 14, 2016 at 1:37 PM, Jim Apple <jb...@cloudera.com> wrote:
> The Impala user docs are hopefully going to be added to the master
> branch soon. THey are built using a tool called "dita-ot". I have
> added it to the impala-setup repo that we tell new developers to use
> to get their environment configured.
>
> If you want to install this tool, you can manually follow the chef
> recipe in that change to impala-setup:
>
> UNZIP_LOCATION=$(mktemp -d)
> cd "${UNZIP_LOCATION}"
> wget https://github.com/dita-ot/dita-ot/releases/download/2.3.3/dita-ot-2.3.3.zip
> unzip dita-ot-2.3.3.zip
> sudo cp -r dita-ot-2.3.3 /opt/
> cd ~
> rm -rf "${UNZIP_LOCATION}"
> echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
>
> Once the docs are in, I am anticipating sending a patch to add a
> "make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
> buildall.sh
Re: New tool for building Impala: dita-ot
Posted by Jim Apple <jb...@cloudera.com>.
We could require reviews, but expect them to be more cursory.
This might just happen naturally.
On Mon, Nov 14, 2016 at 3:53 PM, Henry Robinson <he...@cloudera.com> wrote:
> On 14 November 2016 at 13:53, Jim Apple <jb...@cloudera.com> wrote:
>
>> Good points, Henry - thank you for raising them.
>>
>> 1. RTC policy: There is no reason we have to have the same conventions
>> for the strictness of review uniformly. Although gerrit will still
>> enforce RTC, we can set a convention (or even write it into the
>> bylaws) that one should not +2 oneself except in the docs directory.
>> Many variations are possible. I'd suggest we get it going and
>> re-evaluate frequently.
>>
>> 2. Separate branch: John Russell and Laurel Hale and I talked about
>> it. This would still have a RTC enforcement by the ASF VC servers,
>> except for committers. Those committers can already +2 themselves on
>> our gerrit setup. The advantage of same-branch work is that the docs
>> can be more closely synced. In particular, when master is branched for
>> a release, the docs will be branched, too.
>>
>
> Sounds good to me, thanks for the clarifications. It's a bit unfortunate
> that some commits won't get reviewed but will still go through Gerrit,
> increasing the noise, but not clear what we could do differently.
>
>
>>
>>
>> On Mon, Nov 14, 2016 at 1:43 PM, Henry Robinson <he...@cloudera.com>
>> wrote:
>> > Does that mean that docs will be subject to the same RTC policy as the
>> rest
>> > of master? There seems to be a lot more churn in the docs content - did
>> you
>> > give any consideration to having them on a separate branch?
>> >
>> > On 14 November 2016 at 13:37, Jim Apple <jb...@cloudera.com> wrote:
>> >
>> >> The Impala user docs are hopefully going to be added to the master
>> >> branch soon. THey are built using a tool called "dita-ot". I have
>> >> added it to the impala-setup repo that we tell new developers to use
>> >> to get their environment configured.
>> >>
>> >> If you want to install this tool, you can manually follow the chef
>> >> recipe in that change to impala-setup:
>> >>
>> >> UNZIP_LOCATION=$(mktemp -d)
>> >> cd "${UNZIP_LOCATION}"
>> >> wget https://github.com/dita-ot/dita-ot/releases/download/2.3.
>> >> 3/dita-ot-2.3.3.zip
>> >> unzip dita-ot-2.3.3.zip
>> >> sudo cp -r dita-ot-2.3.3 /opt/
>> >> cd ~
>> >> rm -rf "${UNZIP_LOCATION}"
>> >> echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
>> >>
>> >> Once the docs are in, I am anticipating sending a patch to add a
>> >> "make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
>> >> buildall.sh
>> >>
>> >
>> >
>> >
>> > --
>> > Henry Robinson
>> > Software Engineer
>> > Cloudera
>> > 415-994-6679
>>
Re: New tool for building Impala: dita-ot
Posted by Henry Robinson <he...@cloudera.com>.
On 14 November 2016 at 13:53, Jim Apple <jb...@cloudera.com> wrote:
> Good points, Henry - thank you for raising them.
>
> 1. RTC policy: There is no reason we have to have the same conventions
> for the strictness of review uniformly. Although gerrit will still
> enforce RTC, we can set a convention (or even write it into the
> bylaws) that one should not +2 oneself except in the docs directory.
> Many variations are possible. I'd suggest we get it going and
> re-evaluate frequently.
>
> 2. Separate branch: John Russell and Laurel Hale and I talked about
> it. This would still have a RTC enforcement by the ASF VC servers,
> except for committers. Those committers can already +2 themselves on
> our gerrit setup. The advantage of same-branch work is that the docs
> can be more closely synced. In particular, when master is branched for
> a release, the docs will be branched, too.
>
Sounds good to me, thanks for the clarifications. It's a bit unfortunate
that some commits won't get reviewed but will still go through Gerrit,
increasing the noise, but not clear what we could do differently.
>
>
> On Mon, Nov 14, 2016 at 1:43 PM, Henry Robinson <he...@cloudera.com>
> wrote:
> > Does that mean that docs will be subject to the same RTC policy as the
> rest
> > of master? There seems to be a lot more churn in the docs content - did
> you
> > give any consideration to having them on a separate branch?
> >
> > On 14 November 2016 at 13:37, Jim Apple <jb...@cloudera.com> wrote:
> >
> >> The Impala user docs are hopefully going to be added to the master
> >> branch soon. THey are built using a tool called "dita-ot". I have
> >> added it to the impala-setup repo that we tell new developers to use
> >> to get their environment configured.
> >>
> >> If you want to install this tool, you can manually follow the chef
> >> recipe in that change to impala-setup:
> >>
> >> UNZIP_LOCATION=$(mktemp -d)
> >> cd "${UNZIP_LOCATION}"
> >> wget https://github.com/dita-ot/dita-ot/releases/download/2.3.
> >> 3/dita-ot-2.3.3.zip
> >> unzip dita-ot-2.3.3.zip
> >> sudo cp -r dita-ot-2.3.3 /opt/
> >> cd ~
> >> rm -rf "${UNZIP_LOCATION}"
> >> echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
> >>
> >> Once the docs are in, I am anticipating sending a patch to add a
> >> "make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
> >> buildall.sh
> >>
> >
> >
> >
> > --
> > Henry Robinson
> > Software Engineer
> > Cloudera
> > 415-994-6679
>
Re: New tool for building Impala: dita-ot
Posted by Jim Apple <jb...@cloudera.com>.
Good points, Henry - thank you for raising them.
1. RTC policy: There is no reason we have to have the same conventions
for the strictness of review uniformly. Although gerrit will still
enforce RTC, we can set a convention (or even write it into the
bylaws) that one should not +2 oneself except in the docs directory.
Many variations are possible. I'd suggest we get it going and
re-evaluate frequently.
2. Separate branch: John Russell and Laurel Hale and I talked about
it. This would still have a RTC enforcement by the ASF VC servers,
except for committers. Those committers can already +2 themselves on
our gerrit setup. The advantage of same-branch work is that the docs
can be more closely synced. In particular, when master is branched for
a release, the docs will be branched, too.
On Mon, Nov 14, 2016 at 1:43 PM, Henry Robinson <he...@cloudera.com> wrote:
> Does that mean that docs will be subject to the same RTC policy as the rest
> of master? There seems to be a lot more churn in the docs content - did you
> give any consideration to having them on a separate branch?
>
> On 14 November 2016 at 13:37, Jim Apple <jb...@cloudera.com> wrote:
>
>> The Impala user docs are hopefully going to be added to the master
>> branch soon. THey are built using a tool called "dita-ot". I have
>> added it to the impala-setup repo that we tell new developers to use
>> to get their environment configured.
>>
>> If you want to install this tool, you can manually follow the chef
>> recipe in that change to impala-setup:
>>
>> UNZIP_LOCATION=$(mktemp -d)
>> cd "${UNZIP_LOCATION}"
>> wget https://github.com/dita-ot/dita-ot/releases/download/2.3.
>> 3/dita-ot-2.3.3.zip
>> unzip dita-ot-2.3.3.zip
>> sudo cp -r dita-ot-2.3.3 /opt/
>> cd ~
>> rm -rf "${UNZIP_LOCATION}"
>> echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
>>
>> Once the docs are in, I am anticipating sending a patch to add a
>> "make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
>> buildall.sh
>>
>
>
>
> --
> Henry Robinson
> Software Engineer
> Cloudera
> 415-994-6679
Re: New tool for building Impala: dita-ot
Posted by Henry Robinson <he...@cloudera.com>.
Does that mean that docs will be subject to the same RTC policy as the rest
of master? There seems to be a lot more churn in the docs content - did you
give any consideration to having them on a separate branch?
On 14 November 2016 at 13:37, Jim Apple <jb...@cloudera.com> wrote:
> The Impala user docs are hopefully going to be added to the master
> branch soon. THey are built using a tool called "dita-ot". I have
> added it to the impala-setup repo that we tell new developers to use
> to get their environment configured.
>
> If you want to install this tool, you can manually follow the chef
> recipe in that change to impala-setup:
>
> UNZIP_LOCATION=$(mktemp -d)
> cd "${UNZIP_LOCATION}"
> wget https://github.com/dita-ot/dita-ot/releases/download/2.3.
> 3/dita-ot-2.3.3.zip
> unzip dita-ot-2.3.3.zip
> sudo cp -r dita-ot-2.3.3 /opt/
> cd ~
> rm -rf "${UNZIP_LOCATION}"
> echo 'PATH=/opt/dita-ot-2.3.3/bin:"${PATH}"' >> ~/.bashrc
>
> Once the docs are in, I am anticipating sending a patch to add a
> "make-docs.sh" or the like to $IMPALA_HOME/bin/. I may also add it to
> buildall.sh
>
--
Henry Robinson
Software Engineer
Cloudera
415-994-6679