Jump to: navigation, search

Difference between revisions of "StarlingX"

(Documentation)
(Developer Resources)
(194 intermediate revisions by 20 users not shown)
Line 1: Line 1:
 
__NOTOC__
 
__NOTOC__
[[File:Starlingx-logo-300w.png|center]]
+
<center>
  
 +
== Welcome! ==
 +
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!
 +
</center>
 +
----
 +
 +
<!-- the rest of the page is a series of four-column tables -->
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
{| style="border-collapse: separate; border-spacing: 25px;"
| style="vertical-align:top; width:75%;" |  
+
|style="vertical-align:top; width:25%;" |
== Welcome to the StarlingX project!!! ==
+
<!-- 1st table 1st column contents -->
 +
===== Getting Started =====
 +
----
 +
* [[StarlingX/Releases|Releases]]
 +
* [https://www.starlingx.io/ StarlingX web site]
 +
* [https://docs.starlingx.io/ Documentation]
 +
* [https://www.starlingx.io/learn/ Learn more]
  
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 2nd column contents -->
 +
===== Culture =====
 +
----
 +
* [https://www.openstack.org/legal/community-code-of-conduct/ Code of Conduct]
 +
* [https://governance.openstack.org/tc/reference/opens.html The Four Opens]
  
StarlingX is a fully featured and high performance Edge Cloud software stack that is based on [https://www.windriver.com/products/titanium-cloud/ Wind River® Titanium Cloud] R5 product.   Intel and Wind River have jointly open sourced this software and we invite you to download, build, install and run it. 
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 3rd column contents -->
 
+
===== Communicate =====
Wind River Titanium Cloud was originally built on open source components, which were then extended and targeted to be hardened to address critical infrastructure requirements: high availability, fault management, and performance management needed for continuous 24/7 operation.
+
----
 
+
* [http://lists.starlingx.io/ Email lists]
The StarlingX project opens all of these enhancements to the open source communityWe invite the community to contribute to the project and join us as we build the infrastructure stack for Edge Computing.
+
* IRC: #starlingX@freenode
 
+
* [https://docs.openstack.org/infra/manual/developers.html IRC setup]
 +
* [[Starlingx/Meetings|Weekly calls schedule]]
 +
* [https://zoom.us/j/342730236 Weekly calls Zoom]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
 +
===== Developer Resources =====
 +
----
 +
* [https://docs.openstack.org/infra/manual/developers.html Developer Guide]
 +
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
 +
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com iPXE]]
 +
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
 +
* [https://docs.starlingx.io/contributor/index.html Contribution guidelines]
 +
* [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]
 
|}
 
|}
----
 
 
{| style="border-collapse: separate; border-spacing: 25px;"
 
{| style="border-collapse: separate; border-spacing: 25px;"
|style="vertical-align:top; width:50%;" |
+
|style="vertical-align:top; width:25%;" |
== Documentation ==
+
<!-- 2nd table 1st column contents -->
  
* [[StarlingX/Developer Guide|Developer Guide]]
+
===== User resources  =====
* [[StarlingX Installation Guide]]
+
----
 +
* [https://docs.starlingx.io/deploy_install_guides/index.html Installation and Deployment Guides]
 +
* [[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]
  
== Code ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 2nd column contents -->
  
* [https://git.openstack.org/cgit/openstack/stx Gerrit repositories]
+
===== Code =====
** Instructions for how to download and build the code are in progress
+
----
* [https://review.openstack.org/ Gerrit Web UI]
+
* [https://opendev.org/starlingx Source code repositories]
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects]]
+
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
** Hint for fast review of open reviews related to STX, in search box use the regular expression "status:open AND project:^openstack/stx-@"
 
* [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fstx%2Dclients+OR+project%3Aopenstack%2Fstx%2Dconfig+OR+project%3Aopenstack%2Fstx%2Dfault+OR+project%3Aopenstack%2Fstx%2Dgplv2+OR+project%3Aopenstack%2Fstx%2Dgplv3+OR+project%3Aopenstack%2Fstx%2Dgui+OR+project%3Aopenstack%2Fstx%2Dha+OR+project%3Aopenstack%2Fstx%2Dinteg+OR+project%3Aopenstack%2Fstx%2Dmanifest+OR+project%3Aopenstack%2Fstx%2Dmetal+OR+project%3Aopenstack%2Fstx%2Dnfv+OR+project%3Aopenstack%2Fstx%2Droot+OR+project%3Aopenstack%2Fstx%2Dtis%2Drepo+OR+project%3Aopenstack%2Fstx%2Dtools+OR+project%3Aopenstack%2Fstx%2Dupdate+OR+project%3Aopenstack%2Fstx%2Dupstream+OR+project%3Aopenstack%2Fstx%2Dutils%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D%2D1+label%3AVerified%3E%3D1%2Czuul+NOT+reviewedby%3Aself&title=StarlingX+Review+Inbox&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1%2Cstarlingx%2Dcore+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven%27t+voted+in+the+current+revision=NOT+label%3ACode%2DReview%3C%3D%2D1%2Cself+NOT+label%3ACode%2DReview%3E%3D1%2Cself+reviewer%3Aself&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2days%29=NOT+is%3Areviewed+age%3A2d StarlingX Gerrit Review Dashboard]
 
** Also in [http://paste.openstack.org/show/723397/ StarlingX Gerrit Review Dashboard] (copy the URL from there into a browser bookmark)
 
  
== Bug Tracking ==
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 3rd column contents -->
  
* [https://storyboard.openstack.org/#!/worklist/354 StarlingX Bug List]
+
===== Governance =====
** 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
+
* [https://docs.starlingx.io/governance/index.html Governance documents]
** After you create the bug, please add it to the Bug Worklist (link above)
+
* [https://docs.starlingx.io/election/ Election documents and results]
 +
* [https://etherpad.openstack.org/p/stx-governance Archive: Draft governance etherpad]
 +
* [[Starlingx/Initial Governance|Archive: Draft governance wiki]]
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 4th column contents -->
 +
===== Meetups & PTGs =====
 +
----
 +
* [https://etherpad.openstack.org/p/stx-PTG-agenda StarlingX Denver 2018 PTG Agenda]
 +
* 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]
 +
|}
 +
<!-- 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/Feature Development Process|StarlingX Feature Development Process (needs update)]]
 +
* [[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].
  
|style="vertical-align:top; width:50%;" |
+
|style="vertical-align:top; width:25%;" |
== Status and Planning ==
+
<!-- 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]]
  
* [https://etherpad.openstack.org/p/stx-status Status Meeting Notes]
+
|style="vertical-align:top; width:25%;" |
* [https://storyboard.openstack.org/#!/project_group/86 StarlingX Storyboards]]
+
<!-- 1st table 4th column contents -->
* [https://etherpad.openstack.org/p/stx-planning StarlingX Planning] (contains sub-projects and Worklists)
+
===== Special Interest Groups (SIGs) =====
 
+
----
== References ==
+
* [[StarlingX/Packet SIG|Packet SIG]]
 
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
+
|}
 
 
== OpenStack Documentation ==
 
  
These are references to general OpenStack material:
+
The previous wiki home page can be found [[StarlingX/Archived wiki home page|here]]
 
 
* [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]
 
|}
 

Revision as of 15:35, 16 July 2019

Welcome!

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