Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Update Quickstart guide with troubleshooting tips #518

Merged
merged 1 commit into from
Feb 14, 2022

Conversation

stacimc
Copy link
Contributor

@stacimc stacimc commented Feb 14, 2022

Fixes

Fixes #517

Description

Updates the Quickstart docs to include some helpful troubleshooting tips already included in the top level README. This just makes it a little bit easier to find tips for common issues you might encounter while running the Quickstart instructions.

Testing Instructions

  • With this branch checked out, run just sphinx-live to run the live-reload server for the Sphinx docs
  • Visit http://localhost:3000/guides/quickstart.html and check out the new Troubleshooting section.

Screen Shot 2022-02-14 at 2 28 01 PM

Checklist

  • My pull request has a descriptive title (not a vague title like Update index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@stacimc stacimc added 🟩 priority: low Low priority and doesn't need to be rushed 🛠 goal: fix Bug fix 📄 aspect: text Concerns the textual material in the repository labels Feb 14, 2022
@stacimc stacimc requested a review from a team as a code owner February 14, 2022 22:28
@stacimc stacimc self-assigned this Feb 14, 2022
Copy link
Contributor

@sarayourfriend sarayourfriend left a comment

Choose a reason for hiding this comment

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

Great! I'm about to potentially need these instructions 😀

Copy link
Contributor

@AetherUnbound AetherUnbound left a comment

Choose a reason for hiding this comment

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

Looks great! Thanks! 😄

@zackkrida
Copy link
Member

@stacimc typically PR authors merge their own PR after two approving reviews, so you're welcome to do the same here. Thanks for this work!

@stacimc stacimc merged commit f81cd0b into main Feb 14, 2022
@stacimc stacimc deleted the update/quickstart-docs-with-troubleshooting-tips branch February 14, 2022 23:00
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
📄 aspect: text Concerns the textual material in the repository 🛠 goal: fix Bug fix 🟩 priority: low Low priority and doesn't need to be rushed
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add troubleshooting tips to the Quickstart docs
4 participants