Skip to content

[Draft] First version of M1 create workspace quickstart #339

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

dayleparker
Copy link
Collaborator

@dayleparker dayleparker commented Apr 23, 2025

Initial edits for Create & manage workspaces quick start.

Summary by Sourcery

Update the Insights Inventory Workspace quickstart documentation to provide clearer, more detailed guidance on creating, managing, and working with workspaces.

New Features:

  • Add prerequisites section to clarify user permissions
  • Enhance workspace creation instructions with more detailed steps

Enhancements:

  • Improve task descriptions with more precise navigation instructions
  • Add more descriptive explanations about workspace purpose and usage

Documentation:

  • Revise the quickstart guide for Insights Inventory Workspaces to improve clarity, add more specific instructions, and provide more context about workspace functionality

@dayleparker dayleparker added documentation Improvements or additions to documentation do not merge labels Apr 23, 2025
@app-sre-bot
Copy link
Collaborator

Can one of the admins verify this patch?

Copy link

sourcery-ai bot commented Apr 23, 2025

Reviewer's Guide by Sourcery

This pull request introduces the first version of the M1 create workspace quickstart. It includes updates to the metadata, introduction, and task instructions for creating and managing workspaces. The quick start guides users through creating a workspace, adding systems to it, and removing systems from it.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated the quick start metadata, including display name, duration, type, and icon.
  • Updated the display name to 'Creating and managing workspaces'.
  • Set the duration to 5 minutes.
  • Specified the type as 'Quick start' with a green color.
  • Updated the icon with a base64 encoded SVG.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Introduced prerequisites for the quick start.
  • Added a prerequisite that the user must be an Organization Administrator or have Workspace administrator permissions.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Revised the introduction and description to better explain workspaces.
  • Reworded the introduction to emphasize the flexible and hierarchical approach of workspaces.
  • Added a callout to configure workspaces to organize systems in inventory.
  • Modified the list of tasks to be performed in the quick start.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Refactored the 'Create a workspace' task instructions.
  • Updated the navigation path to Workspaces.
  • Revised the steps for creating a workspace, including entering a name and description.
  • Added a note about the parent workspace setting.
  • Updated the review instructions and failed task help.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Modified the 'Add systems to a workspace' task instructions.
  • Explained how assigning systems to workspaces allows configuring access control.
  • Clarified the two methods for adding systems: from the workspace details page or the Systems list.
  • Simplified the steps for adding systems from the Systems list.
  • Added a note about selecting systems that already belong to a workspace.
  • Updated the review instructions and failed task help.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Updated the 'Remove systems from a workspace' task instructions.
  • Simplified the steps for removing systems from a workspace.
  • Removed the mention of a modal opening after selecting systems.
  • Updated the review instructions and failed task help.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml
Revised the conclusion of the quick start.
  • Updated the concluding statement.
  • Added a placeholder for additional content.
  • Kept the link to open a support case.
docs/quickstarts/insights-inventory-workspace/insights-inventory-workspace.yaml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @dayleparker - I've reviewed your changes - here's some feedback:

Overall Comments:

  • Consider adding a diagram or visual aid to illustrate the workspace hierarchy and system relationships.
  • Ensure that the steps provided are consistent with the latest UI changes to avoid user confusion.
Here's what I looked at during the review
  • 🟡 General issues: 2 issues found
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

Welcome to the quick start for creating and managing your systems using Workspaces. In this quick start, you will:
Welcome to the quick start for creating and managing workspaces. Workspaces provide a flexible, hierarchical approach to organizing your assets and streamline user access.

Configure workspaces to organize systems in your inventory to... (EDIT)
Copy link

Choose a reason for hiding this comment

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

question: Placeholder text remains in the introduction.

Consider replacing the placeholder with finalized content to ensure users receive clear instructions.

<h4><b>Thank you for taking the time to explore this feature!</b></h4>
<h4><b>Thank you for taking the time to explore workspaces!</b></h4>

EDIT: What should we say here?
Copy link

Choose a reason for hiding this comment

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

question: Placeholder in the conclusion section.

Replace or remove the placeholder text with the intended final message before merging.

@dayleparker dayleparker force-pushed the HCCDOC-3770-createworkspace branch from f508ead to aa2c7dd Compare April 24, 2025 11:47
@dayleparker dayleparker force-pushed the HCCDOC-3770-createworkspace branch from aa2c7dd to 4728f73 Compare May 14, 2025 14:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
do not merge documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants