Merge pull request #8 from ResearchObject/update-config

Update config, README, and contributor docs

Author: elichad

CODE_OF_CONDUCT.md

@@ -0,0 +1,3 @@
+# Contributor Code of Conduct
+
+Contributors to the RO-Crate community, including this tutorial, are expected to comply with our [Code of Conduct](https://github.com/ResearchObject/ro-crate/blob/main/CODE_OF_CONDUCT.md) to ensure an open and inclusive environment. You may email [email protected] to report any Code of Conduct concerns.

CONTRIBUTING.md

@@ -0,0 +1,133 @@
+# Contributing
+
+[RO-Crate][roc-site] and [The Carpentries][c-site] (who provide the lesson template) 
+are open source projects,
+and we welcome contributions of all kinds: new lessons, fixes to
+existing material, bug reports, and reviews of proposed changes are all
+welcome.
+
+## Contributor Agreement
+
+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, and help you become a member of our
+community. Everyone involved in [RO-Crate][roc-site] agrees to abide by our 
+[code of conduct](CODE_OF_CONDUCT.md).
+
+## How to Contribute
+
+The easiest way to get started is to file an issue to tell us about a spelling
+mistake, some awkward wording, 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][roc-contact]. 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][repo-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). For inspiration about changes that need to
+   be made, check out the [list of open issues][issues] across the Carpentries.
+
+Note: if you want to build the website locally, please refer to [The Workbench
+documentation][template-doc].
+
+## Where to Contribute
+
+1. If you wish to change this lesson, add issues and pull requests here.
+2. If you wish to change the template used for workshop websites, please refer
+   to [The Workbench documentation][template-doc].
+
+## What to Contribute
+
+There are many ways to contribute, from writing new exercises and improving
+existing ones to updating or filling in the documentation and submitting [bug
+reports][issues] about things that do not work, are not clear, or are missing.
+If you are looking for ideas, please see [the list of issues for this
+repository][repo-issues], or the issues for [Data Carpentry][dc-issues],
+[Library Carpentry][lc-issues], and [Software Carpentry][swc-issues] projects.
+
+Comments on issues and reviews of pull requests are just as welcome: we are
+smarter together than we are on our own. **Reviews from novices and newcomers
+are particularly valuable**: it's easy for people who have been using these
+lessons for a while to forget how impenetrable some of this material can be, so
+fresh eyes are always welcome.
+
+## What *Not* to Contribute
+
+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,
+you must (a) estimate how long it will take to teach
+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.
+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.
+
+## Using GitHub
+
+If you choose to contribute via GitHub, you may want to look at [How to
+Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we
+use [GitHub flow][github-flow] to manage changes:
+
+1. Create a new branch in your desktop copy of this repository for each
+   significant change.
+2. Commit the change in that branch.
+3. Push that branch to your fork of this repository on GitHub.
+4. Submit a pull request from that branch to the [upstream repository][repo].
+5. If you receive feedback, make changes on your desktop and push to your
+   branch on GitHub: the pull request will update automatically.
+
+NB: The published copy of the lesson is usually in the `main` branch.
+
+Each lesson has a team of maintainers who review issues and pull requests or
+encourage others to do so. The maintainers are community volunteers, and have
+final say over what gets merged into the lesson.
+
+## Other Resources
+
+General discussion of [RO-Crate][roc-site] happens on the 
+[RO-Crate GitHub repository](https://github.com/ResearchObject/ro-crate) and in our 
+[community spaces](https://www.researchobject.org/ro-crate/community),
+which everyone is welcome to join.
+You can also [reach us by email][roc-contact].
+
+The Carpentries is a global organisation with volunteers and learners all over
+the world. We share values of inclusivity and a passion for sharing knowledge,
+teaching and learning. There are several ways to connect with The Carpentries
+community listed at <https://carpentries.org/connect/> including via social
+media, slack, newsletters, and email lists. You can also [reach us by
+email][cp-contact].
+
+
+[roc-contact]: mailto:[email protected]
+[roc-site]: https://www.researchobject.org/ro-crate/
+[repo]: https://github.com/ResearchObject/packaging_data_with_ro-crate
+[repo-issues]: https://github.com/ResearchObject/packaging_data_with_ro-crate/issues
+[cp-contact]: mailto:[email protected]
+[cp-site]: https://carpentries.org/
+[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
+[dc-lessons]: https://datacarpentry.org/lessons/
+[dc-site]: https://datacarpentry.org/
+[discuss-list]: https://carpentries.topicbox.com/groups/discuss
+[github]: https://github.com
+[github-flow]: https://guides.github.com/introduction/flow/
+[github-join]: https://github.com/join
+[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github
+[issues]: https://carpentries.org/help-wanted-issues/
+[lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry
+[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
+[swc-lessons]: https://software-carpentry.org/lessons/
+[swc-site]: https://software-carpentry.org/
+[lc-site]: https://librarycarpentry.org/
+[template-doc]: https://carpentries.github.io/workbench/

LICENSE.md

@@ -0,0 +1,36 @@
+---
+layout: page
+title: "Licenses"
+root: .
+---
+
+# Training Materials
+
+© Copyright 2021-2025 University of Technology Sydney, The University of Manchester UK and RO-Crate contributors.
+
+Licensed under the Apache License, Version 2.0 (the “License”); you may not use this file except in compliance with the License. You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an “AS IS” BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. 
+
+## Changes
+
+This tutorial has been adapted from the revised [RO-Crate introduction for 1.2](https://www.researchobject.org/ro-crate/1.2-DRAFT/introduction.html) by Stian Soiland-Reyes. Changes include:
+* Rewriting to tutorial style with exercises
+* Adaptation to Galaxy Training Material rendering
+* Explicit links to RO-Crate specifications
+* Example changed to different organization and license
+* Modiied for Carpentries style
+
+# Examples
+
+The RO-Crate JSON-LD examples and solutions are distributed under [CC0 1.0 Universal (CC0 1.0) Public Domain Dedication](https://creativecommons.org/publicdomain/zero/1.0/). This means they can be re-used freely without any requirements for attribution or licence.
+
+
+# Trademarks
+
+"Software Carpentry" and "Data Carpentry" and their respective logos
+are registered trademarks of [Community Initiatives][CI].
+
+[ci]: http://communityin.org/

README.md

@@ -1,45 +1,6 @@
-# FIXME Lesson title
-
-[![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/)
-
-**Thanks for contributing to The Carpentries Incubator!**
-This repository provides a blank starting point for lessons to be developed here.
-
-A member of the [Carpentries Curriculum Team](https://carpentries.org/team/)
-will work with you to get your lesson listed on the
-[Community Developed Lessons page][community-lessons]
-and make sure you have everything you need to begin developing your new lesson.
-
-## What to do next
-
-Before you begin developing your new lesson,
-here are a few things we recommend you do:
-
-* [ ] Decide on a title for your new lesson!
-  Once you've chosen a new title, you can set the value for `lesson_title`
-  in [`_config.yml`](_config.yml)
-* [ ] Add the URL to your built lesson pages to the repository description\*
-* [ ] [Add relevant topic tags to your lesson repository][cdh-topic-tags].
-* [ ] Fill in the fields marked `FIXME` in:
-  * this README
-  * [`_config.yml`](_config.yml)
-* [ ] If you're going to be developing lesson material for the first time
-  according to our design principles,
-  consider reading the [Carpentries Curriculum Development Handbook][cdh]
-* [ ] Consult the [Lesson Example][lesson-example] website to find out more about
-  working with the lesson template
-* [ ] If you are planning to write your lesson in RMarkdown,
-  [create a `main` branch and set this as the default branch in your repository settings][change-default-branch]
-* [ ] Update this README with relevant information about your lesson
-  and delete this section
-
-
-\* To set the URL on GitHub, click the gear wheel button next to **About**
-on the right of the repository landing page.
-The lesson URL structure is **https://carpentries-incubator.github.io/<repository-slug\>**:
-a repository at https://github.com/carpentries-incubator/new-lesson/ will have pages at
-the lesson URL https://carpentries-incubator.github.io/new-lesson/.
+# Packaging Data with RO-Crates
 
+This lesson is intended to teach users how to use [RO-Crate](https://www.researchobject.org/ro-crate/) (Research Object Crates) for packaging research data.
 
 ## Contributing
 
@@ -50,7 +11,7 @@ We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTR
 the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
 how to write new episodes.
 
-Please see the current list of [issues][FIXME] for ideas for contributing to this
+Please see the current list of [issues](https://github.com/ResearchObject/packaging_data_with_ro-crate/issues) for ideas for contributing to this
 repository. For making your contribution, we use the GitHub flow, which is
 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.
@@ -64,6 +25,7 @@ Current maintainers of this lesson are
 * Stian Soiland-Reyes
 * Stuart Owen
 * Douglas Lowe
+* Eli Chadwick
 
 
 ## Authors

config.yaml

@@ -1,3 +1,4 @@
+---
 #------------------------------------------------------------
 # Values for this lesson.
 #------------------------------------------------------------
@@ -10,36 +11,36 @@
 # incubator: The Carpentries Incubator
 # Note that you can also use a custom carpentry type. For more info,
 # see the documentation: https://carpentries.github.io/sandpaper-docs/editing.html
-carpentry: 'incubator'
+carpentry: "incubator"
 
 # Custom carpentry description
 # This will be used as the alt text for the logo
 # carpentry_description: "Custom Carpentry"
 
 # Overall title for pages.
-title: 'Packaging Data with RO-Crates'
+title: "Packaging Data with RO-Crates"
 
 # Date the lesson was created (YYYY-MM-DD, this is empty by default)
-created: 
+created:
 
 # Comma-separated list of keywords for the lesson
-keywords: 'software, data, lesson, The Carpentries'
+keywords: "software, data, lesson, The Carpentries"
 
 # Life cycle stage of the lesson
 # possible values: pre-alpha, alpha, beta, stable
-life_cycle: 'beta'
+life_cycle: "beta"
 
 # License of the lesson materials (recommended CC-BY 4.0)
-license: 'CC-BY 4.0'
+license: "Apache 2.0"
 
 # Link to the source repository for this lesson
-source: 'https://github.com/fishtree-attempt/convert_lesson_2/'
+source: "https://github.com/ResearchObject/packaging_data_with_ro-crate"
 
 # Default branch of your lesson
-branch: 'main'
+branch: "main"
 
 # Who to contact if there are any issues
-contact: 'team@carpentries.org'
+contact: "ro-crate@researchobject.org"
 
 # Navigation ------------------------------------------------
 #
@@ -64,39 +65,35 @@ contact: '[email protected]'
 # - another-learner.md
 
 # Order of episodes in your lesson
-episodes: 
-- 01-introduction.md
-- 02-folder-as-crate-root.md
-- 03-metadata-descriptor.md
-- 04-root.md
-- 05-root-metadata.md
-- 06-cross-references.md
-- 07-data-entities.md
-- 08-contextual-entities.md
-- 09-authorship.md
-- 10-validating.md
-- 11-triples.md
-- 12-html-preview.md
-- 13-complete.md
-- 14-next-steps.md
+episodes:
+  - 01-introduction.md
+  - 02-folder-as-crate-root.md
+  - 03-metadata-descriptor.md
+  - 04-root.md
+  - 05-root-metadata.md
+  - 06-cross-references.md
+  - 07-data-entities.md
+  - 08-contextual-entities.md
+  - 09-authorship.md
+  - 10-validating.md
+  - 11-triples.md
+  - 12-html-preview.md
+  - 13-complete.md
+  - 14-next-steps.md
 
 # Information for Learners
-learners: 
+learners:
 
 # Information for Instructors
-instructors: 
+instructors:
 
 # Learner Profiles
-profiles: 
+profiles:
 
 # Customisation ---------------------------------------------
 #
 # This space below is where custom yaml items (e.g. pinning
 # sandpaper and varnish versions) should live
 
-
-carpentry_description: Lesson Description
-url: https://preview.carpentries.org/convert_lesson_2
-analytics: carpentries
+url: https://www.researchobject.org/packaging_data_with_ro-crate/
 lang: en
-workbench-beta: yes