This is the repository contains all content related to the gathering of metadata assessment tools undertaken by the DLF AIG Metadata Working Group during 2016 and 2017. It is is a subsection of the DLF AIG MWG Website. This site deploys as a submodule of the Sandbox site to https://dlfaigmwgdev.herokuapp.com/ for viewing. More information is expected to be added to this site in late 2017 and in 2018.
See the Live/Production/Current site at http://dlfmetadataassessment.github.io/ and the Repository for the live site at https://github.com/DLFMetadataAssessment/DLFMetadataAssessment.github.io/
This site was developed by the Digital Library Federation Assessment Interest Group Metadata Assessment Working Group, a.k.a. the DLF Metadata Assessment Working Group.
We want the DLF Metadata Assessment Working Group site and the information contained therein to be a living document. Working Group members will continue to add resources, recommendations, and information to this website as well as to our working documents. If you want to make a comment, suggestion, correction or update, you can:
Anyone and everyone is welcomed to take part in the DLF AIG Metadata Working Group. Use the link below to find out more about the group or get involved.
This is a group effort and we welcome any and all contributions. This information below includes the basics to get you started with making change requests directly to this repository. If you get stuck, please contact a group member. We'd love to improve the documentation to make it easier for everyone to contribute.
Setting up a new child site repository
- Select the Import Repository Option from the Github site
- You will be taken to a page that lets you create a new repository based on an existing one. Make sure the owner of the new repository is DLFMetadataAssessment. For the text box titled "Your old repository's clone URL" input
https://github.com/DLFMetadataAssessment/EnvironmentalScan.git. This is the URL for the EnvironmentalScan child repository. - Delete the content of the entries folder. You will repopulate this folder with content of your new child repository.
- Modify ReadMe.md as needed to describe your new child repository.
- Modify Index.md as needed to describe your new child repository.
- Modify includes/nav.html. You will need to remove the links to the Environmental Scan child repository and add links to your new repository and any new content in the entries folder. Your new repository can be linked as the root page
/. Put any pages in the entries folder you create in an unordered list under the link to your new repository. The links to these will follow the format/entries/filename.htmlwhere "filename" is the file name of the page you are linking to.
Branch Names
Once an issue is raised in our GitHub repository, we create a branch with a name based on the issue number it is addressing, i.e. 'issue#1'. The pull request generated to fix Issue 1 is then the merging of that branch into the master branch, which feeds into the Github.io website.
You can see and comment on a list of outstanding issues.
The examples and walk through of GitHub and Jekyll below uses "issue#3" as a subject. That's the branch name used in the commit message.
Pull Requests
Once you have committed your changes to your branch for a particular issue, submit a pull request to have your changes reviewed. It will be merged by another member of the group. We request that nobody merges their own pull requests.
If your pull request sits for a while, you can submit an email to the Google Group asking for it to be reviewed.
If you're new to GitHub, we recommend an introduction to the GitHub flow and simple steps for getting started in GitHub.
This site is built with Jekyll. Jekyll is a Rails gem that generates static websites from markdown, HTML, and other formats. See the official Jekyll documentation for details and instructions on how to install. There is also a comprehensive guide to installing Jekyll on a Windows machine available here.
You'll need:
- Git
- Ruby version between 2.0 and 2.2
- Rubygems
- Bundler
- Jekyll
In a terminal:
- clone the repo with
git clone https://github.com/DLFMetadataAssessment/DLFMetadataAssessment.github.io.git - change to the repository's root directory with
cd DLFMetadataAssessment.github.io - run
bundle install - Continue with step 3 below
- Make sure you're on the master branch (necessary if you skipped step 9):
git checkout master - Make sure your master branch is up to date:
git pull origin master - Start up jekyll:
bundle exec jekyll servethen check http://localhost:4000 - create a new branch for your changes:
git checkout -b issue#3 - make changes, check http://localhost:4000 to see your changes
- add your changed files:
git add {changed-files}orgit add .to add all untracked files - commit your changes with a message:
git commit -m "fixes issue #3" - add your branch to the repo:
git push --set-upstream origin issue#3 - switch back to the master branch:
git checkout master - go to https://github.com/DLFMetadataAssessment/DLFMetadataAssessment.github.io/pulls
- make a new pull request with base:master and compare:issue-3
- wait for someone to test your changes and merge (please do not merge your own PRs)
- start over with step 1 for your next change