Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update Getting Started #671

Closed
ProsperousHeart opened this issue Feb 6, 2022 · 5 comments · Fixed by #705 · May be fixed by #697
Closed

Update Getting Started #671

ProsperousHeart opened this issue Feb 6, 2022 · 5 comments · Fixed by #705 · May be fixed by #697

Comments

@ProsperousHeart
Copy link

ProsperousHeart commented Feb 6, 2022 •
edited
Loading

image
From Getting Started there are a couple of things that might be confusing to newbies:

  1. It is a bit confusing to say "find a ticket you want to work on and create a PR with just your name changed in contributions." For one, newbies may not know what PR stands for. (Or maybe I don't understand the "WIP" part?) For another, people may just do that and then never complete the issue they said they wanted to work on.
  2. Is the code that has the git clone command for a unix machine? (I never have to do that source part on a Windows machine.)
  3. The code section has people doing a clone of the main repo and not their fork,

image
Also found that the line to install requirements is missing an s
@AstraLuma
Copy link
Member

  1. Good catch! That is confusing to newbies and we should explain it more.
  2. On Unixy boxen, git generally just exists if it's installed. No extra steps are needed to enable it. ("generally" because there's no end of people doing weird things with their Linux.)
  3. Yup! That is also wrong and in needing of fixing.

@ProsperousHeart
Copy link
Author

Adding another item: requirements file is missing an s (it is below the numbered values)

@ProsperousHeart
Copy link
Author

also - we may want to have a section for Windows installations for people like myself :)

@AstraLuma
Copy link
Member

Yup! We have some of that in the installation doc.

(TODO: sphinx extension for platform-specific tabs.)

@ProsperousHeart
Copy link
Author

Oh great! It would be helpful for Windows users to have that linked in the doc

@sabadam32 sabadam32 mentioned this issue Mar 7, 2024
Closed
@davidism davidism mentioned this issue Apr 8, 2024
Merged
@AstraLuma AstraLuma mentioned this issue May 20, 2024
Draft
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
2 participants
@AstraLuma @ProsperousHeart