Hi Scott,
The cms behind the website uses markdown. So ideally you would attach a
textfile with markdown formattings to a jira issue and a committer will
put that into the website.
Does that work for you?
PS: There are a lot of online markdown editors out there.
On 03/12/2014 03:27 PM, Scott C. Cote wrote:
I took the tour of the text analysis and pushed through despite the
problems on the page. Commiters helped me over the hump where others
might have just gave up (to your point).
When I did it, I made shell scripts so that my steps would be repeatable
with an anticipation of updating the page.
Unforunately, I gave up on trying to figure out how to update the page
(there were links indicating that I could do it), and I didn¹t want to
appear to be stupid asking how to update the documentation (my bad - not
anyone else). Now I know that it was not possible unless I was a commiter.
Who should I send my scripts to, or how should I proceed with a current
form of the page?
SCott
On 3/12/14, 5:02 AM, "Sebastian Schelter" <[email protected]> wrote:
Hi Pavan,
Awesome that you're willing to help. The documentation are the pages
listed under "Clustering" in the navigation bar under mahout.apache.org
If you start working on one of the pages listed there (e.g. the k-Means
doc), please created jira ticket in our issue tracker with a title along
the lines of "Cleaning up the documentation for k-Means on the website".
Put a list of errors and corrections into the jira and I (or some other
committer) will make sure to fix the website.
Thanks,
Sebastian
On 03/12/2014 08:48 AM, Pavan Kumar N wrote:
i ll help with clustering algorithms documentation. do send me old
documentation and i will check and remove errors. or better let me know
how to proceed.
Pavan
On Mar 12, 2014 12:35 PM, "Sebastian Schelter" <[email protected]> wrote:
Hi,
As you've probably noticed, I've put in a lot of effort over the last
days
to kickstart cleaning up our website. I've thrown out a lot of stuff
and
have been startled by the amout of outdated and incorrect information
on
our website, as well as links pointing to nowhere.
I think our lack of documentation makes it superhard to use Mahout for
new
people. A crucial next step is to clean up the documentation on
classification and clustering. I cannot do this alone, because I don't
have
the time and I'm not so familiar with the background of the algorithms.
I need volunteers to go through all the pages under "Classification"
and
"Clustering" on the website. For the algorithms, the content and
claims of
the articles need to be checked, for the examples we need to make sure
that
everything still works as described. It would also be great to move
articles from personal blogs to our website.
Imagine that some developer wants to try out Mahout and takes one hour
for
that in the evening. She will go to our website, download Mahout, read
the
description of an algorithm and try to run an example. In the current
state
of the documentation, I'm afraid that most people will walk away
frustrated, because the website does not help them as it should.
Best,
Sebastian
PS: I will make my standpoint on whether Mahout should do a 1.0 release
depend on whether we manage to clean up and maintain our documentation.
