Data

Tools

Indexes

Applications

Experiments

Open Source Science

glam-workbench.github.io

https://github.com/glam-workbench/glam-workbench.github.io

Science Score: 39.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 2 DOI reference(s) in README
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.3%) to scientific vocabulary
Last synced: 10 months ago · JSON representation

Repository

Basic Info
Statistics
  • Stars: 26
  • Watchers: 4
  • Forks: 6
  • Open Issues: 11
  • Releases: 1
Created over 7 years ago · Last pushed about 1 year ago
Metadata Files
Readme Funding Citation

README.md

GLAM Workbench documentation

This repository contains the main documentation files for the GLAM Workbench and is used to build the site at: glam-workbench.net.

I also use this repository to bring together issues and discussions relating to the GLAM Workbench in general feel free to contribute!

Here's a complete list of GLAM Workbench repositories.

Contributing

Minor changes

For minor edits and corrections:

Major changes

If you're making major changes, such as adding a new section, you'll want to set up your own local version of the documentation for editing and testing:

  • Fork this repository.
  • Clone the forked repository to your own computer.
  • Create and activate a Python virtual environment. I use pyenv and pyenv-virtualenv to create and manage Python versions and environments.
  • Move to the site directory: cd glam-workbench.github.io/site
  • Install pip-tools: pip install pip tools
  • Install requirements: pip-sync
  • Run the documentation site: mkdocs serve. The site will be available at http://127.0.0.1:8000/.
  • Create or edit pages in the docs directory. See MkDocs and Material for MkDocs documentation for more information.

Any changes to markdown files in the docs directory should trigger a rebuild and reload of the site. If you make changes to templates, or to the mkdocs.yml config file, you'll probably need to stop and restart the server. Once you've finished you can git push the changes back to your fork, and create a pull request.

Note that the main site is built using Material for MkDocs Insiders which is a private repository that can only be accessed through sponsorship. The instructions above will install the public version of Material for MkDocs. The site will look and act much the same, but some extended features, such as search and tagging won't be available.

Cite as

Tim Sherratt, GLAM Workbench, 2021, https://doi.org/10.5281/zenodo.5603059

Creative Commons License
This work is licensed under a Creative Commons Attribution 4.0 International License.

Owner

  • Name: GLAM Workbench
  • Login: GLAM-Workbench
  • Kind: organization

Jupyter notebooks for working with GLAM collections

GitHub Events

Total
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 2
  • Issue comment event: 5
  • Push event: 34
Last Year
  • Create event: 1
  • Release event: 1
  • Issues event: 8
  • Watch event: 2
  • Issue comment event: 5
  • Push event: 34