layer5io / docs

Documentation and Developer resources for Layer5 products
https://docs.layer5.io
Apache License 2.0
26 stars 72 forks source link

[Docs] Hyperlink each Role name from Permissions Reference page to Roles page #321

Closed jameshorton2337 closed 3 weeks ago

jameshorton2337 commented 1 month ago

Current State

This page lists permissions for each role, but doesn't offer a link to each role description - https://docs.layer5.io/cloud/reference/default-permissions/

Desired State

Hyperlink each Role name from Permissions Reference page to Roles page


Contributor Guides and Resources

leecalcote commented 1 month ago

@dragon-slayer875

leecalcote commented 1 month ago

Not @dragon-slayer875 😒

SAHU-01 commented 1 month ago

May I work on this?

iushdoescode commented 1 month ago

Hi lee, I would like to work on the issue. Could you please assign this task to me? Thank you!

SAHU-01 commented 1 month ago

@leecalcote and @jameshorton2337 a quick clarification here, Let's say to hyperlink Workspace Admin role in the column which link should I use?

  1. https://docs.layer5.io/cloud/security/roles/workspace-roles/ or
  2. https://docs.layer5.io/cloud/security/roles/#workspace-roles
image
dragon-slayer875 commented 1 month ago

@leecalcote and @jameshorton2337 a quick clarification here, Let's say to hyperlink Workspace Admin role in the column which link should I use?

  1. https://docs.layer5.io/cloud/security/roles/workspace-roles/ or
  2. https://docs.layer5.io/cloud/security/roles/#workspace-roles
image

https://docs.layer5.io/cloud/security/roles/workspace-roles/

SAHU-01 commented 1 month ago

@dragon-slayer875 for user which hyperlink should I use? I mapped the rest but couldn't figure out what would be best for user

dragon-slayer875 commented 1 month ago

Ah. We are missing a page for the user role. You can raise a PR in the meantime, I will see to it that it is added by tomorrow.

SAHU-01 commented 1 month ago

@leecalcote and @dragon-slayer875 is this the desired functionality?

https://github.com/user-attachments/assets/84a675d6-7d01-4268-afcb-74bdf3aad5aa

or should clicking the role name open the hyperlink in a new tab like this?

https://github.com/user-attachments/assets/b34ce234-816a-4ddc-8b4a-73e713529b55

dragon-slayer875 commented 1 month ago

@leecalcote and @dragon-slayer875 is this the desired functionality?

option1.mov or should clicking the role name open the hyperlink in a new tab like this?

option2.mov

Opening the link in a new tab makes sense to me since people will be able to read the descriptions and understand them in reference to the permissions table side by side.

leecalcote commented 4 weeks ago

@leecalcote and @dragon-slayer875 is this the desired functionality? option1.mov or should clicking the role name open the hyperlink in a new tab like this? option2.mov

Opening the link in a new tab makes sense to me since people will be able to read the descriptions and understand them in reference to the permissions table side by side.

Let's stick with only targeting a new window/tab for links external to the site. Otherwise, all links under docs.layer5.io should open in the same window.