hadoop-hdfs-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Andrew Wang <andrew.w...@cloudera.com>
Subject Re: Some information required related to Hadoop documentation developement
Date Thu, 06 Nov 2014 20:36:40 GMT
These are APT doc files, see this page (*.apt.vm):

http://maven.apache.org/doxia/references/apt-format.html

On Thu, Nov 6, 2014 at 10:42 AM, Masatake Iwasaki <
iwasakims@oss.nttdata.co.jp> wrote:

> Hi Naga,
>
>
> >   1.  what and how are these *.vm files(format) used in Hadoop [Hdfs and
> Yarn] documentation ?
> >   2.  Does vm files stand for velocity macro?
>
> Velocity macro is used for variable substitution as far as I know.
> For example::
>
>   ---
>   YARN Timeline Server
>   ---
>   ---
>   ${maven.build.timestamp}
>
> Though many of dosc uses APT format ( http://maven.apache.org/doxia/
> references/apt-format.html ),
> you can also use markdown.
> See hadoop-mapreduce-project/hadoop-mapreduce-client/
> hadoop-mapreduce-client-core/src/site/markdown
> for example.
>
>
> >  5.  Are these documentation pages built if " -Pdocs " parameters are
> provided during "mvn install" ? If so which Pom is responsible for building
> the html files ? Basically how to modify and test the generated html files?
>
> Run "mvn site" to build site docs.
> Running "mvn site site:stage -DstagingDirectory=/var/www/html/hadoop-site"
> puts built docs to specifiled path.
>
>
> >  6.  From earlier patches  (ex : yarn 1696) i figured out that to add
> new page(in yarn documentation) we can add a *.vm file in
> "hadoop-yarn-project\hadoop-yarn\hadoop-yarn-site\src\site\apt" and make
> entry in "hadoop-project\src\site\site.xml"  for the new page? Is that
> sufficient or anything else needs to be taken care?
>
> I think it is sufficient.
>
>
> Masatake Iwasaki
>
>
> (11/6/14, 9:51), Naganarasimha G R (Naga) wrote:> Hi All,
> > I wanted to know the following related to Hadoop Documentation
> >
> >    1.  what and how are these *.vm files(format) used in Hadoop [Hdfs
> and Yarn] documentation ?
> >    2.  Does vm files stand for velocity macro?
> >    3.  Do we use some kind of editor to create/update these files ?
> >    4.  Are there any guidelines for writing Hadoop/YARN documentation ?
> >    5.  Are these documentation pages built if " -Pdocs " parameters are
> provided during "mvn install" ? If so which Pom is responsible for building
> the html files ? Basically how to modify and test the generated html files?
> >    6.  From earlier patches  (ex : yarn 1696) i figured out that to add
> new page(in yarn documentation) we can add a *.vm file in
> "hadoop-yarn-project\hadoop-yarn\hadoop-yarn-site\src\site\apt" and make
> entry in "hadoop-project\src\site\site.xml"  for the new page? Is that
> sufficient or anything else needs to be taken care?
> >
> >
> > Regards,
> >
> > Naga
> >
> >
> >
> > Huawei Technologies Co., Ltd.
> > Phone:
> > Fax:
> > Mobile:  +91 9980040283
> > Email: naganarasimhagr@huawei.com<mailto:naganarasimhagr@huawei.com>
> > Huawei Technologies Co., Ltd.
> > Bantian, Longgang District,Shenzhen 518129, P.R.China
> > http://www.huawei.com
> >
>
>
>

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