argo-cd icon indicating copy to clipboard operation
argo-cd copied to clipboard

feat(UI): Added link for docs to add clusters

Open surajyadav1108 opened this issue 11 months ago • 5 comments

part of #14170

Screenshot 2024-03-05 004244

Checklist:

  • [ ] Either (a) I've created an enhancement proposal and discussed it with the community, (b) this is a bug fix, or (c) this does not need to be in the release notes.
  • [x] The title of the PR states what changed and the related issues number (used for the release note).
  • [x] The title of the PR conforms to the Toolchain Guide
  • [x] I've included "Closes [ISSUE #]" or "Fixes [ISSUE #]" in the description to automatically close the associated issue.
  • [ ] I've updated both the CLI and UI to expose my feature, or I plan to submit a second PR with them.
  • [ ] Does this PR require documentation updates?
  • [ ] I've updated documentation as required by this PR.
  • [ ] I have signed off all my commits as required by DCO
  • [ ] I have written unit and/or e2e tests for my change. PRs without these are unlikely to be merged.
  • [ ] My build is green (troubleshooting builds).
  • [ ] My new feature complies with the feature status guidelines.
  • [ ] I have added a brief description of why this PR is necessary and/or what this PR solves.
  • [ ] Optional. My organization is added to USERS.md.
  • [ ] Optional. For bug fixes, I've indicated what older releases this fix should be cherry-picked into (this may or may not happen depending on risk/complexity).

surajyadav1108 avatar Mar 04 '24 19:03 surajyadav1108

Thanks! I agree that link out to the docs will be useful.

However, I think the UX for this is a little confusing. IMHO, the button looks like it would do something within Argo CD, even when there's an "external link" symbol in the button. It reads "Add new cluster", so I would not expect that button to link out to the docs but get me to a dialogue to add the cluster.

Maybe it's just a matter of the icon used, but I'm not sure.

had the same thought with the plus icon that's why changed it to external link Icon but wasn't really sure on what should be the title in short so left it as add new cluster. would this title be okay "Docs: how to add more clusters?"

ok I think this is self explanatory Screenshot 2024-03-05 110009

surajyadav1108 avatar Mar 05 '24 05:03 surajyadav1108

@surajyadav1108 That's better, I stalled reviewing this PR because I was looking for other examples where we link to documentation and can't find any. I think it's a good idea to add some documentation links but maybe it's in an (i) box or something @ishitasequeira wdyt?

The area where it's placed here is typically for buttons that do something on the screen.

todaywasawesome avatar Mar 05 '24 17:03 todaywasawesome

Right now we show the docs as a button in the documentation section but I think having the button for cluster docs looks confusing to me. Screenshot 2024-03-05 at 9 34 47 AM @surajyadav1108 Would it be better to have a banner with the text for users to refer to the CLI document to add clusters. If you want to keep the same UX then I'd suggest you use a different icon. Check this link for any free icons that better fit. https://fontawesome.com/search?q=document&o=r

ashutosh16 avatar Mar 05 '24 17:03 ashutosh16

@ashutosh16 Yes you are correct. Should have looked into side panel this makes much more sense. Screenshot 2024-03-06 125102

surajyadav1108 avatar Mar 06 '24 07:03 surajyadav1108

@surajyadav1108 I think it would be better to add a banner on the clusters page rather than adding a sub-link of docs on the documentation page. WDYT?

@ishitasequeira Like this big banner but on the clusters page where the button is? it might look unplaced. or do you have any idea on how it should look on the clusters page?.

surajyadav1108 avatar Mar 07 '24 18:03 surajyadav1108

What do you think of something like your Docs button, but instead making it a button format, center-align , make it a text (for example Refer documentation for adding clusters) and add the link to the docs on the documentation word.

@ishitasequeira got some time finally

Screenshot 2024-03-19 225452 Screenshot 2024-03-19 225513

surajyadav1108 avatar Mar 19 '24 17:03 surajyadav1108