You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@mahout.apache.org by tuxdna <tu...@gmail.com> on 2014/04/17 13:47:26 UTC
Is there any website documentation repository or tool for Apache Mahout?
I have seen the instructions here[1], but I am not sure if there is
any source-code for the documentation for website.
So here are my questions:
* Does Apache Mahout project use any tool to generate website
documentation as it is now http://mahout.apache.org ?
* Suppose I want to add some correction or edition to current Apache
Mahout documentation. Can I get a read-only access to the source of
website, so that I can immediately see how the edits will reflect once
there are accepted?
I was thinking in terms of the way GitHub pages work. For example if I
use Jekyll, I can view the changes on my machine, exactly as the will
appear on final website.
Regards,
Saleem
[1] http://mahout.apache.org/developers/how-to-update-the-website.html
[2] https://pages.github.com/
[3] http://jekyllrb.com/
Re: Is there any website documentation repository or tool for Apache
Mahout?
Posted by Sebastian Schelter <ss...@apache.org>.
No that is an old version, the name is just confusing.
--sebastian
On 04/20/2014 08:41 AM, tuxdna wrote:
> On Thu, Apr 17, 2014 at 11:54 PM, Sebastian Schelter
> <ss...@googlemail.com> wrote:
>> The templates for the individual pages are in the svn under site/ in
>> markdown format. You can use an online markdown editor to approximately see
>> how they look like.
>>
>
> I understand from recent commits that the current website is located in SVN at:
>
> http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
>
> However there is another folder inside site/ i.e. new_website/. Is
> this supposed to be a later version of the site?
>
> Regards,
> Saleem
>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
> Also can anyone explain how the .mdtext files are eventually converted
> into HTML for the current Mahout website?
>
> I guess there is a static site generator written in Perl ( lib/view.pm
> and lib/path.pm ). But what really invokes the site generation in
> terms of the entry point?
I was able to find the correct information on buildind Apache CMS sites.
Below are the instructions to generate Mahout Website from source on
your own machine.
Steps to folow:
* Checkout Mahout Website source
* Setup CMS build tool
* Run markdown daemon
* Generate and veiw the site
This has been checked with Ubuntu 12.04. Other distribution shall work
just fine as well.
Tools needed are SVN, Perl, Python and some bash commands.
Step 1: Checkout Mahout Website source
========================================
Checkout the Apache Mahout website source from SVN:
$ svn http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
$ cd trunk/
$ export SITE_SOURCE_PATH=`pwd`
SITE_SOURCE_PATH is the location where we have Mahout website source (
trunk or other branch ).
We also need to setup a location where we would generate the site
output. Lets assume it is at /tmp/mahout-website
$ export SITE_TARGET_PATH=/tmp/mahout-website
Step 2: Setup CMS build tool
========================================
Install the required Perl libraries
$ sudo aptitude install libyaml-perl
$ sudo perl -MCPAN -e "install Dotiac::DTL"
Checkout CMS build tool from SVN:
$ svn co https://svn.apache.org/repos/infra/websites/cms/
$ cd cms/build/
$ export CMS_TOOL_PATH=`pwd`
Step 3: Run markdownd daemon
========================================
The site source builder needs a markdownd daemon which can be started like this:
$ cd $CMS_TOOL_PATH
$ export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd`export
$ python markdownd.py
Step 4: Generate and veiw the site
========================================
Now generate the site from SITE_SORUCE_PATH to SITE_TARGET_PATH
$ cd $CMS_TOOL_PATH
$ perl build_site.pl --source-base $SITE_SOURCE_PATH --target-base
$SITE_TARGET_PATH
We are done with site generation, lets setup a simple web-server to
view the generated site.
Start a simple web server using python at the location $SITE_TARGET_PATH:
$ cd $SITE_TARGET_PATH
$ python -m SimpleHTTPServer
Finally the site can viewed using this url: http://localhost:8000/
More details are present here [1] and here [2].
I hope this is helpful for website documentation.
Regards,
Saleem
[1] https://svn.apache.org/repos/asf/openjpa/site/trunk/instructions.mdtext
[2] https://gist.github.com/tuxdna/11178000
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
> Also can anyone explain how the .mdtext files are eventually converted
> into HTML for the current Mahout website?
>
> I guess there is a static site generator written in Perl ( lib/view.pm
> and lib/path.pm ). But what really invokes the site generation in
> terms of the entry point?
I was able to find the correct information on buildind Apache CMS sites.
Below are the instructions to generate Mahout Website from source on
your own machine.
Steps to folow:
* Checkout Mahout Website source
* Setup CMS build tool
* Run markdown daemon
* Generate and veiw the site
This has been checked with Ubuntu 12.04. Other distribution shall work
just fine as well.
Tools needed are SVN, Perl, Python and some bash commands.
Step 1: Checkout Mahout Website source
========================================
Checkout the Apache Mahout website source from SVN:
$ svn http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
$ cd trunk/
$ export SITE_SOURCE_PATH=`pwd`
SITE_SOURCE_PATH is the location where we have Mahout website source (
trunk or other branch ).
We also need to setup a location where we would generate the site
output. Lets assume it is at /tmp/mahout-website
$ export SITE_TARGET_PATH=/tmp/mahout-website
Step 2: Setup CMS build tool
========================================
Install the required Perl libraries
$ sudo aptitude install libyaml-perl
$ sudo perl -MCPAN -e "install Dotiac::DTL"
Checkout CMS build tool from SVN:
$ svn co https://svn.apache.org/repos/infra/websites/cms/
$ cd cms/build/
$ export CMS_TOOL_PATH=`pwd`
Step 3: Run markdownd daemon
========================================
The site source builder needs a markdownd daemon which can be started like this:
$ cd $CMS_TOOL_PATH
$ export MARKDOWN_SOCKET=`pwd`/markdown.socket PYTHONPATH=`pwd`export
$ python markdownd.py
Step 4: Generate and veiw the site
========================================
Now generate the site from SITE_SORUCE_PATH to SITE_TARGET_PATH
$ cd $CMS_TOOL_PATH
$ perl build_site.pl --source-base $SITE_SOURCE_PATH --target-base
$SITE_TARGET_PATH
We are done with site generation, lets setup a simple web-server to
view the generated site.
Start a simple web server using python at the location $SITE_TARGET_PATH:
$ cd $SITE_TARGET_PATH
$ python -m SimpleHTTPServer
Finally the site can viewed using this url: http://localhost:8000/
More details are present here [1] and here [2].
I hope this is helpful for website documentation.
Regards,
Saleem
[1] https://svn.apache.org/repos/asf/openjpa/site/trunk/instructions.mdtext
[2] https://gist.github.com/tuxdna/11178000
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
>
> I understand from recent commits that the current website is located in SVN at:
>
> http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
>
I have created a git clone of the above repository, which can be found
below. This should save time for somebody who wants to do quick diff
and log using git:
* https://github.com/tuxdna/mahout-website
Also can anyone explain how the .mdtext files are eventually converted
into HTML for the current Mahout website?
I guess there is a static site generator written in Perl ( lib/view.pm
and lib/path.pm ). But what really invokes the site generation in
terms of the entry point?
Regards,
Saleem
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
>
> I understand from recent commits that the current website is located in SVN at:
>
> http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
>
I have created a git clone of the above repository, which can be found
below. This should save time for somebody who wants to do quick diff
and log using git:
* https://github.com/tuxdna/mahout-website
Also can anyone explain how the .mdtext files are eventually converted
into HTML for the current Mahout website?
I guess there is a static site generator written in Perl ( lib/view.pm
and lib/path.pm ). But what really invokes the site generation in
terms of the entry point?
Regards,
Saleem
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
On Thu, Apr 17, 2014 at 11:54 PM, Sebastian Schelter
<ss...@googlemail.com> wrote:
> The templates for the individual pages are in the svn under site/ in
> markdown format. You can use an online markdown editor to approximately see
> how they look like.
>
I understand from recent commits that the current website is located in SVN at:
http://svn.apache.org/repos/asf/mahout/site/mahout_cms/trunk
However there is another folder inside site/ i.e. new_website/. Is
this supposed to be a later version of the site?
Regards,
Saleem
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Sebastian Schelter <ss...@googlemail.com>.
The templates for the individual pages are in the svn under site/ in
markdown format. You can use an online markdown editor to approximately see
how they look like.
We don't have a better solution yet, unfortunately.
--sebastian
Am 17.04.2014 20:09 schrieb "Andrew Musselman" <an...@gmail.com>:
> The content of the "main" part of each page is written in markdown and
> parsed by the CMS to render the HTML. I'm not aware of a way to submit
> pages except as patches..
>
> > On Apr 17, 2014, at 1:52 PM, Pat Ferrel <pa...@occamsmachete.com> wrote:
> >
> > +1
> >
> > the project uses Confluence for the wiki. All but commiters are blocked
> from editing pages.
> >
> > This is getting increasingly frustrating. How many tickets and patches
> are being passed around now? I can’t follow them all. I haven’t used
> Confluence for 4-5 years now but there must be some way to allow edits and
> new pages from anyone pending approval to publish?
> >
> > On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
> >
> > I have seen the instructions here[1], but I am not sure if there is
> > any source-code for the documentation for website.
> >
> > So here are my questions:
> >
> > * Does Apache Mahout project use any tool to generate website
> > documentation as it is now http://mahout.apache.org ?
> >
> > * Suppose I want to add some correction or edition to current Apache
> > Mahout documentation. Can I get a read-only access to the source of
> > website, so that I can immediately see how the edits will reflect once
> > there are accepted?
> >
> > I was thinking in terms of the way GitHub pages work. For example if I
> > use Jekyll, I can view the changes on my machine, exactly as the will
> > appear on final website.
> >
> >
> > Regards,
> > Saleem
> >
> >
> > [1] http://mahout.apache.org/developers/how-to-update-the-website.html
> > [2] https://pages.github.com/
> > [3] http://jekyllrb.com/
> >
>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Sebastian Schelter <ss...@googlemail.com>.
The templates for the individual pages are in the svn under site/ in
markdown format. You can use an online markdown editor to approximately see
how they look like.
We don't have a better solution yet, unfortunately.
--sebastian
Am 17.04.2014 20:09 schrieb "Andrew Musselman" <an...@gmail.com>:
> The content of the "main" part of each page is written in markdown and
> parsed by the CMS to render the HTML. I'm not aware of a way to submit
> pages except as patches..
>
> > On Apr 17, 2014, at 1:52 PM, Pat Ferrel <pa...@occamsmachete.com> wrote:
> >
> > +1
> >
> > the project uses Confluence for the wiki. All but commiters are blocked
> from editing pages.
> >
> > This is getting increasingly frustrating. How many tickets and patches
> are being passed around now? I can’t follow them all. I haven’t used
> Confluence for 4-5 years now but there must be some way to allow edits and
> new pages from anyone pending approval to publish?
> >
> > On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
> >
> > I have seen the instructions here[1], but I am not sure if there is
> > any source-code for the documentation for website.
> >
> > So here are my questions:
> >
> > * Does Apache Mahout project use any tool to generate website
> > documentation as it is now http://mahout.apache.org ?
> >
> > * Suppose I want to add some correction or edition to current Apache
> > Mahout documentation. Can I get a read-only access to the source of
> > website, so that I can immediately see how the edits will reflect once
> > there are accepted?
> >
> > I was thinking in terms of the way GitHub pages work. For example if I
> > use Jekyll, I can view the changes on my machine, exactly as the will
> > appear on final website.
> >
> >
> > Regards,
> > Saleem
> >
> >
> > [1] http://mahout.apache.org/developers/how-to-update-the-website.html
> > [2] https://pages.github.com/
> > [3] http://jekyllrb.com/
> >
>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by tuxdna <tu...@gmail.com>.
On Sun, Apr 20, 2014 at 11:42 AM, Sebastian Schelter <ss...@apache.org> wrote:
> I've learned that there should be some means to work with the CMS as a
> non-committer. I haven't tried whether this works well though.
>
> See "FAQ - Anonymous/Non-Committer Use" at
> https://www.apache.org/dev/cmsref.html#staging and the video tutorial at
> http://s.apache.org/cms-anonymous-tutorial
>
The video is very clear and concise on how to make changes to Website.
Very useful.
Thanks for sharing.
Regards,
Saleem
Re: Is there any website documentation repository or tool for Apache
Mahout?
Posted by Sebastian Schelter <ss...@apache.org>.
I've learned that there should be some means to work with the CMS as a
non-committer. I haven't tried whether this works well though.
See "FAQ - Anonymous/Non-Committer Use" at
https://www.apache.org/dev/cmsref.html#staging and the video tutorial at
http://s.apache.org/cms-anonymous-tutorial
--sebastian
On 04/17/2014 08:08 PM, Andrew Musselman wrote:
> The content of the "main" part of each page is written in markdown and parsed by the CMS to render the HTML. I'm not aware of a way to submit pages except as patches..
>
>> On Apr 17, 2014, at 1:52 PM, Pat Ferrel <pa...@occamsmachete.com> wrote:
>>
>> +1
>>
>> the project uses Confluence for the wiki. All but commiters are blocked from editing pages.
>>
>> This is getting increasingly frustrating. How many tickets and patches are being passed around now? I can’t follow them all. I haven’t used Confluence for 4-5 years now but there must be some way to allow edits and new pages from anyone pending approval to publish?
>>
>> On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
>>
>> I have seen the instructions here[1], but I am not sure if there is
>> any source-code for the documentation for website.
>>
>> So here are my questions:
>>
>> * Does Apache Mahout project use any tool to generate website
>> documentation as it is now http://mahout.apache.org ?
>>
>> * Suppose I want to add some correction or edition to current Apache
>> Mahout documentation. Can I get a read-only access to the source of
>> website, so that I can immediately see how the edits will reflect once
>> there are accepted?
>>
>> I was thinking in terms of the way GitHub pages work. For example if I
>> use Jekyll, I can view the changes on my machine, exactly as the will
>> appear on final website.
>>
>>
>> Regards,
>> Saleem
>>
>>
>> [1] http://mahout.apache.org/developers/how-to-update-the-website.html
>> [2] https://pages.github.com/
>> [3] http://jekyllrb.com/
>>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Andrew Musselman <an...@gmail.com>.
The content of the "main" part of each page is written in markdown and parsed by the CMS to render the HTML. I'm not aware of a way to submit pages except as patches..
> On Apr 17, 2014, at 1:52 PM, Pat Ferrel <pa...@occamsmachete.com> wrote:
>
> +1
>
> the project uses Confluence for the wiki. All but commiters are blocked from editing pages.
>
> This is getting increasingly frustrating. How many tickets and patches are being passed around now? I can’t follow them all. I haven’t used Confluence for 4-5 years now but there must be some way to allow edits and new pages from anyone pending approval to publish?
>
> On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
>
> I have seen the instructions here[1], but I am not sure if there is
> any source-code for the documentation for website.
>
> So here are my questions:
>
> * Does Apache Mahout project use any tool to generate website
> documentation as it is now http://mahout.apache.org ?
>
> * Suppose I want to add some correction or edition to current Apache
> Mahout documentation. Can I get a read-only access to the source of
> website, so that I can immediately see how the edits will reflect once
> there are accepted?
>
> I was thinking in terms of the way GitHub pages work. For example if I
> use Jekyll, I can view the changes on my machine, exactly as the will
> appear on final website.
>
>
> Regards,
> Saleem
>
>
> [1] http://mahout.apache.org/developers/how-to-update-the-website.html
> [2] https://pages.github.com/
> [3] http://jekyllrb.com/
>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Andrew Musselman <an...@gmail.com>.
The content of the "main" part of each page is written in markdown and parsed by the CMS to render the HTML. I'm not aware of a way to submit pages except as patches..
> On Apr 17, 2014, at 1:52 PM, Pat Ferrel <pa...@occamsmachete.com> wrote:
>
> +1
>
> the project uses Confluence for the wiki. All but commiters are blocked from editing pages.
>
> This is getting increasingly frustrating. How many tickets and patches are being passed around now? I can’t follow them all. I haven’t used Confluence for 4-5 years now but there must be some way to allow edits and new pages from anyone pending approval to publish?
>
> On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
>
> I have seen the instructions here[1], but I am not sure if there is
> any source-code for the documentation for website.
>
> So here are my questions:
>
> * Does Apache Mahout project use any tool to generate website
> documentation as it is now http://mahout.apache.org ?
>
> * Suppose I want to add some correction or edition to current Apache
> Mahout documentation. Can I get a read-only access to the source of
> website, so that I can immediately see how the edits will reflect once
> there are accepted?
>
> I was thinking in terms of the way GitHub pages work. For example if I
> use Jekyll, I can view the changes on my machine, exactly as the will
> appear on final website.
>
>
> Regards,
> Saleem
>
>
> [1] http://mahout.apache.org/developers/how-to-update-the-website.html
> [2] https://pages.github.com/
> [3] http://jekyllrb.com/
>
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Pat Ferrel <pa...@occamsmachete.com>.
+1
the project uses Confluence for the wiki. All but commiters are blocked from editing pages.
This is getting increasingly frustrating. How many tickets and patches are being passed around now? I can’t follow them all. I haven’t used Confluence for 4-5 years now but there must be some way to allow edits and new pages from anyone pending approval to publish?
On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
I have seen the instructions here[1], but I am not sure if there is
any source-code for the documentation for website.
So here are my questions:
* Does Apache Mahout project use any tool to generate website
documentation as it is now http://mahout.apache.org ?
* Suppose I want to add some correction or edition to current Apache
Mahout documentation. Can I get a read-only access to the source of
website, so that I can immediately see how the edits will reflect once
there are accepted?
I was thinking in terms of the way GitHub pages work. For example if I
use Jekyll, I can view the changes on my machine, exactly as the will
appear on final website.
Regards,
Saleem
[1] http://mahout.apache.org/developers/how-to-update-the-website.html
[2] https://pages.github.com/
[3] http://jekyllrb.com/
Re: Is there any website documentation repository or tool for Apache Mahout?
Posted by Pat Ferrel <pa...@occamsmachete.com>.
+1
the project uses Confluence for the wiki. All but commiters are blocked from editing pages.
This is getting increasingly frustrating. How many tickets and patches are being passed around now? I can’t follow them all. I haven’t used Confluence for 4-5 years now but there must be some way to allow edits and new pages from anyone pending approval to publish?
On Apr 17, 2014, at 4:47 AM, tuxdna <tu...@gmail.com> wrote:
I have seen the instructions here[1], but I am not sure if there is
any source-code for the documentation for website.
So here are my questions:
* Does Apache Mahout project use any tool to generate website
documentation as it is now http://mahout.apache.org ?
* Suppose I want to add some correction or edition to current Apache
Mahout documentation. Can I get a read-only access to the source of
website, so that I can immediately see how the edits will reflect once
there are accepted?
I was thinking in terms of the way GitHub pages work. For example if I
use Jekyll, I can view the changes on my machine, exactly as the will
appear on final website.
Regards,
Saleem
[1] http://mahout.apache.org/developers/how-to-update-the-website.html
[2] https://pages.github.com/
[3] http://jekyllrb.com/
Re: Is there any website documentation repository or tool for
Apache Mahout?
Posted by Adam Ilardi <ma...@gmail.com>.
—
Sent from Mailbox for iPhone
On Thu, Apr 17, 2014 at 7:47 AM, tuxdna <tu...@gmail.com> wrote:
> I have seen the instructions here[1], but I am not sure if there is
> any source-code for the documentation for website.
> So here are my questions:
> * Does Apache Mahout project use any tool to generate website
> documentation as it is now http://mahout.apache.org ?
> * Suppose I want to add some correction or edition to current Apache
> Mahout documentation. Can I get a read-only access to the source of
> website, so that I can immediately see how the edits will reflect once
> there are accepted?
> I was thinking in terms of the way GitHub pages work. For example if I
> use Jekyll, I can view the changes on my machine, exactly as the will
> appear on final website.
> Regards,
> Saleem
> [1] http://mahout.apache.org/developers/how-to-update-the-website.html
> [2] https://pages.github.com/
> [3] http://jekyllrb.com/