Code Monkey home page Code Monkey logo

openwdl.github.io's Introduction

Workflow Development Language Website

The main repo for the WDL Website.

GitHub: https://github.com/openwdl/openwdl.github.io

The website is built with Jekyll using the Minimal Mistakes Jekyll theme.

Getting Started

For setup and development instructions, see OpenWDL Website Instructions - Setup & Development

Contributing

Contributing to New Issues:

  1. Create a new GitHub Issue
  2. Fork or update your fork from the main repo.
  3. In your terminal, from the main branch, create a new local branch by running git checkout -b branch-name-here
  4. Edit & Commit your changes, mentioning the Issue number in your commit, e.g. git commit file-names-here -m "Fix XYZ from #99"
  5. Push the changes via git push origin branch-name-here
  6. Submit a pull request
  7. The reviewers will either suggest additional revisions, or approve the pull request.

Editing the Site

Setup Instructions: OpenWDL Website Instructions - Setup & Development

Editing Guidelines: Editing the OpenWDL Website

The root directory contains the following important files and directories:

  • _pages/ - directory for the site
  • README.md - general readme for the repo.

Setup & Development

Prerequisites

You need the following in order to run the site:

  • Ruby version 2.4.0 or higher, including all development headers (check your Ruby version using ruby -v)
  • RubyGems (check your Gems version using gem -v)
  • GCC and Make (check versions using gcc -v,g++ -v, and make -v)

For Ruby, you may need additional developer packages(e.g. ruby-dev, ruby-bundler). See the following links, for detailed instructions:

Running the Site Locally

After installing the prerequisite software, in your terminal:

  1. `bundle exec jekyll serve
  2. In your browser, type localhost in your address bar, to view the site.

Dependencies: If you receive an error message about software dependencies, packages, gems, etc, then run bundle install or bundle update from the content directory. (Bundlr will be looking for Gemfile and Gemfile.lock, and can't run without them).

openwdl.github.io's People

Contributors

claymcleod avatar jdidion avatar patmagee avatar vsmalladi avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

openwdl.github.io's Issues

Website updates

I like that we're open sourcing the website! I was going through it and noticed a few points that could be updated:

  • Emphasise the specification and tutorials, as they're usually the first things people want to see.
  • Add the engines that support WDL.
  • Draft language specification could be updated with v1.0
  • After openwdl/wdl/issues/352 is resolved, we could update the WDL support forum link to that.
    • Link back for legacy reasons though?
  • Update the following text:

Over the coming months we will be moving the online presence for WDL from the broadinstitute.org domain to openwdl.org but for now we recommend people use the following web resources

To something like:

The OpenWDL community has been moved from the broadinstitute.org to openwdl.org. We'd like to acknowledge the Broad Institute for passing the project onto the community, and here are resources that they provide:

Investigate Static site generation tools

At the moment we use a single page html as our website, this was done simpy to fullfill our needs at the time. However as the community evolves it would be great if we could grow the website to include information such as:

  • tutorials
  • FAQ
  • Getting started guides
  • A Blog even???

IN order to facilitate this, we should investigate static ste generation tools. I am familiar with Jekyll, howver I know we can get pretty much most things working with git pages if we try.

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.