Difference between revisions of "StarlingX"

Documentation

These three documents will help get you started building, installing, and validating your installation of StarlingX:

• Developer Guide
• Installation Guide
• Validation Guide

Code

The StarlingX project uses Gerrit as its web-based code change management and review tool.

• Gerrit repositories maintain the StarlingX code, build instructions are in the StarlingX/Developer Guide
• StarlingX Gerrit Projects and Open StarlingX project reviews
• StarlingX Gerrit Review Dashboard

Story and Bug Tracking

We will mark each new Storyboard story with a Tag to

• Show what kind of a Story it is - a Bug, a Feature, etc...
• Show what release the Story is targeted to: stx.2018.08, stx.2018.11, etc... See the TBD section for more info on our Release plans
• Show which sub-project of Starling is responsible for completing the Story. See the TBD section for more info on the project's sub-projects

Tagging new stories is mandatory.

Tags for Story kinds currently defined are:

• "stx.bug" - for defects
• "stx.feature" - for new features

Tags for Releases currently defined are:

• "stx.2018.08" - for bugs or features intended to be completed before the August code freeze for the September release
• "stx.2018.11" - for bugs or features intended to be completed before the November code freeze for the December release

Tags for Sub-projects currently defined are:

• "stx.security" - for defects and features for the Security sub-project
• Additional tags e.g. for the project sub-projects will be defined shortly

• Prefixes: To make it easier to visually identify categories of work and to search on them, you can optionally add a prefix to the description for a Story. The following prefixes are defined:
  • [Bug]: A problem which impairs or prevents the functionality of StarlingX
  • [Enhancement]: An improvement or enhancement to the functionality of StartingX; typically smaller scope items
  • [Feature]: A new feature/functionality to be added to StarlingX. Ideally, the scope should fit within a release time-frame (ex: 3-6 months)
  • [Build]: Build tools, environment, repo organization, etc
  • [Process]: Process and project related work items
  • [Test]: Test/Validation related work items
  • [Doc]: Documentation related work items
  • [Upstreaming]: Work items that need to be pushed in the core openstack projects or other 3rd party repo's
  • [Help]: Request for assistance, questions
  • Same Queries:
    • Active Features: https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Feature
    • Active Bugs: https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Bug

• Tags: Tags can also be used to facilitate searches. Proposed StarlingX tags: TBD

• StarlingX Bug List
  • This list is sorted manually by drag and drop.
  • Please create bugs for any issues found in Storyboard, against one of the stx-* projects. If you can't find the right project, use stx-integ
  • After you create the bug, please add it to the Bug Worklist (link above).
  • If you don't see the "add a card" button on the Worklist, you need to be added as a user of the Worklist. Please contact bruce.e.jones@intel.com to be added.

References

• The list of repos and other things

OpenStack Documentation

These are references to general OpenStack material:

• Developer's Guide
• Project Creator's Guide
• The Contributors Guide (the older wiki page)
• Project Testing Interface

Culture

We are proud to be an OpenStack Foundation project!

• We support and adhere to the OpenStack community Code of Conduct
• We support and fully embrace the Four Opens
• Contribution Guidelines

Meetings

Weekly calls

• We host a weekly call for the project every Wednesday at 7am PDT / 1400 UTC. All are welcome.
• We also host a Core team call every Thursday at 7AM PDT / 1400 UTC. This is for the Core team but other project participants are welcome to join.

Call details

• Zoom link: https://zoom.us/j/342730236
• Dialing in from phone:
  • Dial(for higher quality, dial a number based on your current location): US: +1 669 900 6833 or +1 646 876 9923
  • Meeting ID: 342 730 236
  • International numbers available: https://zoom.us/u/ed95sU7aQ

Agenda and meeting minutes

The agenda and notes for each call are kept in Etherpads:

• Weekly Agenda and Notes
• Weekly Core team Agenda and Notes

Please feel free to add items to the agendas for these meetings.

PTG Meetings

We are preparing for the Denver OpenStack PTG meeting. Draft agenda items can be found here:

• StarlingX Denver PTG Agenda

Status and Planning

• Release Plan
• StarlingX Storyboards
• StarlingX Planning Etherpad (contains sub-projects and Worklists)
• Project Priorities
• Project Plans

Upstream Status

The StarlingX code base contains a number of out-of-tree patches against other open source components. One of our highest priorities is to contribute those changes to their upstream communities.

TODO: Add a link to our Dashboard showing the status of upstream submissions