New Site / Docs


(Shay Banon) #1

Hey fellows,

I created a new site for elasticsearch, under http://www.elasticsearch.org, hope you like it :). It still goes through changes, but the gist is there.

One of the things that I wanted to do was move all the docs to the github wiki, which I did. But now, I am not too happy with it. It mainly has to do with how the classification of pages is done on github wiki, so currently I am thinking of moving it back to the site itself.

The idea of moving it to the github wiki was to try and create more community driven content. Pages can edited on the spot, but, the whole fork clone thingy does not work properly with the github repo of the wiki, and you have to commit to see it locally on gollum.

The site itself if hosted on github (elasticsearch.github.com), so maybe the way I was trying to solve the community helping out thingy was wrong. Maybe with some publicity on how to get going with the site repo, fork / pull will be simpler and people will be able to share tutorials, getting started and the like.

I am playing now with moving the docs back to the site (grrr, after moving them to the wiki :frowning: ), I will see how it goes... . One of the things I wish to focus on post 0.15 is a boost to the documentation.

-shay.banon


(Karussell) #2

Yeah, would be really nice to have such community driven docs.
Especially in the Java documentation I would like to be able to just
hit 'edit' without git-ting around or sth.

But I also understand that the wiki is now a bit hard to navigate ...
is it an option for you to use external hostings for that doc?
E.g. wikispaces which has wysisyg or google code or something?

Regards,
Peter.

On 6 Feb., 13:04, Shay Banon shay.ba...@elasticsearch.com wrote:

Hey fellows,

I created a new site for elasticsearch, underhttp://www.elasticsearch.org, hope you like it :). It still goes through changes, but the gist is there.

One of the things that I wanted to do was move all the docs to the github wiki, which I did. But now, I am not too happy with it. It mainly has to do with how the classification of pages is done on github wiki, so currently I am thinking of moving it back to the site itself.

The idea of moving it to the github wiki was to try and create more community driven content. Pages can edited on the spot, but, the whole fork clone thingy does not work properly with the github repo of the wiki, and you have to commit to see it locally on gollum.

The site itself if hosted on github (elasticsearch.github.com), so maybe the way I was trying to solve the community helping out thingy was wrong. Maybe with some publicity on how to get going with the site repo, fork / pull will be simpler and people will be able to share tutorials, getting started and the like.

I am playing now with moving the docs back to the site (grrr, after moving them to the wiki :frowning: ), I will see how it goes... . One of the things I wish to focus on post 0.15 is a boost to the documentation.

-shay.banon


(Shay Banon) #3

I think that once you get to the flow, its easy to work with the elasticsearch.github.com repo, and then its just a matter of fork, and create a pull request.
On Sunday, February 6, 2011 at 11:12 PM, Karussell wrote:

Yeah, would be really nice to have such community driven docs.
Especially in the Java documentation I would like to be able to just
hit 'edit' without git-ting around or sth.

But I also understand that the wiki is now a bit hard to navigate ...
is it an option for you to use external hostings for that doc?
E.g. wikispaces which has wysisyg or google code or something?

Regards,
Peter.

On 6 Feb., 13:04, Shay Banon shay.ba...@elasticsearch.com wrote:

Hey fellows,

I created a new site for elasticsearch, underhttp://www.elasticsearch.org, hope you like it :). It still goes through changes, but the gist is there.

One of the things that I wanted to do was move all the docs to the github wiki, which I did. But now, I am not too happy with it. It mainly has to do with how the classification of pages is done on github wiki, so currently I am thinking of moving it back to the site itself.

The idea of moving it to the github wiki was to try and create more community driven content. Pages can edited on the spot, but, the whole fork clone thingy does not work properly with the github repo of the wiki, and you have to commit to see it locally on gollum.

The site itself if hosted on github (elasticsearch.github.com), so maybe the way I was trying to solve the community helping out thingy was wrong. Maybe with some publicity on how to get going with the site repo, fork / pull will be simpler and people will be able to share tutorials, getting started and the like.

I am playing now with moving the docs back to the site (grrr, after moving them to the wiki :frowning: ), I will see how it goes... . One of the things I wish to focus on post 0.15 is a boost to the documentation.

-shay.banon


(Clinton Gormley) #4

On Mon, 2011-02-07 at 00:31 +0200, Shay Banon wrote:

I think that once you get to the flow, its easy to work with the
elasticsearch.github.com repo, and then its just a matter of fork, and
create a pull request.

It really is quite easy, once you know how - adding a page documenting
the process to the docs will make it much easier for others to start
participating

/me saves up his tuits

clint


(Barsk) #5

Hi Shay,

I applaud the efforts of improving the docs. As a newbie to ES and
Lucene I have waded through most of the docs and now lately the source
as well.
I can see there are a number of thing that is not covered in the docs
that is on the source. Like a number of analysers and filters. I think
you enforce that test should accompany every contribution, maybe docs
should be commited also describing every part of the new stuff.

And about the wiki, if github wiki is not up to snuff, why not use
another standalone wiki type? It does not have to be on the same server.
Isn't there some free wiki services one can use?

Shay Banon skrev 2011-02-06 13:04:

Hey fellows,

I created a new site for elasticsearch, under
http://www.elasticsearch.org, hope you like it :). It still goes
through changes, but the gist is there.

One of the things that I wanted to do was move all the docs to the
github wiki, which I did. But now, I am not too happy with it. It
mainly has to do with how the classification of pages is done on
github wiki, so currently I am thinking of moving it back to the site
itself.

The idea of moving it to the github wiki was to try and create more
community driven content. Pages can edited on the spot, but, the whole
fork clone thingy does not work properly with the github repo of the
wiki, and you have to commit to see it locally on gollum.

The site itself if hosted on github (elasticsearch.github.com), so 

maybe the way I was trying to solve the community helping out thingy
was wrong. Maybe with some publicity on how to get going with the site
repo, fork / pull will be simpler and people will be able to share
tutorials, getting started and the like.

I am playing now with moving the docs back to the site (grrr, 

after moving them to the wiki :frowning: ), I will see how it goes... . One of
the things I wish to focus on post 0.15 is a boost to the documentation.

-shay.banon


(Shay Banon) #6

Heya,

I try to document all the additions made once a version is released, if I miss something shout over :). Or, better yet, one can simply fork over the site, fix it, and push a request for it.

The more I think about it, the more I like the fork / create pull request thingy. It means that its much simpler to control the quality of the contribution (since either myself or someone who is more familiar with the area in question will apply it) and make sure we keep a very high standard level of docs. With a wiki, once everybody can edit it, it becomes harder to track.

And, I don't see it ending just in the docs, I plan to create a tutorials section on the site, and people can simple add their own (hopefully).

-shay.banon
On Monday, February 7, 2011 at 9:39 AM, Kristian Jörg wrote:
Hi Shay,

I applaud the efforts of improving the docs. As a newbie to ES and
Lucene I have waded through most of the docs and now lately the source
as well.
I can see there are a number of thing that is not covered in the docs
that is on the source. Like a number of analysers and filters. I think
you enforce that test should accompany every contribution, maybe docs
should be commited also describing every part of the new stuff.

And about the wiki, if github wiki is not up to snuff, why not use
another standalone wiki type? It does not have to be on the same server.
Isn't there some free wiki services one can use?

Shay Banon skrev 2011-02-06 13:04:

Hey fellows,

I created a new site for elasticsearch, under
http://www.elasticsearch.org, hope you like it :). It still goes
through changes, but the gist is there.

One of the things that I wanted to do was move all the docs to the
github wiki, which I did. But now, I am not too happy with it. It
mainly has to do with how the classification of pages is done on
github wiki, so currently I am thinking of moving it back to the site
itself.

The idea of moving it to the github wiki was to try and create more
community driven content. Pages can edited on the spot, but, the whole
fork clone thingy does not work properly with the github repo of the
wiki, and you have to commit to see it locally on gollum.

The site itself if hosted on github (elasticsearch.github.com), so
maybe the way I was trying to solve the community helping out thingy
was wrong. Maybe with some publicity on how to get going with the site
repo, fork / pull will be simpler and people will be able to share
tutorials, getting started and the like.

I am playing now with moving the docs back to the site (grrr,
after moving them to the wiki :frowning: ), I will see how it goes... . One of
the things I wish to focus on post 0.15 is a boost to the documentation.

-shay.banon


(system) #7