Giter VIP home page Giter VIP logo

ami-preservation's Introduction

ami-preservation

NYPL's Preservation of Audio and Moving Image (PAMI) team performs reformatting to provide long-term preservation and access for our audiovisual collections. This repository contains the resources, tools, internal documentation that support digitization, quality assurance, and quality control activities within the PAMI workflow. Use the following links to navigate to various tools stored in the repo:

Documentation Site Installation and Development

Administrators must set up their site development environment before attempting to make changes to any documents, so they can test funcitonality on the live site before releasing it to the public. Below are the installation instructions.

Installaton

  • See this site for ruby / gem / bundler troubleshooting: https://idratherbewriting.com/documentation-theme-jekyll/mydoc_install_jekyll_on_mac.html

  • If you don’t have ruby:
 brew install ruby

  • If ruby is not in usr/local/bin: 
echo 'export PATH="/usr/local/opt/ruby/bin:$PATH"' >> ~/.bash_profile

    • Quit & restart Terminal
    • Open Terminal and check again: 

which ruby
 and which gem
 (again, see here for info on installing ruby in the correct location)
    • All set!? (if not, seek help with a human)
  • Install dependencies

    1. Run gem install Jekyll
    2. Run gem install bundler
    3. Clone the ami-repository repository to desired location (or update local existing copy)
    4. Navigate to /docs site folder: cd /path/to/ami-preservation/docs
    5. Run bundle

Editing Pages and Testing Site Changes Locally

  • Edit Markdown files using a text editor (such as Atom or Sublime Text)
  • Save and commit changes to the repo.
  • Run cd /path/to/ami-preservation/docs/
  • Run bundle exec jekyll serve
  • Open your Web Browser and navigate to http://localhost:4000
  • Reload page as needed to view changes in real time.

ami-preservation's People

Contributors

genfhk avatar bturkus avatar rdmarino avatar nkrabben avatar gregh18 avatar rdostaly avatar dependabot[bot] avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.