carpentries / lesson-example

Example lesson using The Carpentries lesson template.
https://carpentries.github.io/lesson-example/
Other
64 stars 173 forks source link

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

Open hschellman opened 1 month ago

hschellman commented 1 month ago

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, there is a dedicated template and instructions included in the repository.

  1. We’ll use the GitHub’s importer 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, 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

brownsarahm commented 1 month ago

we use a new infrastructre now, so this repo is not very active see the website

hschellman commented 1 month ago

Isn’t the “see the website” below the one I asked about? What is the new infrastructure then? Yours confusedly.

On Oct 19, 2024, at 12:46 PM, Sarah Brown @.***> wrote:

[This email originated from outside of OSU. Use caution with links and attachments.]

we use a new infrastructre now, so this repo is not very active see the websitehttps://carpentries.github.io/lesson-example/

— Reply to this email directly, view it on GitHubhttps://github.com/carpentries/lesson-example/issues/392#issuecomment-2424173362, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AIA37DO7O5IEF7ZV5A66CN3Z4KZKBAVCNFSM6AAAAABQHYOJPOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRUGE3TGMZWGI. You are receiving this because you authored the thread.Message ID: @.***>

brownsarahm commented 1 month ago

I linked to the rendered site, for this repo that has the warning box on it giving new instructions.

hschellman commented 1 month ago

Ok thanks - I took the sentence " Use the New Lesson Infrastructure! At the top to be an encouragement to use the information on that page https://carpentries.github.io/lesson-example/index.html. as in - “here is our new cool stuff", not "you should move to our new cool stuffy ”

Can I suggest changing the first few lines to:

You really should move to our new infrastructure here is how:

….

But if you REALLY want to use the old stuff this page is here for archival purposes.

On Oct 19, 2024, at 1:47 PM, Sarah Brown @.***> wrote:

[This email originated from outside of OSU. Use caution with links and attachments.]

I linked to the rendered site, for this repo that has the warning box on it giving new instructions.

— Reply to this email directly, view it on GitHubhttps://github.com/carpentries/lesson-example/issues/392#issuecomment-2424202966, or unsubscribehttps://github.com/notifications/unsubscribe-auth/AIA37DNCBISX3MSRB4XZMOLZ4LAPFAVCNFSM6AAAAABQHYOJPOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDIMRUGIYDEOJWGY. You are receiving this because you authored the thread.Message ID: @.***>