carpentries / carpentries/lesson-example

Github import has changed and instructions for import are now a bit unclear

Open
#392 4 comments 0 reactions 0 assignees View on GitHub
Dominant language
HTML
Stars
65
Forks
167
PR merge metrics
No merged PRs in 30d

Description

Generally - thanks for the excellent tutorial - this makes things much easier than digging around in Ruby docs.

In the import section ...

"If you are looking to create a lesson intended for [The Carpentries Incubator](https://github.com/carpentries-incubator), there is a dedicated template and instructions included in the [repository](https://github.com/carpentries-incubator/template).

1. We’ll use the [GitHub’s importer](https://github.com/new/import) to make a copy of this repo in your own GitHub account. (Note: This is like a GitHub Fork, but not connected to the upstream changes)

2. Put the URL of [the styles repository](https://github.com/carpentries/styles/), that is https://github.com/carpentries/styles in the “Your old repository’s clone URL” box. Do not use the URL of this repository, as that will bring in a lot of example files you don’t actually want." ....

What does "this" mean in the 2nd sentence of 2. I read it as referring to the URL in the previous center and telling me to not do what I just told you to do in the previous sentence. Github importer now just asks for a URL, not an "old repo clone URL" so the combination of the undefined "this" and the change in the importer syntax can be confusing.

Could the "this" be clarified and the instructions updated to refer to what GitHub now asks?

Thanks, Heidi

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.