Jump to: navigation, search

Difference between revisions of "StoryBoard"

m
 
(16 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[https://storyboard.openstack.org Storyboard] is a task tracker for OpenStack.
+
[https://storyboard.openstack.org Storyboard] is a task tracker for OpenStack.  
  
If you want an introduction to OpenStack, this is a good project to start with, as the team is small and friendly (even if we say that ourselves). If you like web-development with AngularJS, or you like Python, please say hello in #storyboard! If not, please say hello in #storyboard; it makes us feel popular.
+
The community is undergoing a migration from the legacy task tracker- Launchpad- to StoryBoard. If you are looking for details on this migration see the section: 'Migrating to StoryBoard'.
  
Please Note: Much of the StoryBoard development team is currently based in the UK. If things seem too quiet, it might just be a case of different timezones. Stick around!
+
Please Note: We are a small team- based in the UK & US. If things seem too quiet, it might just be a case of different timezones. Stick around!
  
== Vision & Roadmap ==
+
== Weekly Meetings ==
  
* The [[StoryBoard/Vision|Vision]]
+
* Meetings are weekly on Wednesdays at 19:00 UTC in #openstack-meeting
* The [[StoryBoard/Roadmap|Roadmap]]
+
** http://eavesdrop.openstack.org/#StoryBoard_Meeting
 +
* [[Meetings/StoryBoard|Add topics to our meeting agenda here]]
 +
* [http://eavesdrop.openstack.org/meetings/storyboard/ Past Meeting Logs]
 +
 
 +
== Communication==
 +
 
 +
In our highly distributed community (and team), communication is the most important skill you could have. So please! Join the conversation :)
 +
 
 +
For StoryBoard, we have our own #storyboard channel on freenode in IRC for all conversations related to our wonderful task tracker! If you have any questions about usage or getting involved please feel free to drop in!
 +
 
 +
If you don't have an IRC client set up, you can access our [http://webchat.freenode.net/?channels=storyboard freenode channel here]
 +
 
 +
We also make use of the openstack-dev and openstack-infra mailing lists for more asynchronous communication. Please use the tag [StoryBoard] in the subject header to get our attention :)
 +
 
 +
==Contributing to StoryBoard==
 +
 
 +
====Contributor Guide====
 +
 
 +
If you haven't contributed to any OpenStack project before, please start with our [https://docs.openstack.org/contributors/code-and-documentation/index.html Contributor Guide! ]
 +
 
 +
After you've completed the guide please join us in our channel: #storyboard
 +
 
 +
If you need help with anything in the Guide, please contact the [[First_Contact_SIG|First Contact SIG]]
  
== Meetups ==
+
====Developer Docs====
  
*Future
+
When developing StoryBoard, its incredibly helpful to be able to spin up a local version to test your changes (and hopefully those of others). The [https://docs.openstack.org/infra/storyboard/install/development.html documentation here] explains how you can run your own StoryBoard locally.
  
[[StoryBoard/Milestone_1_Meetup| Milestone 1 Meetup, May 16th, Manchester, UK, 2016]]
+
==== Other Important Links====
  
* Past
+
* [https://storyboard-dev.openstack.org/ StoryBoard-Dev Sandbox ]
 +
* [https://docs.openstack.org/infra/storyboard/ Main StoryBoard Documentation]
 +
* Core StoryBoard Code
 +
** [https://github.com/openstack-infra/storyboard Repo]
 +
** [https://storyboard.openstack.org/#!/project/456 Bugs can be filed/tracked here]
 +
* Webclient Code
 +
** [https://github.com/openstack-infra/storyboard-webclient Repo]
 +
** [https://storyboard.openstack.org/#!/project/457 Bugs can be filed/tracked here]
 +
* StoryBoard CLI Code
 +
** [https://github.com/openstack-infra/python-storyboardclient Repo]
 +
** [https://storyboard.openstack.org/#!/project/755 Bugs can be filed/tracked here]
  
[[StoryBoard/Midcycle_Meetup| Midcycle Meetup, Feb 17th, Manchester, UK, 2016.]]
+
==== Useful Sites For Web Development====
  
[[https://etherpad.openstack.org/p/storyboard-ux-meetup | UX Meetup, March 1st, Manchester, UK, 2016]]
+
Most OpenStack engineers are more experienced in systems engineering and less aware of common web development tools; here are some sites that the OpenStack web development specialists recommend:
  
 +
- https://css-tricks.com
  
== Meeting ==
+
- http://railsforzombies.org/
  
Wednesdays at 1500 UTC in <code>#openstack-meeting</code>
+
- http://docs.emmet.io/abbreviations/      http://emmet.io/
  
* [[Meetings/StoryBoard|Agenda]]
+
- https://www.smashingmagazine.com/
* [http://eavesdrop.openstack.org/meetings/storyboard/2015/storyboard.2015-11-04-15.03.log.html Last Meeting]
 
  
== Terminology ==
+
- http://codepen.io/
  
We talk about storyboard on IRC! We like to talk about the UX! We've confused ourselves by using different words for things!
+
- https://egghead.io/
  
So here's a quick example, with labels corresponding to the red numbers. (1), in green here, is the header. (2), in black here, is the sidebar:
+
- http://www.cssmatic.com/ (interactive examples)
  
[[File:Storyboard-layout.png|thumbnail|center|1. Header 2. Sidebar]]
+
- http://www.color-hex.com/ (includes code examples; assumes knowledge of colour theory) http://www.colourdetails.com (takes longer to load, includes examples, explains theory)
  
Those are the words we now use. Those, and no others.
+
- https://news.ycombinator.com/ (okay this is general news)
  
== Storyboard Schema ==
+
==== Storyboard Schema & API ====
  
 
[[File:Storyboard schema.png|thumbnail|center|Quick reference for developers (thanks, griff!). Needs updating with boards and worklists]]
 
[[File:Storyboard schema.png|thumbnail|center|Quick reference for developers (thanks, griff!). Needs updating with boards and worklists]]
  
== Other doc ==
+
* API reference: http://docs.openstack.org/infra/storyboard/webapi/v1.html
 +
 
 +
==== Other Documentation ====
  
 
* [[StoryBoard/Task_Branch]] -- how we'll track backporting work and show what landed in a given milestone
 
* [[StoryBoard/Task_Branch]] -- how we'll track backporting work and show what landed in a given milestone
Line 57: Line 91:
 
* [[StoryBoard/Story_Status]]
 
* [[StoryBoard/Story_Status]]
  
== Misc ==
+
==Migrating to StoryBoard==
 +
 
 +
So you're migrating to StoryBoard from Launchpad? There is documentation on this process [https://docs.openstack.org/infra/storyboard/migration.html here]. Please feel free to ask questions in our #storyboard IRC channel as you go through this process. We are here to help and excited to have you!
 +
 
 +
We are obviously undergoing a migration as a community to using StoryBoard. If you are curious about [https://storyboard.openstack.org/#!/board/45 progress you can follow it here].
  
* IRC channel: #storyboard on [http://webchat.freenode.net/?channels=storyboard freenode]
+
== Past Meetup Discussions & Other Design Documents==
* Technical documentation: http://ci.openstack.org/storyboard/
+
* [https://etherpad.openstack.org/p/storyboard-js-meetup JS Meetup, August 15th, Manchester, UK, 2016]
* API reference: http://docs.openstack.org/infra/storyboard/webapi/v1.html
+
* [[StoryBoard/Midcycle_Meetup| Midcycle Meetup, Feb 17th, Manchester, UK, 2016.]]
 +
* [https://etherpad.openstack.org/p/storyboard-ux-meetup UX Meetup, March 1st, Manchester, UK, 2016]
 +
* [[StoryBoard/Milestone_1_Meetup| Meetup, May 16th, Manchester, UK, 2016]]
 +
 
 +
* The [[StoryBoard/Vision|Vision]]
 +
* The [[StoryBoard/Roadmap|Roadmap]]

Latest revision as of 20:51, 21 June 2018

Storyboard is a task tracker for OpenStack.

The community is undergoing a migration from the legacy task tracker- Launchpad- to StoryBoard. If you are looking for details on this migration see the section: 'Migrating to StoryBoard'.

Please Note: We are a small team- based in the UK & US. If things seem too quiet, it might just be a case of different timezones. Stick around!

Weekly Meetings

Communication

In our highly distributed community (and team), communication is the most important skill you could have. So please! Join the conversation :)

For StoryBoard, we have our own #storyboard channel on freenode in IRC for all conversations related to our wonderful task tracker! If you have any questions about usage or getting involved please feel free to drop in!

If you don't have an IRC client set up, you can access our freenode channel here

We also make use of the openstack-dev and openstack-infra mailing lists for more asynchronous communication. Please use the tag [StoryBoard] in the subject header to get our attention :)

Contributing to StoryBoard

Contributor Guide

If you haven't contributed to any OpenStack project before, please start with our Contributor Guide!

After you've completed the guide please join us in our channel: #storyboard

If you need help with anything in the Guide, please contact the First Contact SIG

Developer Docs

When developing StoryBoard, its incredibly helpful to be able to spin up a local version to test your changes (and hopefully those of others). The documentation here explains how you can run your own StoryBoard locally.

Other Important Links

Useful Sites For Web Development

Most OpenStack engineers are more experienced in systems engineering and less aware of common web development tools; here are some sites that the OpenStack web development specialists recommend:

- https://css-tricks.com

- http://railsforzombies.org/

- http://docs.emmet.io/abbreviations/ http://emmet.io/

- https://www.smashingmagazine.com/

- http://codepen.io/

- https://egghead.io/

- http://www.cssmatic.com/ (interactive examples)

- http://www.color-hex.com/ (includes code examples; assumes knowledge of colour theory) http://www.colourdetails.com (takes longer to load, includes examples, explains theory)

- https://news.ycombinator.com/ (okay this is general news)

Storyboard Schema & API

Quick reference for developers (thanks, griff!). Needs updating with boards and worklists

Other Documentation


Alternate solutions:

Migrating to StoryBoard

So you're migrating to StoryBoard from Launchpad? There is documentation on this process here. Please feel free to ask questions in our #storyboard IRC channel as you go through this process. We are here to help and excited to have you!

We are obviously undergoing a migration as a community to using StoryBoard. If you are curious about progress you can follow it here.

Past Meetup Discussions & Other Design Documents