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.

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

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

Closed
jameshorton2337 opened this issue Jul 11, 2024 · 11 comments · Fixed by #338
Closed
Assignees
Labels
area/docs Improvements or additions to documentation area/identity Orgs, Teams, Users area/security Roles, Tokens, Keychains, Keys framework/hugo good first issue Good for newcomers help wanted Extra attention is needed language/markdown

Comments

@jameshorton2337
Copy link
Contributor

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

@jameshorton2337 jameshorton2337 added area/docs Improvements or additions to documentation framework/hugo language/markdown labels Jul 11, 2024
@leecalcote leecalcote added area/identity Orgs, Teams, Users help wanted Extra attention is needed area/security Roles, Tokens, Keychains, Keys labels Jul 11, 2024
@leecalcote
Copy link
Member

@dragon-slayer875

@leecalcote leecalcote added the good first issue Good for newcomers label Jul 19, 2024
@leecalcote
Copy link
Member

Not @dragon-slayer875 😢

@SAHU-01
Copy link
Contributor

SAHU-01 commented Jul 20, 2024

May I work on this?

@iushdoescode
Copy link
Contributor

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

@SAHU-01
Copy link
Contributor

SAHU-01 commented Jul 20, 2024

@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
Copy link
Contributor

@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
Copy link
Contributor

SAHU-01 commented Jul 20, 2024

@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
Copy link
Contributor

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
Copy link
Contributor

SAHU-01 commented Jul 20, 2024

@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

@dragon-slayer875
Copy link
Contributor

@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
Copy link
Member

@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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/docs Improvements or additions to documentation area/identity Orgs, Teams, Users area/security Roles, Tokens, Keychains, Keys framework/hugo good first issue Good for newcomers help wanted Extra attention is needed language/markdown
5 participants