-
Notifications
You must be signed in to change notification settings - Fork 447
Updating documentation links to new URLs #2325
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please run make prettify
in portal-ui folder
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
These look good, but I do have some questions for engineering on whether we can go a little farther.
? "https://docs.min.io/minio/k8s/operator-console/operator-console.html?ref=con" | ||
: "https://docs.min.io/minio/baremetal/console/minio-console.html?ref=con"; | ||
? "https://min.io/docs/minio/kubernetes/upstream/operations/install-deploy-manage/minio-operator-console.html?ref=con" | ||
: "https://min.io/docs/minio/kubernetes/upstream/administration/minio-console.html?ref=con"; |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if my reading of this logic statement is correct, we should point to the Linux docs for this, as its not an Operator installation (and therefore we can assume baremetal/Linux)
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It is worth asking - if we can use this logic consistently, then for any given docs link, we can correctly send a user to either the Kubernetes documentation or our Linux documentation, ensuring that they see the most relevant tutorial (there might be slight differences between the two).
This is a much larger lift from an engineering perspective, but its worth asking.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Updating line 489 to point to Linux.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes @ravindk89, we have the isOperator flag available to render the correct menu & logos for the application. this can be used to render the correct links for documentation in case a component is shared between Console & Operator Console
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@bexsoft We should use this going forward, then. Operator points to kubernetes/upstream and Console points to linux.
211d100
to
f697603
Compare
Was pointing to kubernetes/upstream. Now points to linux. Co-authored-by: Alex <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM
The new doc site has launched, and all docs have new URLs.
This PR updates the documentation URLs in the Console to point to the new locations.