Skip to content

Conversation

djwfyi
Copy link
Contributor

@djwfyi djwfyi commented Sep 20, 2022

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.

@djwfyi djwfyi requested review from dvaldivia and bexsoft September 20, 2022 22:45
@djwfyi djwfyi assigned ravindk89 and unassigned ravindk89 Sep 20, 2022
@djwfyi djwfyi requested a review from ravindk89 September 20, 2022 22:45
@bexsoft bexsoft requested a review from cniackz September 20, 2022 23:10
Copy link
Collaborator

@bexsoft bexsoft left a 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

ravindk89
ravindk89 previously approved these changes Sep 21, 2022
Copy link
Contributor

@ravindk89 ravindk89 left a 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";
Copy link
Contributor

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)

Copy link
Contributor

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.

Copy link
Contributor Author

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.

Copy link
Collaborator

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

Copy link
Contributor Author

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.

Was pointing to kubernetes/upstream.
Now points to linux.

Co-authored-by: Alex <[email protected]>
Copy link
Collaborator

@bexsoft bexsoft left a comment

Choose a reason for hiding this comment

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

LGTM

@harshavardhana harshavardhana merged commit bebe860 into master Sep 23, 2022
@harshavardhana harshavardhana deleted the documentation-links branch September 23, 2022 05:37
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.

4 participants