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

docs: 📝 add content to website landing page #77

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

lwjohnst86
Copy link
Member

Description

This PR adds content for the landing page.

Closes #53

This PR needs an in-depth review.

Checklist

  • Formatted Markdown
  • Ran just run-all

Copy link
Member

@signekb signekb left a comment

Choose a reason for hiding this comment

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

👌 Just some minor suggestions!

Comment on lines +4 to +9
managing and working with files. It is designed for doing participatory
live-"typing", where the instructor does the activity on their computer
that is on the projector and learners type along with what is done.
Along with the live-typing, there are reading tasks, discussion
activities, and hands-on practical exercises interspersed throughout the
workshop.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
managing and working with files. It is designed for doing participatory
live-"typing", where the instructor does the activity on their computer
that is on the projector and learners type along with what is done.
Along with the live-typing, there are reading tasks, discussion
activities, and hands-on practical exercises interspersed throughout the
workshop.
managing and working with files. It is designed for doing participatory
live-typing, where the instructor demonstrates the tasks on their computer
connected to a projector while learners type along on their own computer.
The workshop also includes reading tasks, discussion
activities, and hands-on exercises.

Comment on lines +11 to +13
This website contains all of the material for the workshop, from reading
material to exercises to presentations to live-typing material to
images. It is structured as a book, with "chapters" as sessions, given
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
This website contains all of the material for the workshop, from reading
material to exercises to presentations to live-typing material to
images. It is structured as a book, with "chapters" as sessions, given
This website contains all of the material for the workshop, including readings, exercises, presentations, live-typing material, and
images. It is structured as a book, with "chapters" as sessions,

Comment on lines +40 to +47
::: {.callout-tip appearance="minimal"}
:star: Do you find this workshop material useful? Please consider
"starring" our [GitHub
repository](https://github.com/rostools/github-intro/) to show your
support! Starring will save it to a list of repositories you like that
you can easily find again, plus it helps give our project more
visibility!
:::
Copy link
Member

Choose a reason for hiding this comment

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

🌟 🌟 🌟

Comment on lines +44 to +46
support! Starring will save it to a list of repositories you like that
you can easily find again, plus it helps give our project more
visibility!
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
support! Starring will save it to a list of repositories you like that
you can easily find again, plus it helps give our project more
visibility!
appreciation! Starring will save it to your list of saved repositories, so it’s easy to find again later. As a plus, it helps give our project more
visibility! :star2:

Comment on lines +55 to +57
workshop ends. The learner is someone who is currently or will soon
actively be doing research (e.g. a PhD or postdoc) and who has no or
little knowledge of using Git and GitHub. A more detailed
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
workshop ends. The learner is someone who is currently or will soon
actively be doing research (e.g. a PhD or postdoc) and who has no or
little knowledge of using Git and GitHub. A more detailed
workshop ends. A more detailed

Maybe fine to not include descriptions of the learner here by refer to the Is this for you section instead where that info should be included already (i.e., minimise duplicate content)


## Re-use and licensing

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img src="https://i.creativecommons.org/l/by/4.0/80x15.png" alt="Creative Commons License" style="border-width:0"/></a>
Copy link
Member

Choose a reason for hiding this comment

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

Damn, that is not a pretty badge. Is
less ugly?

For reference, the current badge looks like this:

Comment on lines +19 to +24
The workshop material is created using [Quarto](https://quarto.org) to
write the material and create the book format,
[GitHub](https://github.com/) to host the [Git](https://git-scm.com/)
repository of the material, and [GitHub
Actions](https://github.com/features/actions) with
[Netlify](https://www.netlify.com/) to build and host the website. The
Copy link
Member

Choose a reason for hiding this comment

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

Is this info necessary here? Could maybe be further down in its own section?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

Update landing page and README
2 participants