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.

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

📝 Documentation: Improve template setup instructions for private repos #398

Closed
2 tasks done
RNR1 opened this issue May 3, 2023 · 4 comments
Closed
2 tasks done
Labels
area: documentation Improvements or additions to docs

Comments

@RNR1
Copy link
Contributor

RNR1 commented May 3, 2023

Bug Report Checklist

Overview

I have been trying to use this node template, and it took me a few tries until I got the setup right.
I believe the setup docs could be more accurate.

Additional Info

here are the issues I ran into:

  • I need to be logged in to GitHub CLI; it was mentioned, but maybe it needs more highlighting.
  • I have to use the same repo name that I used on GitHub, and without .git in the end (as the CLI suggests)
  • If my repository is private on GitHub, I have to be a Pro user or make it public

Failing in these steps required me to git revert changes and start over.

Screenshots

not-logged-in

not-found

public-or-pro

@RNR1 RNR1 added the area: documentation Improvements or additions to docs label May 3, 2023
@JoshuaKGoldberg JoshuaKGoldberg changed the title 📝 Documentation: Improve template setup instructions 📝 Documentation: Improve template setup instructions for private repos May 3, 2023
@JoshuaKGoldberg
Copy link
Owner

I need to be logged in to GitHub CLI; it was mentioned, but maybe it needs more highlighting.

Agreed, good point. #400

I have to use the same repo name that I used on GitHub, and without .git in the end (as the CLI suggests)

Ah I think that's #183. Which nobody has sent a PR for yet, if you're interested! 😄

It's an interesting point that you might not want it to create a new repository - it might have been a mistype causing the repo to not be found. I edited that issue.

If my repository is private on GitHub, I have to be a Pro user or make it public

Agreed, good point. #401

@JoshuaKGoldberg
Copy link
Owner

Closing this out as I've split out the individual pieces into their own issues. Thanks a bunch for filing @RNR1, this is very useful stuff!

@JoshuaKGoldberg
Copy link
Owner

@allcontributors add @RNR1 for bug

@allcontributors
Copy link
Contributor

@JoshuaKGoldberg

I've put up a pull request to add @RNR1! 🎉

JoshuaKGoldberg pushed a commit that referenced this issue May 3, 2023
Adds @RNR1 as a contributor for bug.

This was requested by JoshuaKGoldberg [in this
comment](#398 (comment))

---------

Co-authored-by: allcontributors[bot] <46447321+allcontributors[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: documentation Improvements or additions to docs
Projects
None yet
Development

No branches or pull requests

2 participants