Skip to content

Conversation

@andrii-kysylevskyi
Copy link
Contributor

@andrii-kysylevskyi andrii-kysylevskyi commented Nov 6, 2025

This is an addition of the documentation aspects missed in the previous PR here

I am not sure about one thing @elahrvivaz has mentioned about stable vs latest versions of the docs.

The URLs in README seem to point to /documentation, which is redirected to /stable version.
While Scylla docs might not be in the stable version as it is getting deployed to /latest instead.

Emilio, do you think this could cause issues and, if yes, then how would you recommend to proceed? Somehow deploy to stable or point the URL to the latest instead? Thanks a lot in advance!

@elahrvivaz
Copy link
Contributor

hmm good question - we can't easily go back and update 'stable' since that's built off a tag. we could back-port it for the next bug-fix release, but I don't have any planned imminently. we could point it at 'latest', but it's not going to be a smooth experience for less technical users (since there are references to releases and such that don't exist yet). or we could hold off on merging the README changes until closer to the release. what would be your preference?

@elahrvivaz
Copy link
Contributor

I might also prefer to change the individual quickstart links to a single link pointing to https://www.geomesa.org/documentation/stable/tutorials/index.html#quick-starts so we don't have to keep them in sync. that would solve the issue of merging this now, although the tutorial would still not be available on stable.

@andrii-kysylevskyi
Copy link
Contributor Author

I might also prefer to change the individual quickstart links to a single link pointing to https://www.geomesa.org/documentation/stable/tutorials/index.html#quick-starts so we don't have to keep them in sync. that would solve the issue of merging this now, although the tutorial would still not be available on stable.

Great point on the quick-starts, it does feel like a better way for sure. Happy to do it here if that's okay, or can open a separate PR.

hmm good question - we can't easily go back and update 'stable' since that's built off a tag. we could back-port it for the next bug-fix release, but I don't have any planned imminently. we could point it at 'latest', but it's not going to be a smooth experience for less technical users (since there are references to releases and such that don't exist yet). or we could hold off on merging the README changes until closer to the release. what would be your preference?

Regarding the stable vs latest, on one hand, ScyllaDB seems to be supported by the stable version, so it would make sense to tell users that. Also, I am still struggling to find the latest link somewhere (you mentioned it was on the home page, but I didn't see it there). So far, I could only open it by modifying the URL. So it might be hard for others as well to find the reference to those docs (unless it is just me).

Would you consider mentioning the latest documentation in a README file, maybe? (unless I missed it and it's already there)

@elahrvivaz
Copy link
Contributor

Oh by the homepage I meant geomesa.org:
image

[Accumulo](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-accumulo.html) |
[HBase](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-hbase.html) |
[Cassandra](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-cassandra.html) |
[ScyllaDB](https://www.geomesa.org/documentation/tutorials/geomesa-quickstart-scylladb.html) |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How does this look?
image

<b>[Documentation](https://www.geomesa.org/documentation/) | [Upgrade Guide](https://www.geomesa.org/documentation/user/upgrade.html) | [Quick Starts](https://www.geomesa.org/documentation/stable/tutorials/index.html#quick-starts) | [Tutorials](https://www.geomesa.org/tutorials/) | [Nightly snapshots](https://geomesa.org/documentation/latest/)</b>

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants