Skip to content

Created guide for organizing the model inventory #210

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

Conversation

noosheenv
Copy link
Contributor

Internal Notes for Reviewers

I created a guide for organizing the model inventory, like using the filter and manage columns feature. The little text in the beginning and the prerequisites feel a bit abrupt, so some advice would be appreciated!

Sneak peek:
image
image

External Release Notes

@noosheenv noosheenv added the internal Not to be externalized in the release notes label May 31, 2024
@noosheenv noosheenv requested review from nrichers and validbeck May 31, 2024 22:09
@noosheenv noosheenv self-assigned this May 31, 2024
Copy link
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.

Nice! Great to see more docs topics from you, @noosheenv. 🏅 I left some comments to address — please ask me to re-review when ready?

noosheenv and others added 3 commits June 3, 2024 09:25
Copy link
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.

Left some suggestions, I would also recommend you try commiting the online suggestions and then pulling down those changes locally before working on more edits.

@noosheenv noosheenv requested review from validbeck and nrichers June 3, 2024 20:07
@noosheenv
Copy link
Contributor Author

I made the "Working with the model inventory" as @validbeck suggested. I added gifs because I thought it would look cool but now it's so busy. But also I got attached to the gifs so it's hard to let go. ALSO I'm struggling so hard with the little description at the top. ALSO ALSO should I put the prerequisites back?

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

Forgive me if you're still working on stuff, as you got some stuff and missed others!

  • Are there prerequisites? Are there certain roles you need to work with these features? ;) (Maybe ask in #engineering?)
  • Put Register models in the inventory & Edit model inventory fields UNDER "Working with the model inventory," like how it looks in the other menus:
Screenshot 2024-06-03 at 2 50 51 PM

noosheenv and others added 7 commits June 3, 2024 15:34
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@noosheenv
Copy link
Contributor Author

Made edits mentioned in yesterday's catchup:

  • Make the accordion dropdown thing work
  • Turn Register models card into a link
  • Search, filter, and sort models → add numbered steps and turn h4s into bullet points (like first iteration)
  • What’s next should be bullet points, not cards
  • Check which roles can do the stuff in the guides
    • any role as long as they have stuff in the inventory
  • Customize model inventory layout goes into its own page and will get mentioned in What's next
    • Use numbered steps starting with log in to platform ui

@noosheenv noosheenv requested a review from validbeck June 4, 2024 17:36
Copy link
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.

Working with the model inventory

  • Nice job wrapping the sub-articles under this landing page! 🎉
  • The intro is a bit better, but it still needs some more pep. I've noticed that sometimes your descriptions are a bit fluffy, and that's very common! The only way to get good at writing is just to keep doing it, make many mistakes so you can learn, and practicing more until we get better :) When we describe things, we want to bring value to the user, i.e. what benefit does the feature offer users on top of a summary of the basic functionality?

See Working with documentation templates for some inspiration and an example of what I'm talking about. For this I'd recommend doing some reading as to why model inventories are important to MRM.

  • You're missing some important info about how sorting and customization works – see if you can figure it out when you re-read the Shortcut Story (you are reading the comments/discussion on a Story before you start working, right? ;)). I'd recommend a call-out box for this.
  • As this is a landing page, let's change the "What's next" section back to the CTA cards (sorry!)

Register models in the inventory

  • For the If the model is a vendor model, toggle Is Vendor Model and provide the vendor name. line, I'd just remove the link within the sentence here and put a callout box with a link under this step something to the effect of "Learn more about vendor models."

Customize model inventory layout

You probably want a callout box here as well under the intro for that important detail when you find it ;)

  • For "Steps," I would just wrap Manage columns into the step-by-step and remove the subheader for this section. You may want to make sure that your step has a note that you need to be in Display table view.
  • Make sure your screenshots have appropriate white-space before and after, as the gifs on this page are bumping right up against the text.
  • For "Toggle card and table view" I would just remove the gif and section and make this a callout, something along the lines of: To display the inventory in list view, click ** Display table**. To display the inventory in card view, click **Display cards**. Remember: we're looking to simplify, not overcomplicate.

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@validbeck validbeck self-requested a review June 5, 2024 18:19
Copy link
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.

As much as I'd like to keep #validpride... otherwise, looks great! I think I do like the callout at the top of the "Customize" page, it's further away enough from the other one that it shouldn't be a problem.

noosheenv and others added 3 commits June 5, 2024 11:27
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@noosheenv noosheenv requested a review from validbeck June 5, 2024 18:32
Copy link
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.

Just one last tweak — you can use the Commit suggestion button then go ahead and merge into main!! 🎉

Co-authored-by: Beck <164545837+validbeck@users.noreply.github.com>
@noosheenv noosheenv merged commit fff6bec into main Jun 5, 2024
2 checks passed
@noosheenv noosheenv deleted the noosheenvazinkhoo/sc-3668/model-inventory-findings-manage-columns branch June 5, 2024 18:38
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