Skip to content

Latest commit

 

History

History
113 lines (78 loc) · 3.3 KB

README_githelp.md

File metadata and controls

113 lines (78 loc) · 3.3 KB
Raw

EducationUI

This repository provides a Jekyll site that renders content from other Git repositories where the content is located.

The output is currently rendered at:

https://dataoneorg.github.io/EducationUI/

The content rendered by the UI is contained in other GitHub repositories and is included in this repository through the use of Git submodules:

git submodule add https://github.com/DataONEorg/BestPractices.git bestpractices
git submodule add https://github.com/DataONEorg/Education.git lessons

When cloning:

git clone --recursive https://github.com/DataONEorg/EducationUI.git

It is important to note that _bestpractices and _lessons are both separate git repositories. Git commands should not attempt to perform actions across repositories, e.g. attempting to git mv between repositories won't work.

Committing and pushing changes to the EducationUI.

Remember you are working with three different repositories:

  1. EducationUI
  2. _bestpractices (i.e. https://github.com/DataONEorg/BestPractices)
  3. _lessons (i.e. https://github.com/DataONEorg/Education)

Edits made in the _bestpractices or _lessons folders are committed to their respective repositories.

Example: An edit is made to README.md in _bestpractices, commit and push that change, then update the parent repo to the new version of the submodule:

cd _bestpractices
git commit -m "Fixed everything" README.md
git push
cd ..
git commit -m "Bringing submodule to latest version" _bestpractices
git push

After this, the remote copy of the BestPractices repo will be up to date, and the remote copy of EducationUI on GitHub will be updated so that the _bestpractices submodule is pointing to the latest revision.

Working with the liquid tags

A few hints for working with Liquid tags, which are the tags using in the templates.

Whitespace can be controlled by adding a - to the opening and/or closing liquid tag. e.g.

{% assign blah="foo" %}

Would result in a newline being output, whereas:

{%- assign blah="foo" %}

would not.

List the available collections:

{%- for collection in site.collections %}
  {{ collection.label }}
{%- endfor %}

The lesson collection is a bit odd because we need to treat each folder as an item, but Jekyll treats each file as an item. Metadata from both the slides.md and index.md is used in rendering, but it takes a bit of extra work to get those metadata attributes when rendering a page.

From the context of the index page, the slides page can be accessed as follows:

{%- assign slides_id = page.id | split: "/" | slice: 0,3 | join: "/" | append: "/slides" %}
{%- assign slides = site[ page.collection ] | where: 'id', slides_id | first %}
{{ slides.title }}

Similarly, from the slides page, the index can be accessed:

{%- assign index_id = page.id | split: "/" | slice: 0,3 | join: "/" | append: "/index" %}
{%- assign index = site[ page.collection ] | where: 'id', index_id | first %}
{{ index.tags }}

To get a list of tags used in a collection, include the collection_tags.html file using a liquid tag like:

{% include collection_tags.html the_collection="bestpractices" %}

where the value of the the_collection property is the name of the collection to evaluate. The list of tags will then be available as the tags liquid variable.