Any possibility of permalinks to documentation for each version?


(Tim S) #1

I notice the docs for version 1.0.0 are in a "1.x" branch. When 1.1 is
released, I'm assuming the 1.x branch docs will be updated to 1.1?

Is there any possibility of creating permanent links to each version? (like
lucene do, e.g http://lucene.apache.org/core/3_6_1/). The reason is simply
that if I build a solution for a customer that requires a specific version
of elasticsearch, then my documentation will probably end up referencing
various bits of the elasticsearch documentation. Which is tricky if the
documentation I'm referencing is changing.

So, I was wondering if it would be possible to create links for each
release version, so instead of referencing
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search.htmlI can reference
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.0.0.Release/search.htmlor similar, and then I can be happy that the documentation I'm linking to
is the exact documentation for the version that my customer uses.

Thanks,

Tim.

--
You received this message because you are subscribed to the Google Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elasticsearch/dd467b38-da9b-4f4e-9ebe-f39adb403f2f%40googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.


(Ivan Brusic) #2

The documentation is now versioned. For example (random page)

0.90:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html
master:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html
current:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html

I am guessing a 1.0 version will be built once it is released. It doesn't
seem like they support minor versions. Not sure what "current" signifies,
but you can probably figure it out by reading the documentation building
script source: https://github.com/elasticsearch/docs

--
Ivan

On Mon, Jan 27, 2014 at 1:27 AM, Tim S timstibbs@gmail.com wrote:

I notice the docs for version 1.0.0 are in a "1.x" branch. When 1.1 is
released, I'm assuming the 1.x branch docs will be updated to 1.1?

Is there any possibility of creating permanent links to each version?
(like lucene do, e.g http://lucene.apache.org/core/3_6_1/). The reason is
simply that if I build a solution for a customer that requires a specific
version of elasticsearch, then my documentation will probably end up
referencing various bits of the elasticsearch documentation. Which is
tricky if the documentation I'm referencing is changing.

So, I was wondering if it would be possible to create links for each
release version, so instead of referencing
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search.htmlI can reference
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.0.0.Release/search.htmlor similar, and then I can be happy that the documentation I'm linking to
is the exact documentation for the version that my customer uses.

Thanks,

Tim.

--
You received this message because you are subscribed to the Google Groups
"elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elasticsearch/dd467b38-da9b-4f4e-9ebe-f39adb403f2f%40googlegroups.com
.
For more options, visit https://groups.google.com/groups/opt_out.

--
You received this message because you are subscribed to the Google Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elasticsearch/CALY%3DcQD7n3SmBgaid6cQzHKJYE_Nn7a-UqkoZMaDb_5vagNWGg%40mail.gmail.com.
For more options, visit https://groups.google.com/groups/opt_out.


(Ivan Brusic) #3

Here are the current branches:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/index.html

On Mon, Jan 27, 2014 at 11:53 AM, Ivan Brusic ivan@brusic.com wrote:

The documentation is now versioned. For example (random page)

0.90:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html
master:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html
current:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html

I am guessing a 1.0 version will be built once it is released. It doesn't
seem like they support minor versions. Not sure what "current" signifies,
but you can probably figure it out by reading the documentation building
script source: https://github.com/elasticsearch/docs

--
Ivan

On Mon, Jan 27, 2014 at 1:27 AM, Tim S timstibbs@gmail.com wrote:

I notice the docs for version 1.0.0 are in a "1.x" branch. When 1.1 is
released, I'm assuming the 1.x branch docs will be updated to 1.1?

Is there any possibility of creating permanent links to each version?
(like lucene do, e.g http://lucene.apache.org/core/3_6_1/). The reason
is simply that if I build a solution for a customer that requires a
specific version of elasticsearch, then my documentation will probably end
up referencing various bits of the elasticsearch documentation. Which is
tricky if the documentation I'm referencing is changing.

So, I was wondering if it would be possible to create links for each
release version, so instead of referencing
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search.htmlI can reference
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.0.0.Release/search.htmlor similar, and then I can be happy that the documentation I'm linking to
is the exact documentation for the version that my customer uses.

Thanks,

Tim.

--
You received this message because you are subscribed to the Google Groups
"elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elasticsearch/dd467b38-da9b-4f4e-9ebe-f39adb403f2f%40googlegroups.com
.
For more options, visit https://groups.google.com/groups/opt_out.

--
You received this message because you are subscribed to the Google Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elasticsearch/CALY%3DcQAO%3D064t8pW%2Bwxxh5%3DmnHZ_sA3duvZon58qBTHnm%2BBXrA%40mail.gmail.com.
For more options, visit https://groups.google.com/groups/opt_out.


(Tim S) #4

"It doesn't seem like they support minor versions." - this is exactly what
I'm asking "them" to do...

It doesn't have to be linked to from the main page, but a stable link that
I know will still be there a year or two in the future will be very useful.

On Monday, January 27, 2014 7:54:47 PM UTC, Ivan Brusic wrote:

Here are the current branches:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/index.html

On Mon, Jan 27, 2014 at 11:53 AM, Ivan Brusic <iv...@brusic.com<javascript:>

wrote:

The documentation is now versioned. For example (random page)

0.90:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html
master:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html
current:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html

I am guessing a 1.0 version will be built once it is released. It doesn't
seem like they support minor versions. Not sure what "current" signifies,
but you can probably figure it out by reading the documentation building
script source: https://github.com/elasticsearch/docs

--
Ivan

On Mon, Jan 27, 2014 at 1:27 AM, Tim S <tims...@gmail.com <javascript:>>wrote:

I notice the docs for version 1.0.0 are in a "1.x" branch. When 1.1 is
released, I'm assuming the 1.x branch docs will be updated to 1.1?

Is there any possibility of creating permanent links to each version?
(like lucene do, e.g http://lucene.apache.org/core/3_6_1/). The reason
is simply that if I build a solution for a customer that requires a
specific version of elasticsearch, then my documentation will probably end
up referencing various bits of the elasticsearch documentation. Which is
tricky if the documentation I'm referencing is changing.

So, I was wondering if it would be possible to create links for each
release version, so instead of referencing
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search.htmlI can reference
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.0.0.Release/search.htmlor similar, and then I can be happy that the documentation I'm linking to
is the exact documentation for the version that my customer uses.

Thanks,

Tim.

--
You received this message because you are subscribed to the Google
Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to elasticsearc...@googlegroups.com <javascript:>.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elasticsearch/dd467b38-da9b-4f4e-9ebe-f39adb403f2f%40googlegroups.com
.
For more options, visit https://groups.google.com/groups/opt_out.

--
You received this message because you are subscribed to the Google Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elasticsearch/88e08dda-b9c5-4bdd-b6e3-73bba41ca503%40googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.


(Zachary Tong) #5

The documentation will follow the Elasticsearch branching structure, which
will include minor branches too (1.x, etc). Minor versions aren't
available right now since the versioned doc support was just recently added
to 0.90.x.

"Current" refers to the currently recommended, stable version. For
example, the most recent version is 1.0.RC1, but the "current" version is
still 0.90.10 since the RC isn't a GA release yet.

Hope that helps!

On Tuesday, January 28, 2014 4:42:06 AM UTC-5, Tim S wrote:

"It doesn't seem like they support minor versions." - this is exactly what
I'm asking "them" to do...

It doesn't have to be linked to from the main page, but a stable link that
I know will still be there a year or two in the future will be very useful.

On Monday, January 27, 2014 7:54:47 PM UTC, Ivan Brusic wrote:

Here are the current branches:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/index.html

On Mon, Jan 27, 2014 at 11:53 AM, Ivan Brusic iv...@brusic.com wrote:

The documentation is now versioned. For example (random page)

0.90:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/0.90/search-search.html
master:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/master/search-search.html
current:
http://www.elasticsearch.org/guide/en/elasticsearch/reference/current/search-search.html

I am guessing a 1.0 version will be built once it is released. It
doesn't seem like they support minor versions. Not sure what "current"
signifies, but you can probably figure it out by reading the documentation
building script source: https://github.com/elasticsearch/docs

--
Ivan

On Mon, Jan 27, 2014 at 1:27 AM, Tim S tims...@gmail.com wrote:

I notice the docs for version 1.0.0 are in a "1.x" branch. When 1.1 is
released, I'm assuming the 1.x branch docs will be updated to 1.1?

Is there any possibility of creating permanent links to each version?
(like lucene do, e.g http://lucene.apache.org/core/3_6_1/). The reason
is simply that if I build a solution for a customer that requires a
specific version of elasticsearch, then my documentation will probably end
up referencing various bits of the elasticsearch documentation. Which is
tricky if the documentation I'm referencing is changing.

So, I was wondering if it would be possible to create links for each
release version, so instead of referencing
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.x/search.htmlI can reference
http://www.elasticsearch.org/guide/en/elasticsearch/reference/1.0.0.Release/search.htmlor similar, and then I can be happy that the documentation I'm linking to
is the exact documentation for the version that my customer uses.

Thanks,

Tim.

--
You received this message because you are subscribed to the Google
Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send
an email to elasticsearc...@googlegroups.com.
To view this discussion on the web visit
https://groups.google.com/d/msgid/elasticsearch/dd467b38-da9b-4f4e-9ebe-f39adb403f2f%40googlegroups.com
.
For more options, visit https://groups.google.com/groups/opt_out.

--
You received this message because you are subscribed to the Google Groups "elasticsearch" group.
To unsubscribe from this group and stop receiving emails from it, send an email to elasticsearch+unsubscribe@googlegroups.com.
To view this discussion on the web visit https://groups.google.com/d/msgid/elasticsearch/815cb53c-867d-4061-bd71-dc6cf016fa2f%40googlegroups.com.
For more options, visit https://groups.google.com/groups/opt_out.


(system) #6