Skip to content

Commit

Permalink
Container dep
Browse files Browse the repository at this point in the history
  • Loading branch information
@alanocallaghan
alanocallaghan committed Feb 13, 2024
1 parent f6105a9 commit 14643c9
Show file tree
Hide file tree
Showing 5 changed files with 72 additions and 68 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/website.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ jobs:
ghcr.io/${{ github.repository }}:latest
build-website:
# needs: container
needs: container
runs-on: ubuntu-latest
container: ghcr.io/${{github.repository}}:latest
env:
Expand Down
117 changes: 67 additions & 50 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Contributing

[The Carpentries][c-site] ([Software Carpentry][swc-site], [Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are open source projects,
[The Carpentries][c-site] ([Software Carpentry][swc-site],
[Data Carpentry][dc-site], and [Library Carpentry][lc-site]) are
open source projects,
and we welcome contributions of all kinds:
new lessons,
fixes to existing material,
Expand All @@ -12,7 +14,8 @@ and reviews of proposed changes are all welcome.
By contributing,
you agree that we may redistribute your work under [our license](LICENSE.md).
In exchange,
we will address your issues and/or assess your change proposal as promptly as we can,
we will address your issues and/or assess your change proposal as
promptly as we can,
and help you become a member of our community.
Everyone involved in [The Carpentries][c-site]
agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
Expand All @@ -26,43 +29,52 @@ or a factual error.
This is a good way to introduce yourself
and to meet some of our community members.

1. If you do not have a [GitHub][github] account,
you can [send us comments by email][email].
However,
we will be able to respond more quickly if you use one of the other methods described below.

2. If you have a [GitHub][github] account,
or are willing to [create one][github-join],
but do not know how to use Git,
you can report problems or suggest improvements by [creating an issue][issues].
This allows us to assign the item to someone
and to respond to it in a threaded discussion.

3. If you are comfortable with Git,
and would like to add or change material,
you can submit a pull request (PR).
Instructions for doing this are [included below](#using-github).
1. If you do not have a [GitHub][github] account,
you can [send us comments by email][email].
However,
we will be able to respond more quickly if you use one of the other
methods described below.

2. If you have a [GitHub][github] account,
or are willing to [create one][github-join],
but do not know how to use Git,
you can report problems or suggest improvements by
[creating an issue][issues].
This allows us to assign the item to someone
and to respond to it in a threaded discussion.

3. If you are comfortable with Git,
and would like to add or change material,
you can submit a pull request (PR).
Instructions for doing this are [included below](#using-github).

## Where to Contribute

1. If you wish to change this lesson,
please work in <https://github.com/capentries-incubator/high-dimensional-stats-r>,
which can be viewed at <https://capentries-incubator.github.io/high-dimensional-stats-r>.

2. If you wish to change the example lesson,
please work in <https://github.com/carpentries/lesson-example>,
which documents the format of our lessons
and can be viewed at <https://carpentries.github.io/lesson-example>.

3. If you wish to change the template used for workshop websites,
please work in <https://github.com/carpentries/workshop-template>.
The home page of that repository explains how to set up workshop websites,
while the extra pages in <https://carpentries.github.io/workshop-template>
provide more background on our design choices.

4. If you wish to change CSS style files, tools,
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
please work in <https://github.com/carpentries/styles>.
1. If you wish to change this lesson,
please work in
<https://github.com/capentries-incubator/high-dimensional-stats-r>,
which can be viewed at
<https://capentries-incubator.github.io/high-dimensional-stats-r>.

2. If you wish to change the example lesson,
please work in
<https://github.com/carpentries/lesson-example>,
which documents the format of our lessons
and can be viewed at
<https://carpentries.github.io/lesson-example>.

3. If you wish to change the template used for workshop websites,
please work in
<https://github.com/carpentries/workshop-template>.
The home page of that repository explains how to set up workshop websites,
while the extra pages in
<https://carpentries.github.io/workshop-template>
provide more background on our design choices.

4. If you wish to change CSS style files, tools,
or HTML boilerplate for lessons or workshops stored in
`_includes` or `_layouts`,
please work in <https://github.com/carpentries/styles>.

## What to Contribute

Expand All @@ -73,7 +85,7 @@ and submitting [bug reports][issues]
about things that don't work, aren't clear, or are missing.
If you are looking for ideas, please see the 'Issues' tab for
a list of issues associated with this repository,
or you may also look at the issues for [Data Carpentry][dc-issues],
or you may also look at the issues for [Data Carpentry][dc-issues],
[Software Carpentry][swc-issues], and [Library Carpentry][lc-issues] projects.

Comments on issues and reviews of pull requests are just as welcome:
Expand All @@ -85,7 +97,8 @@ so fresh eyes are always welcome.

## What *Not* to Contribute

Our lessons already contain more material than we can cover in a typical workshop,
Our lessons already contain more material than we can cover in a typical
workshop,
so we are usually *not* looking for more concepts or tools to add to them.
As a rule,
if you want to introduce a new idea,
Expand All @@ -94,7 +107,8 @@ and (b) explain what you would take out to make room for it.
The first encourages contributors to be honest about requirements;
the second, to think hard about priorities.

We are also not looking for exercises or other material that only run on one platform.
We are also not looking for exercises or other material that only run on one
platform.
Our workshops typically contain a mixture of Windows, macOS, and Linux users;
in order to be usable,
our lessons must run equally well on all three.
Expand All @@ -108,22 +122,27 @@ Each lesson has two maintainers who review issues and pull requests or encourage
The maintainers are community volunteers and have final say over what gets merged into the lesson.
To use the web interface for contributing to a lesson:

1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the `gh-pages` branch and
1. Fork the originating repository to your GitHub profile.
2. Within your version of the forked repository, move to the
3. `gh-pages` branch and
create a new branch for each significant change being made.
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
4. Commit all changed files within the appropriate branches.
5. Create individual pull requests from each of your changed branches
4. Navigate to the file(s) you wish to change within the new
5. branches and make revisions as required.
6. Commit all changed files within the appropriate branches.
7. Create individual pull requests from each of your changed branches
to the `gh-pages` branch within the originating repository.
6. If you receive feedback, make changes using your issue-specific branches of the forked
8. If you receive feedback, make changes using your issue-specific
9. branches of the forked
repository and the pull requests will update automatically.
7. Repeat as needed until all feedback has been addressed.
10. Repeat as needed until all feedback has been addressed.

When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
When starting work, please make sure your clone of the originating
`gh-pages` branch is up-to-date
before creating your own revision-specific branch(es) from there.
Additionally, please only work from your newly-created branch(es) and *not*
your clone of the originating `gh-pages` branch.
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
Lastly, published copies of all the lessons are available in the
`gh-pages` branch of the originating
repository for reference while revising.

## Other Resources
Expand All @@ -135,7 +154,6 @@ You can also [reach us by email][email].

[email]: mailto:[email protected]
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[dc-lessons]: http://datacarpentry.org/lessons/
[dc-site]: http://datacarpentry.org/
[discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
[github]: https://github.com
Expand All @@ -144,7 +162,6 @@ You can also [reach us by email][email].
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[issues]: https://guides.github.com/features/issues/
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: https://software-carpentry.org/lessons/
[swc-site]: https://software-carpentry.org/
[c-site]: https://carpentries.org/
[lc-site]: https://librarycarpentry.org/
Expand Down
9 changes: 2 additions & 7 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ here are a few things we recommend you do:

* [ ] [Add relevant topic tags to your lesson repository][cdh-topic-tags].


## Contributing

We welcome all contributions to improve the lesson! Maintainers will do their
Expand All @@ -35,15 +34,14 @@ Please see the current list of
[issues](https://github.com/carpentries-incubator/high-dimensional-stats-r/issues)
for ideas for contributing to this
repository. For making your contribution, we use the GitHub flow, which is
nicely explained in the chapter
nicely explained in the chapter
[Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project)
in Pro Git by Scott Chacon.
Look for the tag
![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg).
This indicates that the maintainers will welcome a pull request fixing this
This indicates that the maintainers will welcome a pull request fixing this
issue.


## Maintainer(s)

Current maintainers of this lesson are
Expand All @@ -53,7 +51,6 @@ Current maintainers of this lesson are
* Catalina Vallejos
* Hannes Becher


## Authors

A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
Expand All @@ -62,8 +59,6 @@ A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)

To cite this lesson, please consult with [CITATION](CITATION)

[cdh]: https://cdh.carpentries.org
[cdh-topic-tags]: https://cdh.carpentries.org/the-carpentries-incubator.html#topic-tags
[change-default-branch]: https://docs.github.com/en/github/administering-a-repository/changing-the-default-branch
[community-lessons]: https://carpentries.org/community-lessons
[lesson-example]: https://carpentries.github.io/lesson-example
11 changes: 2 additions & 9 deletions index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,18 +4,13 @@ root: . # Is the only page that doesn't follow the pattern /:path/index.html
permalink: index.html # Is the only page that doesn't follow the pattern /:path/index.html
---


<!-- this is an html comment -->

{% comment %} This is a comment in Liquid {% endcomment %}

> ## Prerequisites
>
> - Knowledge of R programming (eg, [a data carpentries course](https://datacarpentry.org/lessons/))
> - Knowledge of basic statistical techniques (eg, [an introduction to linear regression for health sciences](https://carpentries-incubator.github.io/simple-linear-regression-public-health/))
> - Knowledge of basic statistical techniques
> (eg, [an introduction to linear regression for health sciences](https://carpentries-incubator.github.io/simple-linear-regression-public-health/))
{: .prereq}


## Extra resources

This course can't cover all aspects of statistics and data with R.
Expand All @@ -28,6 +23,4 @@ to learn even broader topics! Some of these are listed here:
- [Introduction to statistical learning](https://www.statlearning.com/)
- [Elements of statistical learning (advanced)](https://web.stanford.edu/~hastie/ElemStatLearn/)


{% include links.md %}

1 change: 0 additions & 1 deletion setup.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,5 +40,4 @@ for (file in data_files) {
}
```


{% include links.md %}

0 comments on commit 14643c9

Please sign in to comment.