Jump to: navigation, search

Difference between revisions of "StarlingX/Draft new wiki home page"

(Developer Resources)
 
(12 intermediate revisions by the same user not shown)
Line 3: Line 3:
  
 
== Welcome to the StarlingX Community ==
 
== Welcome to the StarlingX Community ==
''This is a work-in-progress draft of a new look for the StarlingX wiki home page.  Comments and feedback welcome! Please send them to (bruce dot e dot jones at intel dot com)''.
+
'''This is the draft of a new version of the StarlingX wiki home page.  It went live as the home page on June 26th. This page is preserved for archival use only.'''
  
 
Welcome to the StarlingX Contributor Community!  We're glad you are here.  Everything you need to get started with StarlingX is available below.  If you have questions or need advice, please reach out to us on the mailing list or IRC - we're here to help!
 
Welcome to the StarlingX Contributor Community!  We're glad you are here.  Everything you need to get started with StarlingX is available below.  If you have questions or need advice, please reach out to us on the mailing list or IRC - we're here to help!
Line 22: Line 22:
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 1st table 2nd column contents -->
 
<!-- 1st table 2nd column contents -->
 
 
===== Culture =====
 
===== Culture =====
 
----
 
----
Line 30: Line 29:
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 1st table 3rd column contents -->
 
<!-- 1st table 3rd column contents -->
 
 
===== Communicate =====
 
===== Communicate =====
 
----
 
----
Line 40: Line 38:
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 1st table 4th column contents -->
 
<!-- 1st table 4th column contents -->
 
 
===== Developer Resources =====
 
===== Developer Resources =====
 
----
 
----
 
* [https://docs.starlingx.io/contributor/index.html Developer Guide]
 
* [https://docs.starlingx.io/contributor/index.html Developer Guide]
* [https://docs.starlingx.io/installation_guide/index.html Installation Guide]
 
 
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
 
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
 
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE]]
 
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com  iPXE]]
Line 50: Line 46:
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
 
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "help wanted" bugs]  
+
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "Help wanted" bugs]  
 
|}
 
|}
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 2nd table 1st column contents -->
 
<!-- 2nd table 1st column contents -->
 
 
===== User resources  =====
 
===== User resources  =====
 
----
 
----
 +
* [https://docs.starlingx.io/installation_guide/index.html Installation Guide]
 
* [[StarlingX/Platform Features|Hardware platform features]]
 
* [[StarlingX/Platform Features|Hardware platform features]]
 +
* [https://docs.openstack.org/infra/manual/developers.html OpenStack Developer's Guide]
 +
* [https://docs.openstack.org/infra/manual/creators.html OpenStack Project Creator's Guide]
 +
* [https://wiki.openstack.org/wiki/How_To_Contribute OpenStack Contributors Guide]
 +
* [https://governance.openstack.org/tc/reference/project-testing-interface.html OpenStack Project Testing Interface]
  
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 2nd table 2nd column contents -->
 
<!-- 2nd table 2nd column contents -->
 
 
===== Code =====
 
===== Code =====
 
----
 
----
 
* [https://opendev.org/starlingx Source code repositories]
 
* [https://opendev.org/starlingx Source code repositories]
* [https://review.opendev.org/#/admin/projects/?filter=starlingx Active code reviews]  
+
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
  
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
Line 77: Line 76:
 
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
 
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
 
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
 
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
----
 
 
 
|style="vertical-align:top; width:25%;" |
 
|style="vertical-align:top; width:25%;" |
 
<!-- 2nd table 4th column contents -->
 
<!-- 2nd table 4th column contents -->
 
+
===== Meetups & PTGs =====
==== TBD ====
 
 
----
 
----
* Foo
 
 
 
 
 
==== Contributor Info ====
 
The StarlingX project uses Gerrit as its web-based code change management and review tool.  The following links and queries are helpful for finding out what reviews are active in the project:
 
 
 
==== Meetings ====
 
===== Weekly calls =====
 
We have a number of community calls each week.  All calls are open for anyone to join.  We try to schedule them in a time slot that works for Asia, US/Canada and Europe, which means they are usually in the morning US time.
 
* The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]  New contributors should join the Wednesday weekly community call.
 
* We held a community meetup in January 2019.  The agenda and meeting notes [https://etherpad.openstack.org/p/stx-chandler-meetup can be found here].  A blog with pictures and a description of the meetup [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html is here].
 
 
===== PTG Meetings =====
 
Here are the agendas and notes for our PTG meetings:
 
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 
* add link here to the Berlin PTG meeting minutes
 
* add link here to the Berlin PTG meeting minutes
 +
* [https://etherpad.openstack.org/p/stx-chandler-meetup Jan 2019 meetup etherpad]
 +
* [https://www.starlingx.io/blog/starlingx-meetup-january-2019.html Jan 2019 meetup blog]
 
* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
 
* [https://etherpad.openstack.org/p/stx-ptg-agenda StarlingX Denver 2019 PTG Agenda and Notes]
===== Planning & Process =====
+
|}
 +
<!-- the rest of the page is a series of four-column tables -->
 +
{| style="border-collapse: separate; border-spacing: 25px;"
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 1st column contents -->
 +
===== Planning & Processes =====
 +
----
 
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
 
* [[StarlingX/Defect Handling Process|StarlingX Defect Handling Process]]
 +
* [[StarlingX/Tags and Prefixes|Tags and Prefixes]] 
 +
* [https://storyboard.openstack.org/#!/project_group/86 Storyboard Group]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 2nd column contents -->
 +
===== Useful queries =====
 +
----
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new Newly created stories]
 +
* [https://storyboard.openstack.org/#!/worklist/456 Stories with no sub-project tags]
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 All active stories]
 +
* [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2.0 All active stories for StarlingX 2.0]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2.0 All open bugs for StarlingX 2.0].
  
===== Story and Bug Tracking =====
+
|style="vertical-align:top; width:25%;" |
We are using the OpenStack Storyboard tool for tracking feature development activities.  Each new Story should be marked with one or more Tags, and can optionally include one or more Prefixes in the title.  See [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them. 
+
<!-- 3rd table 3rd column contents -->
 +
===== StarlingX sub-projects =====
 +
----
 +
* [[StarlingX/Config|Config project]]
 +
* [[StarlingX/Fault|Fault project]]
 +
* [[StarlingX/HA|HA project]]
 +
* [[StarlingX/GUI|GUI project]]
 +
* [[StarlingX/Metal|Metal project]]
 +
* [[StarlingX/NFV|NFV project]]
 +
* [[StarlingX/Update|Update project]]
 +
* [[StarlingX/DistCloud|Distributed Cloud project]]
 +
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
 +
* [[StarlingX/Build|Build project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Pyton2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
  
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 here].
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 4th column contents -->
We are using [https://bugs.launchpad.net/starlingx Launchpad] for tracking bugs. '''IMPORTANT:''' If you create a new bug, please use [[StarlingX/BugTemplate|the StarlingX Bug Template]].
+
===== Special Interest Groups (SIGs) =====
 
+
----
Sample queries:
+
* [[StarlingX/Packet SIG|Packet SIG]]  
* To find newly created stories, use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
* To find stories with no sub-project tags, use [https://storyboard.openstack.org/#!/worklist/456 this worklist]
 
* To find all active stories, use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86 this query]
 
* To find all active stories for stx.2.0, use  [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2.0 this query]
 
* To find all active bugs for stx.2.0 in launchpad, use [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2018.10 this query].
 
* Queries for the Sub-projects are defined on each Sub-project's page
 
==== StarlingX Projects ====
 
StarlingX is both a development project and an integration project that combines new services with many other open source projects into an overall Edge Cloud software stack.  We've broken the overall project into a set of separate projects to help keep things manageable.
 
Notes from the F2F discussion on how to organize sub-teams are [https://ethercalc.openstack.org/ctjc7vlbphm1 here]
 
===== StarlingX main projects =====
 
Information on the main StarlingX development projects can be found on the wiki pages below:
 
{| class=wikitable
 
|-
 
| [[StarlingX/Config|Config project]]
 
| [[StarlingX/Fault|Fault project]]
 
|  [[StarlingX/HA|HA project]]
 
| [[StarlingX/GUI|GUI project]]
 
|-
 
| [[StarlingX/Metal|Metal project]]
 
| [[StarlingX/NFV|NFV project]]
 
| [[StarlingX/Update|Update project]]
 
| [[StarlingX/DistCloud|Distributed Cloud project]]
 
 
|}
 
|}
  
===== StarlingX supporting projects =====
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
In addition to the main StarlingX development projects there are also additional projects to help us develop, maintain, document, build and release the overall StarlingX software stack.
 
{| class="wikitable"
 
|-
 
| [[StarlingX/Docs_and_Infra|Docs and Infra project]]
 
| [[StarlingX/Build|Build project]]
 
| [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 
| [[StarlingX/Distro|Distro - Non-OpenStack project]]
 
|-
 
| [[StarlingX/Test|Test project]]
 
| [[StarlingX/Security|Security project]]
 
| [[StarlingX/Containers|Containers project]]
 
| [[StarlingX/Networking|Networking project]]
 
|-
 
| [[StarlingX/Releases|Releases project]]
 
| [[StarlingX/MultiOS|MultiOS project]]
 
|
 
|
 
|}
 
 
 
===== StarlingX cross-project initiatives =====
 
There are several initiatives we are implementing that cross project boundaries:
 
{| class="wikitable"
 
|-
 
| [[StarlingX/Pyton2|Python2 to Python3 Transition]]
 
| [[StarlingX/Zull|Zuul Enablement and Coverage]]
 
| [[StarlingX/Devstack|Devstack Integration]]
 
| [[StarlingX/stxinabox|StarlingX In-a-box]]
 
|}
 
ToDo:
 
* Create a Project Map graphic that captures all of this in a graphical way, similar to (or an extension of) the OpenStack project map.
 
 
 
===== StarlingX Special Interest Groups (SIGs) =====
 
There are several SIGs in the StarlingX community:
 
* [[StarlingX/Packet SIG|Packet SIG]] - for community members interested in working with the hardware provided by packet.com
 
* [[StarlingX/First Contact SIG|First Contact SIG]]- for community members interested in helping new community members
 
 
 
==== OpenStack Documentation ====
 
These are references to general OpenStack material:
 
* [https://docs.openstack.org/infra/manual/developers.html Developer's Guide]
 
* [https://docs.openstack.org/infra/manual/creators.html Project Creator's Guide]
 
* [https://wiki.openstack.org/wiki/How_To_Contribute The Contributors Guide]  (the older wiki page)
 
* [https://governance.openstack.org/tc/reference/project-testing-interface.html Project Testing Interface]
 
 
 
----
 

Latest revision as of 17:56, 26 June 2019

Welcome to the StarlingX Community

This is the draft of a new version of the StarlingX wiki home page. It went live as the home page on June 26th. This page is preserved for archival use only.

Welcome to the StarlingX Contributor Community! We're glad you are here. Everything you need to get started with StarlingX is available below. If you have questions or need advice, please reach out to us on the mailing list or IRC - we're here to help!


Getting Started

Culture

Communicate

Developer Resources

User resources

Code

Governance

Meetups & PTGs

Planning & Processes

Useful queries

StarlingX sub-projects

Special Interest Groups (SIGs)

The previous wiki home page can be found here