Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
michaelkremmel opened this issue Nov 22, 2023 · 5 comments
Open
Labels
bug Something isn't working

Comments

@michaelkremmel
Copy link

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 amotl transferred this issue from crate/crate-howtos Feb 20, 2024
@amotl
Copy link
Member

amotl commented Feb 20, 2024

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
Copy link
Author

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
Copy link
Member

amotl commented Feb 26, 2024

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
Copy link
Author

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
Copy link
Member

amotl commented Feb 26, 2024

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

@amotl amotl added the bug Something isn't working label Feb 26, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants