crate / cratedb-guide

The CrateDB Guide.
https://cratedb.com/docs/guide/
Apache License 2.0
0 stars 0 forks source link

Documentation feedback on /docs/getting-started/first-use.rst #28

Open michaelkremmel opened 10 months ago

michaelkremmel commented 10 months ago

Documentation feedback


The first link behind "installed and running" doesn't make a lot of sense to me. Shouldn't that maybe link to https://cratedb.com/docs/crate/tutorials/en/latest/ instead?

amotl commented 7 months ago

Hi Michael,

thanks for your report. While I don't know what is wrong over there, at the new location, the link is apparently correct, see https://cratedb.com/docs/guide/getting-started/introduction.html.

With kind regards, Andreas.

michaelkremmel commented 7 months ago

Hi Andreas, I had a look at it on Friday last week and was confused since it showed the same content on both locations, and I wasn't sure what the plan was there. Now the legacy version is offline and results in a 404 error message. Shouldn't there be redirects created in order to avoid that happening?

amotl commented 7 months ago

Hi again,

I had a look at it on Friday last week and was confused since it showed the same content on both locations, and I wasn't sure what the plan was there.

cratedb-guide will be the new thing.

Now the legacy version is offline and results in a 404 error message.

I don't see where the legacy version isn't available. The corresponding spot on the new location has been refactored and is now located at https://cratedb.com/docs/guide/getting-started.html.

Shouldn't there be redirects created in order to avoid that happening?

The new version isn't live yet, so refactoring work on it does not require any updates to web server redirects.

With kind regards, Andreas.

michaelkremmel commented 7 months ago

Sorry, I've must have confused the links. But to summarize, did I understand it correctly this way?

  1. https://cratedb.com/docs/crate/howtos/en/latest/getting-started/first-use.html is live but contains the wrong link
  2. https://cratedb.com/docs/guide/getting-started.html is the new version and is not live yet
  3. https://cratedb.com/docs/guide/getting-started/introduction.html is a 404 on my end.

If so, when is the plan that 2 is going to be live? Depending on the timeline, would it make sense to simply correct the link on 1 in the meantime since this has already been reported 3 months ago?

amotl commented 7 months ago

All yes! The »going live« of The CrateDB Guide is around the corner, but any fixes to the previous content are always appreciated.