Skip to content

[Enhancement] Getting started guide for admins starting from scratch #344

Open
@ryanvanasse

Description

@ryanvanasse

Summary

Our existing getting started guide does a good job of explaining the install to a user who either has Python already installed or is already familiar with installing Python. However, many of the admins who use these tools do not have this experience and are starting "from scratch." It would be helpful to provide a general overview or links to how to install and any other configuration requirements that they need (e.g. Configuring the Path on Windows)

Proposed Change

I can see two ways that this could go:

  1. We add a few notes to the existing getting started guide:
    • In the Installation section, we link out to instructions for installing Python on Windows, Mac, and Linux
    • We also include a note that in order to run the code42 command, your scripts location needs to be in the Path—and link out to some information on how to do this
  2. Have a separate guide which has some more details (maybe even screenshots?) about how to do this.
    • I agree that we don't want to reinvent the wheel here, so we could still make use of linking out for more specific install instructions
    • But we don't even have a note about it needing to be in the user's path, or anything that is geared towards the typical Code42 user rather than a user who is very familiar with running scripts and CLIs already.

Intended Use Case

Many Code42 admins don't have the most experience with python scripting, CLI tools or similar. Code42 TAMs, PS, and support is having to walk them through installing python, then the cli, then making other configuration changes to ensure that we can get them to the point of using it as a cli tool.

Providing more of a step-through walkthrough would allow some users to fully self-service, while others would find it easier to follow along with their Code42 support tech, which would reduce the frustration and friction with using this tool and create a better experience of Code42's product and support.

Metadata

Metadata

Assignees

No one assigned

    Labels

    enhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions