Skip to content

Updated docs for roles and permissions#219

Merged
noosheenv merged 13 commits intomainfrom
noosheenvazinkhoo/sc-4437/documentation-design-settings-permissions
Jun 20, 2024
Merged

Updated docs for roles and permissions#219
noosheenv merged 13 commits intomainfrom
noosheenvazinkhoo/sc-4437/documentation-design-settings-permissions

Conversation

@noosheenv
Copy link
Copy Markdown
Contributor

Internal Notes for Reviewers

I updated the docs for Roles and Permissions to align with the UI:

  • Split manage-roles-and-permissions.qmd into manage-roles.qmd and manage-permissions.qmd
  • Updated the sources to match the names: _manage-roles.qmd and _manage-permissions.qmd from the really long name before
  • Removed the "Add roles" section as the feature will not be implemented for the next 3 sprints.
  • Tested the old steps and modified them to match the current UI
  • Changed the prerequisites from Superuser or Group Admin to Customer Admin for accuracy

I would love some opinions and advice, especially for:

  • Differentiating intros for the pages (currently just copied from the old doc)
  • Since splitting means file name changes, references to the old doc in the Customer Admin training were updated.
  • The last step for Manage roles, "6. Select Users to manage users assigned to the role."
    • I've been undecided on the wording, between "users with the role", "users under the role", and others.

External Release Notes

@noosheenv noosheenv added the internal Not to be externalized in the release notes label Jun 18, 2024
@noosheenv noosheenv requested review from nrichers and validbeck June 18, 2024 21:11
@noosheenv noosheenv self-assigned this Jun 18, 2024
Copy link
Copy Markdown
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

A general comment about PRs, I would recommend providing screencaps for "before" or "after" especially for sections of the docs site – not everyone knows immediately where to look for the changes if they're not clearly indicated, and sometimes PRs may need to be reviewed by folks not on the docs team.

Global comments

  • needs moar context
  • we want some step-by-step

Onboarding users

Since Onboarding users is technically a landing page with subpages, I would put a "What's next" section down at the bottom with the title cards from this section! You might need to edit the summaries so they look good on the CTA. ;)

Manage roles

There's another catch (edge-case) here I think is worth noting on this page for users – take a look at the UI again and see if you can figure out what it is.

Training for administrators

Please check http://localhost:7503/training/training-for-administrators.html#/section-6 (or similar) if this still makes sense

That's YOUR local URL, won't work for anyone else. I would recommend linking to the line in the code of your branch. e.g. "Refer to site/training/training-for-administrators.qmd"

Role name cleanup

Changed the prerequisites from Superuser or Group Admin to Customer Admin for accuracy

I would also make sure all OTHER instances of referring to a superuser or group admin are removed on the other docs.

Copy link
Copy Markdown
Collaborator

@nrichers nrichers left a comment

Choose a reason for hiding this comment

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

Another great PR from you, @noosheenv! Don't let the comments from Beck and I distract from this — our comments are made through the lens of people who look at instructions every day. (Also, I'm never quite sure if the "we" in Beck's comments is the royal form or just a generic reference. 😛 )

Differentiating intros for the pages (currently just copied from the old doc)

My recommendation would be to rewrite both of these without the added These steps guide you through the process of ... as that's just verbiage you have to wade through. Be direct and tell the reader they are doing (or, as Beck would say, write in the imperative.)

For context, I've gradually been removing similar extra verbiage in other topics as it's unnecessary. For topics that get included as content tiles on listing pages, it generally also just looks off because it's so repetitive. Similarly, the extra verbiage affects what you see in search results.

Since splitting means file name changes, references to the old doc in the Customer Admin training were updated.

I checked and the training looks correct, very nice.

@noosheenv noosheenv requested a review from validbeck June 20, 2024 17:39
@noosheenv noosheenv changed the title WIP - Updated docs for roles and permissions Updated docs for roles and permissions Jun 20, 2024
@noosheenv noosheenv requested a review from nrichers June 20, 2024 18:07
noosheenv and others added 2 commits June 20, 2024 11:18
Copy link
Copy Markdown
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

@noosheenv Much better! In the interest of time I just made the following edits for you:

  • Important callouts should go BEFORE the thing they're warning about changing, generally.
  • You still need to break instructions down more granularly. See the changes I made in "Manage roles" as to what I'm talking about. Anything that is a SEPARATE task should have it's own (sub-)section, and preliminary directions, unless it's something small like a add/edit menu that looks exactly the same, just opened with a slightly different button.
  • When you're writing and editing instructions, make sure you're reviewing them for correct emphasis and so on as per the style guide (see the changes in "Manage permissions").
Manage roles Manage permissions
Screenshot 2024-06-20 at 11 34 11 AM Screenshot 2024-06-20 at 11 33 55 AM

We can leave the changes to the group admin/superuser for another Story (please make that Story now if you haven't, and link it to this existing Story via the related Stories), but I'd like you to quickly add the What's next section at the bottom of the "Onboarding users" landing page before calling this one completed. You may need to edit the CTAs so that the cards look pretty.

@validbeck validbeck force-pushed the noosheenvazinkhoo/sc-4437/documentation-design-settings-permissions branch from 10190e9 to 8ca5168 Compare June 20, 2024 18:41
@noosheenv
Copy link
Copy Markdown
Contributor Author

Thanks for making those changes! I made the new story and linked it to this one.

I added the What's next, cards, and deleted the example section (even though I should've saved it for the other story, I just couldn't stand it LMAO.)

I edited the CTAs to look like the other landing pages, not sure if that means it's pretty enough though.

@noosheenv noosheenv requested a review from validbeck June 20, 2024 19:00
Copy link
Copy Markdown
Collaborator

@validbeck validbeck left a comment

Choose a reason for hiding this comment

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

@noosheenv Oops, sorry, I just realised my push alias is a force push, I didn't mean to write over you pulling in things from main! MB there.

  • Thank you for removing the example, and adding the "What's next" section!
  • The CTAs/summaries still need a lot of love... for example, "Manage users" trails off and is the clunkiest most roundabout lil thing ever! Make sure these descriptions are under the character limit, and let's just take out the "This task topic will ..." as this is a needlessly roundabout way to talk about something. Just state what's involved without the fluff. Summarising is also GREAT writing practice. ;) Following the rules for active voice and direct language, I'd include (not necessarily in the same order every time, play around with sentence structure):
    • In x context
    • Do y task
    • Because z value
  • There's also some accuracy issues now that we've moved some of the information under this section around, so pay attention to what you're actually summarizing.

e.g.

Invite new users and assign users to specific groups and roles to maintain access control and efficient user management within your organization via the {{< var vm_platform >}}.

@noosheenv
Copy link
Copy Markdown
Contributor Author

noosheenv commented Jun 20, 2024

image Thanks for the template, it really helped! I used chatGPT by pasting in the contents of the guide, then asked it to make an intro for that feature, which helped for accuracy. Then, I edited it to follow the guidelines given above.

From here, further changes to other guides' CTA's may be out of the scope of this roles/permissions PR, and it may be best to tack it onto the other story we created.

@validbeck
Copy link
Copy Markdown
Collaborator

@noosheenv I just pushed a quick edit for the summaries, but otherwise it does look good to go (no further changes required from your end)!

@noosheenv noosheenv merged commit 5621c1f into main Jun 20, 2024
@noosheenv noosheenv deleted the noosheenvazinkhoo/sc-4437/documentation-design-settings-permissions branch June 20, 2024 21:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

internal Not to be externalized in the release notes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants