Category:Web Dev

Access to (Old) Developer Documentation Main Page

Getting Started (Web Dev)

<categorytree mode=pages>Getting Started (Web Dev)</categorytree>

• New Employee Orientation -- Getting started at WormBase, for employees at any location. Read this first.
• Webdev team/OICR Orientation -- For new employees of the web development team at OICR.
• Setting up your development environment -- How to set up your development environment on dev.wormbase.org
• WormBase Release Workflow -- Learn about the WormBase release cycle, processes and people involved

• Staging Server Down Quick Response Cheatsheet

Third Party Developers (Web Dev)

Linking to WormBase content is easy. Find out how to link to HTML pages, text-only dumps, images, and XML pages here.

You are also welcome to contribute to Wormbase website, with open source found on Github. <categorytree mode=pages>Category:Third Party Developers (Web Dev)</categorytree>

Communication (Web Dev)

Meeting agendas, feature discussions - essentially things not implemented

WormBase People (useful for looking up on curators and their specialties)

Weekly Web Dev Call Minutes

Additionally checkout our issues on Github <categorytree mode=pages>Communication (Web Dev)</categorytree>

Best Practice (Web Dev)

Any wisdom that we like to share. <categorytree mode=pages>Best Practice (Web Dev)</categorytree>

Development (Web Dev)

• Setting up your development environment -- How to set up your development environment on dev.wormbase.org
• Developer Resources at WormBase -- Available developer resources, including the shared development space
• WormBase Release Workflow -- Project-wide schedule that documents what is happening when and where. (original wiki version)
• Formal Development Strategy (a.k.a Development workflow - webdev) -- An overview of the development process at WormBase

<categorytree mode=pages>Development General (Web Dev)</categorytree>

• Software Life Cycle
  • Software Life Cycle: 1. Build -- Preparing a new release for the website
  • Software Life Cycle: 2. Software development period|Software development period - Once a new database has been staged, the development phase begins in earnest on private development sites
  • Software Life Cycle: 3. QA/QC and Performance Benchmarking - Integrating changes and staging the code for QA/QC and performance testing prior to deployment
  • Software Life Cycle: 4. Production -- Deploying a new release to production

Main Website (Web Dev)

• Application overview - An overview of the web application, including MVC structure, request flow, caching, etc

<categorytree mode=pages >Main Website (Web Dev)</categorytree>

GBrowse (Web Dev)

<categorytree mode=pages> GBrowse (Web Dev) </categorytree>

Mobile Website (Web Dev)

<categorytree mode=pages>Mobile Website (Web Dev)</categorytree>

QA (Web Dev)

Developers care about quality! <categorytree mode=pages>QA (Web Dev)</categorytree>

Architecture (Web Dev)

Architecture category deals with Installations, Setting up and Configuring systems (particularly the more complex and less common ones).

For routine tasks, refer to category: Maintenance (Web Dev). <categorytree mode=pages>Architecture (Web Dev)</categorytree>

Maintenance (Web Dev)

Maintenance deals with somewhat common routine tasks.

For Installations, Setting up and Configuring systems (particularly the more complex and less common ones), refer to Category: Architecture (Web Dev). <categorytree mode=pages>Maintenance (Web Dev)</categorytree>

Monitoring and Crises Management

• Crises Recovery Plan - How to diagnose and recover from service interruptions.
• Monitoring services and servers - Keeping tabs on the production architecture

How to Contribute to the Documentation

If you'd like to help out adding to the documentation, that's great! Here is some general good practice that will help keeping the documentation organized, navigable and up to date.

• Ensure a page is tagged with a category, when you add or edit a page. You can browse through our #Documentation Structure/Hierarchy below, which lists all available categories right now, and locate the most specific category that describes your page.

For example, include the following code at the bottom of a page will make the page appear under the category Category: Getting Started (Web Dev) :

[[Category: Getting Started (Web Dev)]]

• Update, deprecate or remove old documentation when appropriate.

• Any documents that contain potentially sensitive information belong on Google Docs (Contact Todd for details). This might reasonably include anything that reveals information about our systems or architecture.

• Additional guidelines on Documentation and Communication Standards

• Other ideas? Please update the wiki here!

Documentation Structure/Hierarchy

<categorytree mode=pages showcount="on" hideroot="on" depth=4 >Web Dev</categorytree>