diff --git a/.gitignore b/.gitignore index bd874548..481aa290 100644 --- a/.gitignore +++ b/.gitignore @@ -49,3 +49,5 @@ docs/ # translation temp files po/*~ +# Custom +renv/ diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 4153dd42..db14a936 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -2,6 +2,8 @@ title: "Contributor Code of Conduct" --- +Although this is Melbourne Bioinformatics content, we abide by the same Carpentries Code of Conduct explicited below: + As contributors and maintainers of this project, we pledge to follow the [The Carpentries Code of Conduct][coc]. diff --git a/config.yaml b/config.yaml index b49991e9..b6d52847 100644 --- a/config.yaml +++ b/config.yaml @@ -2,29 +2,24 @@ # Values for this lesson. #------------------------------------------------------------ -# Which carpentry is this (swc, dc, lc, or cp)? -# swc: Software Carpentry -# dc: Data Carpentry -# lc: Library Carpentry -# cp: Carpentries (to use for instructor training for instance) -# incubator: The Carpentries Incubator -# -# This option supports custom types so lessons can be branded -# and themed with your own logo and alt-text (see `carpentry_description`) -# See https://carpentries.github.io/sandpaper-docs/editing.html#adding-a-custom-logo -carpentry: 'incubator' +# Which carpentry is this (swc, dc, lc, or cp)? < REPLACED with UNIMELB institutes > +# uom: University of Melbourne +# mb: Melbourne Bioinformatics +# mig: Melbourne Integrative Genomics +# wehi: Walter and Eliza Hall Institute +carpentry: 'uom' # Alt-text description of the lesson. -carpentry_description: 'Lesson Description' +carpentry_description: 'Lesson Description' # FIXME # Overall title for pages. title: 'Lesson Title' # FIXME -# Date the lesson was created (YYYY-MM-DD, this is empty by default) +# Date the lesson was created ('YYYY-MM-DD', this is empty by default) created: ~ # FIXME -# Comma-separated list of keywords for the lesson -keywords: 'software, data, lesson, The Carpentries' # FIXME +# Comma-separated list of keywords for the lesson. Avoid words in the title. +keywords: 'software, data, lesson' # FIXME # Life cycle stage of the lesson # possible values: pre-alpha, alpha, beta, stable @@ -34,13 +29,13 @@ life_cycle: 'pre-alpha' # FIXME license: 'CC-BY 4.0' # Link to the source repository for this lesson -source: 'https://github.com/carpentries/workbench-template-md' # FIXME +source: 'https://github.com/melbournebioinformatics/workbench-template-rmd' # FIXME # Default branch of your lesson branch: 'main' # Who to contact if there are any issues -contact: 'team@carpentries.org' # FIXME +contact: 'fixme@fixme.org' # FIXME # Navigation ------------------------------------------------ # @@ -82,4 +77,7 @@ profiles: # This space below is where custom yaml items (e.g. pinning # sandpaper and varnish versions) should live +# This is the UoM varnish, which is a custom version of the Carpentries varnish +varnish: 'melbournebioinformatics/uom-varnish@main' +url: 'melbournebioinformatics.github.io/uom-varnish' diff --git a/index.md b/index.md index af662764..420573c6 100644 --- a/index.md +++ b/index.md @@ -2,8 +2,12 @@ site: sandpaper::sandpaper_site --- -This is a new lesson built with [The Carpentries Workbench][workbench]. +This is a new lesson built with the [Melbourne Bioinformatics fork](https://github.com/melbournebioinformatics/workbench-template-md) of the [Carpentries Workbench](workbench). +For more information on Melbourne Bioinformatics, please see our [official page](mb-uom-page) and our [tutorial collection](mb-tutorials). If you would like to attend one of our workshops, please follow our [Eventbrite page](mb-eventbrite), where you can get notifications and register for upcoming workshops. +[mb-uom-page]: https://mdhs.unimelb.edu.au/melbournebioinformatics +[mb-tutorials]: https://melbournebioinformatics.github.io/MelBioInf_docs/ +[mb-eventbrite]: https://www.eventbrite.com.au/d/australia--melbourne/melbourne-bioinformatics/ [workbench]: https://carpentries.github.io/sandpaper-docs