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.

Sign up for GitHub

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

Jump to bottom

Dead links in README.md for 1.15 release #2270

Open
grzywin opened this issue Dec 16, 2024 · 7 comments · May be fixed by #2293
Open

Dead links in README.md for 1.15 release #2270

grzywin opened this issue Dec 16, 2024 · 7 comments · May be fixed by #2293
Assignees
@tnozicka
Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.

Comments

@grzywin
Copy link

grzywin commented Dec 16, 2024 •
edited
Loading

What happened?

Below files are missing in 1.15 and hyperlinks to them from README.md page are throwing 404 error:
v1.15/docs/source/releases.md

  • v1.15/docs/source/generic.md
  • v1.15/docs/source/eks.md
  • v1.15/docs/source/gke.md
  • v1.15/docs/source/contributing.md

Also, "Slack" link is moving us here: https://scylladb-users-slackin.herokuapp.com/ ("There's nothing here, yet.")

What did you expect to happen?

Links should be working and pointing us to correct pages.

How can we reproduce it (as minimally and precisely as possible)?

Go to 1.15 Readme page and try to open some of the hyperlinks listed above.

Scylla Operator version

1.15

Kubernetes platform name and version

N/A

Please attach the must-gather archive.

N/A

Anything else we need to know?

No
@grzywin grzywin added the kind/bug Categorizes issue or PR as related to a bug. label Dec 16, 2024
@scylla-operator-bot scylla-operator-bot bot added the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Dec 16, 2024
@tnozicka tnozicka added the priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. label Dec 16, 2024
@scylla-operator-bot scylla-operator-bot bot removed the needs-priority Indicates a PR lacks a `priority/foo` label and requires one. label Dec 16, 2024
@ylebi ylebi mentioned this issue Dec 16, 2024
Closed
@dallinwright-tradecrit
Copy link

I can't even find the install instructions either in this repo or the actual website for the operator install, I can't even install/get started

@mykaul
Copy link
Contributor

mykaul commented Dec 26, 2024

@dallinwright-tradecrit - https://operator.docs.scylladb.com/stable/installation/overview

@mykaul
Copy link
Contributor

mykaul commented Dec 26, 2024

@grzywin - what's not working for you?
https://operator.docs.scylladb.com/stable/installation/kubernetes/eks.html shows me:

Image

mykaul added a commit to mykaul/scylla-operator that referenced this issue Dec 26, 2024
@mykaul
README.md: fix quickstart links
a3853ac 
Fixes: scylladb#2270
Signed-off-by: Yaniv Kaul <[email protected]>
@mykaul mykaul linked a pull request Dec 26, 2024 that will close this issue
Open
@mykaul
Copy link
Contributor

mykaul commented Dec 26, 2024

Contributing document got lost as part of the documentation uplift, unsure why. The quick links to generic/EKS/GKE just moved - unsure if my PR fixes it properly!

@mykaul
Copy link
Contributor

mykaul commented Dec 26, 2024

The support matrix link is also not working, due to the same issue.

mykaul added a commit to mykaul/scylla-operator that referenced this issue Dec 26, 2024
@mykaul
README.md: fix quickstart links
e2326d2 
Fixes: scylladb#2270
Signed-off-by: Yaniv Kaul <[email protected]>
mykaul added a commit to mykaul/scylla-operator that referenced this issue Dec 26, 2024
@mykaul
README.md: fix quickstart links
3afc882 
Fixes: scylladb#2270
Signed-off-by: Yaniv Kaul <[email protected]>
@mykaul
Copy link
Contributor

mykaul commented Dec 26, 2024

The support matrix link is also not working, due to the same issue.

Hopefully addressed this as well as the Slack link.

mykaul added a commit to mykaul/scylla-operator that referenced this issue Dec 26, 2024
@mykaul
README.md: fix quickstart links
290bacb 
Fixes: scylladb#2270

In addition, renamed Scylla to ScyllaDB when needed.

Signed-off-by: Yaniv Kaul <[email protected]>
@grzywin
Copy link
Author

grzywin commented Dec 27, 2024

@grzywin - what's not working for you?

I meant links from README.md. They are pointing to incorrect URLs inside docs/source folder, e.g. https://github.com/scylladb/scylla-operator/blob/v1.15/docs/source/gke.md
but from what I saw you already updated them in your PR to correct ones, e.g.:
https://github.com/scylladb/scylla-operator/blob/v1.15/docs/source/installation/kubernetes/gke.md
but I guess you figured this out and already fixed it in your PR.

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

@tnozicka tnozicka

Labels
kind/bug Categorizes issue or PR as related to a bug. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release.
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

README.md: fix quickstart links mykaul/scylla-operator
4 participants
@mykaul @tnozicka @grzywin @dallinwright-tradecrit