Jump to: navigation, search

Difference between revisions of "StoryBoard"

(Agenda)
 
(91 intermediate revisions by 8 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 used in the OpenStack community for managing work.  
  
== Vision & Roadmap ==
+
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'.
  
* The [[StoryBoard/Vision|Vision]]
+
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!
* The [[StoryBoard/Roadmap|Roadmap]]
+
 
* Active Specs
+
== Weekly Meetings ==
** https://review.openstack.org/#/c/97254/
+
 
** https://review.openstack.org/#/c/97211/
+
* Meetings are weekly on Thursday at 18:00 UTC in #storyboard
** https://review.openstack.org/#/c/95307/
+
** http://eavesdrop.openstack.org/#StoryBoard_Meeting
** https://review.openstack.org/#/c/103106/
+
* [[Meetings/StoryBoard|Add topics to our meeting agenda here]]
** https://review.openstack.org/#/c/103667/
+
* [http://eavesdrop.openstack.org/meetings/storyboard/ Past Meeting Logs]
** https://review.openstack.org/#/c/106313/
+
 
** https://review.openstack.org/#/c/105252/
+
== Communication==
 +
 
 +
In our highly distributed community (and team), communication is the most important skill you could have. So please! Join the conversation :) Don't be scared, we are nice people!
  
== Meeting ==
+
For StoryBoard, we have our own #storyboard channel on the OFTC network 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!
  
Weekly on Mondays at 16:00 UTC in #openstack-meeting-3
+
We also make use of the openstack-discuss and opendev service-discuss mailing lists for more asynchronous communication. Please use the tag [StoryBoard] in the subject header to get our attention :)
  
=== Agenda ===
+
==Contributing to StoryBoard==
  
'''Urgent Items:'''
+
====Contributor Guide====
* Migration Script Bug.
 
** fungi to provide krotscheck with users table dump for more debug data.
 
* Import Bugs
 
  
 +
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! ]
  
'''Discussion Topics:'''
+
After you've completed the guide please join us in our channel: #storyboard
* Story Types (ttx):  https://wiki.openstack.org/wiki/StoryBoard/Story_Types
 
* Documentation (persia)
 
** Discuss Audiences and areas where documentation needs to go.
 
* PM Community Awareness (rainya)
 
* In progress feature import, and what does this mean.
 
* Infra Adoption Email
 
  
 +
If you need help with anything in the Guide, please contact the [[First_Contact_SIG|First Contact SIG]]
  
'''MVP 1.1 (Infra):'''
+
====Developer Docs====
* Bug Import
 
  
 +
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.
  
'''MVP 1.2 (Feature Tracking):'''
+
==== Other Important Links====
* Email (krotscheck)
 
** Plugin System (done)
 
** ...tbd
 
* API support for issuing long-lasting Auth Tokens (krotscheck)
 
* Story Types phase 1 (bugs & features)
 
** Spec @ https://review.openstack.org/#/c/129267/1/specs/storyboard_story_types.rst
 
* Tags
 
** Spec @ https://review.openstack.org/#/c/97211/8/specs/storyboard_story_tags.rst
 
* Gerrit Links
 
* Status Auto-Update
 
* Task Ordering
 
* Python SDK (nikitakonovalov)
 
* Milestone Support
 
** ttx: Spec
 
* Milestone Series Tracking & reporting
 
** ttx: Spec
 
* Complex Priority and Task Lists
 
** ttx: Spec? More Brainstorming?
 
* In progress feature import
 
** to be confirmed, might be overkill
 
* Openstackid.org authentication
 
** Spec (krotscheck)
 
  
 +
* [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]
  
'''Future Work:'''
+
==== 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:
  
MVP 1.3 (LP Bugs parity):
+
- https://css-tricks.com
* CLI Interface
 
* Story Types phase 2 (vulnerabilities)
 
* Security Bugs
 
** Ability to restrict access to bugs to some ACL controlled by people already in it (might require RBAC)
 
** Importing security bugs ? Might not be necessary since all become public
 
* File Attachments
 
  
 +
- http://railsforzombies.org/
  
MVP 1.3.1 (Bugs support):
+
- http://docs.emmet.io/abbreviations/      http://emmet.io/
* Integration with Specs
 
* Project Stats/Graphs/Reporting
 
* Etherpad Summit Design Session Markup Import
 
* Bulk Import/export
 
* User Activity Report (heat map?)
 
* IRC Bot
 
  
 +
- https://www.smashingmagazine.com/
  
Unscheduled & Unprioritized:
+
- http://codepen.io/
* Rich Text Comments
 
* UX Support
 
* Role based access controls
 
* inter Story Dependencies / Epics
 
* DocImpact Bug Support
 
* Load/Performance Tests
 
* Performance Issues (Data Cache, batch request)
 
* Feature Freeze Exception Workflow (using tag?)
 
* Kanban Board (Import from Codethink)
 
* Angular Data
 
* Subscription Event API (Web sockets?)
 
* Federation Design & API
 
* Batch Request API
 
* Customizable Dashboard
 
* Operator Impact of Bug (How many are impacted by this)
 
* Build gate failure (build gate fails repeatedly, why?)
 
  
 +
- https://egghead.io/
  
'''Open Discussion'''
+
- http://www.cssmatic.com/ (interactive examples)
  
=== Last Meeting ===
+
- 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)
  
'''Urgent Items'''
+
- https://news.ycombinator.com/ (okay this is general news)
* Bug in Subscriptions
 
  
'''Discussion topics'''
+
==== Storyboard Schema  & API ====
* Story Types (ttx)
 
** https://wiki.openstack.org/wiki/StoryBoard/Story_Types
 
* Summit:
 
** Infra track
 
** UX Testing
 
** Lightning Talk
 
** T-Shirts
 
  
'''MVP 1.1'''
+
[[File:Storyboard schema.png|thumbnail|center|Quick reference for developers (thanks, griff!). Needs updating with boards and worklists]]
* <strike>Search (krotscheck, nkonovalov)</strike>
 
* <strike>Launchpad Data Import (mordred, krotscheck)</strike>
 
* <strike>Subscription (nkonovalov, ish__, krotscheck)</strike>
 
* Project Groups (krotscheck)
 
** <strike>Admin</strike>
 
** <strike>Puppet Management</strike>
 
** Import Script
 
** <strike>API Support</strike>
 
** UI - Search
 
*** https://review.openstack.org/#/c/127660/
 
** UI - Browse
 
* Tags (nkonovalov)
 
* Emails (krotscheck)
 
  
'''Open Discussion'''
+
* API reference: http://docs.openstack.org/infra/storyboard/webapi/v1.html
  
== Other doc ==
+
==== 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 143: Line 82:
 
* [[StoryBoard/Story_Tags]] -- how we could use tags to implement flexible workflows. Or not.
 
* [[StoryBoard/Story_Tags]] -- how we could use tags to implement flexible workflows. Or not.
 
* [[StoryBoard/Story_Types]] -- how we'll track bugs, features, and other story types
 
* [[StoryBoard/Story_Types]] -- how we'll track bugs, features, and other story types
 +
* [[StoryBoard/Notifications]] -- plans for notifications spec
  
  
Line 149: Line 89:
 
* [[StoryBoard/Story_Status]]
 
* [[StoryBoard/Story_Status]]
  
== Misc ==
+
==Migrating to StoryBoard==
  
* IRC channel: #storyboard on [http://webchat.freenode.net/?channels=storyboard freenode]
+
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!
* Technical documentation: http://ci.openstack.org/storyboard/
+
 
 +
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].
 +
 
 +
== Past Meetup Discussions & Other Design Documents==
 +
* [https://etherpad.openstack.org/p/storyboard-js-meetup JS Meetup, August 15th, Manchester, UK, 2016]
 +
* [[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 21:36, 28 June 2021

Storyboard is a task tracker used in the OpenStack community for managing work.

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 :) Don't be scared, we are nice people!

For StoryBoard, we have our own #storyboard channel on the OFTC network 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!

We also make use of the openstack-discuss and opendev service-discuss 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