Documentation updates on janusgraph.org


Christopher Quinones <therea...@...>
 

Hi everyone,

I'd like to contribute a blurb onto the getting-started tutorial indicating that it's possible to use the loadWithoutMixedIndex method when using a configuration that doesn't have an index backend enabled.

Is it possible to update the tutorial without publishing a brand new release?  I noticed that the documentation referenced 0.1.1 as the latest.

Thanks!


Misha Brukman <mbru...@...>
 

Hi Christopher,

Go ahead and make the change on the master branch, and a new build of the docs will be published as soon as it's next built for an RC or SNAPSHOT or release. 

Right now, http://docs.janusgraph.org/latest/ points to the latest one of the above, which is currently "0.2.0-SNAPSHOT" as per the pom.xml, so we could technically publish that, and link "latest" to that as the directory.

What do others developers think?

Misha

On Tue, May 30, 2017 at 5:03 PM, Christopher Quinones <therea...@...> wrote:
Hi everyone,

I'd like to contribute a blurb onto the getting-started tutorial indicating that it's possible to use the loadWithoutMixedIndex method when using a configuration that doesn't have an index backend enabled.

Is it possible to update the tutorial without publishing a brand new release?  I noticed that the documentation referenced 0.1.1 as the latest.

Thanks!

--
You received this message because you are subscribed to the Google Groups "JanusGraph developer list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to janusgraph-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Jason Plurad <plu...@...>
 

Publishing the snapshot documents is a nice convenience for feature developers. I'd rather have /latest/ pointing to the latest released version (for most users, i.e. those that aren't building a distribution from source code) and perhaps /snapshot/ pointing to latest from master (for feature developers, not indexed by web crawlers).


On Tuesday, May 30, 2017 at 5:56:04 PM UTC-4, Misha Brukman wrote:
Hi Christopher,

Go ahead and make the change on the master branch, and a new build of the docs will be published as soon as it's next built for an RC or SNAPSHOT or release. 

Right now, http://docs.janusgraph.org/latest/ points to the latest one of the above, which is currently "0.2.0-SNAPSHOT" as per the pom.xml, so we could technically publish that, and link "latest" to that as the directory.

What do others developers think?

Misha

On Tue, May 30, 2017 at 5:03 PM, Christopher Quinones wrote:
Hi everyone,

I'd like to contribute a blurb onto the getting-started tutorial indicating that it's possible to use the loadWithoutMixedIndex method when using a configuration that doesn't have an index backend enabled.

Is it possible to update the tutorial without publishing a brand new release?  I noticed that the documentation referenced 0.1.1 as the latest.

Thanks!

--
You received this message because you are subscribed to the Google Groups "JanusGraph developer list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to janusgraph-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Jerry He <jerr...@...>
 

Currently the http://docs.janusgraph.org/latest/ points to 0.1.1 version,  the same as the "Documentation (0.1.1)" link on the top of the site.

I like the ideal of providing a link to the master version of the docs.  I am fine with either 'latest' pointing to the master or 'latest' pointing to the last released version.
The important thing is we have to make it obviously distinguishable on the site.

Thanks,

Jerry


Misha Brukman <mbru...@...>
 

What about changing "latest" to point to the "latest version on GitHub (master)" and "stable" (or "release", or another name) pointing to the most-recent release?

Alternatively, "latest" can point to the latest release, and "snapshot" can point to latest version on GitHub. Thoughts?

On Wed, May 31, 2017 at 1:47 PM, Jerry He <jerr...@...> wrote:
Currently the http://docs.janusgraph.org/latest/ points to 0.1.1 version,  the same as the "Documentation (0.1.1)" link on the top of the site.

I like the ideal of providing a link to the master version of the docs.  I am fine with either 'latest' pointing to the master or 'latest' pointing to the last released version.
The important thing is we have to make it obviously distinguishable on the site.

Thanks,

Jerry

--
You received this message because you are subscribed to the Google Groups "JanusGraph developer list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to janusgraph-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Jerry He <jerr...@...>
 

Hopefully everything is clear at first glance on the web site.
For example, people won't need a second look-up to know what the 'stable' is and points to which version.
If we have version 0.1.x, 0.2.x, and master, what will we provide on the web site for the docs?

Thanks.

Jerry

On Wed, May 31, 2017 at 12:36 PM, 'Misha Brukman' via JanusGraph developer list <janusgr...@...> wrote:
What about changing "latest" to point to the "latest version on GitHub (master)" and "stable" (or "release", or another name) pointing to the most-recent release?

Alternatively, "latest" can point to the latest release, and "snapshot" can point to latest version on GitHub. Thoughts?

On Wed, May 31, 2017 at 1:47 PM, Jerry He <jerr...@...> wrote:
Currently the http://docs.janusgraph.org/latest/ points to 0.1.1 version,  the same as the "Documentation (0.1.1)" link on the top of the site.

I like the ideal of providing a link to the master version of the docs.  I am fine with either 'latest' pointing to the master or 'latest' pointing to the last released version.
The important thing is we have to make it obviously distinguishable on the site.

Thanks,

Jerry

--
You received this message because you are subscribed to the Google Groups "JanusGraph developer list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to janusgraph-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

--
You received this message because you are subscribed to the Google Groups "JanusGraph developer list" group.
To unsubscribe from this group and stop receiving emails from it, send an email to janusgraph-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.


Christopher Quinones <therea...@...>
 

Here's a pull request with the documentation change I'd like to make: https://github.com/JanusGraph/janusgraph/pull/299.  It also includes an exception enhancement for the GraphOfTheGodsFactory (for the next release).

I do think it makes sense for the documentation entry-point to be the latest released version and allows users to select other stable versions we've released.  It'd be nice if we can patch the documentation to enhance it with changes that don't require a code change (like this one).


On Tuesday, May 30, 2017 at 5:51:07 PM UTC-4, Christopher Quinones wrote:
Hi everyone,

I'd like to contribute a blurb onto the getting-started tutorial indicating that it's possible to use the loadWithoutMixedIndex method when using a configuration that doesn't have an index backend enabled.

Is it possible to update the tutorial without publishing a brand new release?  I noticed that the documentation referenced 0.1.1 as the latest.

Thanks!