Common Workflow Language Website

The main repo for the CWL Website.

GitHub: https://github.com/common-workflow-language/cwl-website/

Table of Contents

• Repositories
• Getting Started
• Contributing
• Reporting a Vulnerability
• User Gallery Nomination
• Editing the Main Site

Repositories

The main website's files are in the /content/ directory, and built with Jekyll.

The CWL Specification is hosted separately from this repo, but built via the /site/ directory and ./website.sh script found here.

Getting Started

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

Contributing

Contributing to New Issues:

1. Create a new GitHub Issue
2. In your terminal, from the main branch, create a new local branch by running git checkout -b branch-name-here
3. Edit & Commit your changes, mentioning the Issue number in your commit, e.g. git commit file-names-here -m "Fix XYZ from #99"
4. Push the changes via git push origin branch-name-here
5. Find the branch on the GitHub repo (the url looks like https://github.com/common-workflow-language/cwl-website/tree/branch-name-here) and click "Compare and Pull Request"
6. The reviewers will either suggest additional revisions, or approve the pull request.

Existing Issues: To contribute to an existing issue and branch: Checkout the existing branch via git checkout remote-branch-name-here (don't add the -b). Then follow steps 3-6 above.

Reporting a Vulnerability

See the Security Policy page.

User Gallery Nomination

To suggest a new entry for the CWL User Gallery, create a new Issue, via the: User Gallery Nomination issue template

Editing the Main Site

Setup Instructions: CWL Website Instructions - Setup & Development

Editing Guidelines: Editing the CWL Website

The root directory contains the following important files and directories:

• /content/ - directory for the main website
• /site/ - directory for the docs. Not the main site
• README.md - general readme for the repo.
• website.sh - script that builds the website (both the main site and the docs)

Note: All edits and updates should be made in /content/ unless there is a specific reason to do otherwise.