Jump to: navigation, search

Difference between revisions of "StarlingX"

(Documentation)
(Meetups & PTGs)
(47 intermediate revisions by 16 users not shown)
Line 2: Line 2:
 
<center>
 
<center>
  
== Welcome to the StarlingX Project ==
+
== 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 starlingx-discuss mailing list or IRC - we're here to help!
 
</center>
 
</center>
 +
----
  
''See the [https://www.starlingx.io/ main StarlingX web site] for current information about the project and the [https://docs.starlingx.io/ StarlingX Documentation site] for reference documentation and guides.''
+
<!-- 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%;" |
 +
<!-- 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]
  
StarlingX is a fully featured and high performance Edge Cloud software stack that is based on the [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 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]
  
Wind River Titanium Cloud was originally built on open source components, that were then extended and hardened to meet critical infrastructure requirements, including: high availability, fault management, and performance management. This software provides numerous features and capabilities to enable 24/7 operation of mission critical applications.
+
|style="vertical-align:top; width:25%;" |
 
+
<!-- 1st table 3rd column contents -->
You can find an overview of the StarlingX project's features [https://www.starlingx.io/learn/ here].
+
===== Communicate =====
 +
----
 +
* [http://lists.starlingx.io/ Email lists]
 +
* 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 Openstack Developer Guide]
 +
* [https://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE Detailed Training Materials]
 +
* [[StarlingX/StarlingX VirtualBox Configuration Guide | VirtualBox Guide]]
 +
* [[StarlingX/StarlingX Packet.com iPXE Installation | StarlingX Packet.com iPXE]]
 +
* [https://docs.starlingx.io/developer_resources/code-submission-guide.html 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://drive.google.com/drive/folders/1AvUCq3ojuhNZV6XE8YdRhp9PVxixRIeE StarlingX Reference Material]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.helpwanted "Help wanted" bugs]
 +
|}
 +
{| style="border-collapse: separate; border-spacing: 25px;"
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 2nd table 1st column contents -->
  
The StarlingX project opens all of these enhancements to the open source community. Please join us as we build the infrastructure stack for Edge Computing.
+
===== User resources =====
 
----
 
----
<!-- the rest of the page is a two-column table -->
+
* [https://docs.starlingx.io/deploy_install_guides/index.html Installation and Deployment Guides]
{| style="border-collapse: separate; border-spacing: 25px;"
+
* [[StarlingX/Platform Features|Hardware platform features]]
|style="vertical-align:top; width:50%;" |
+
* [https://docs.openstack.org/infra/manual/developers.html OpenStack Developer's Guide]
<!-- left column contents -->
+
* [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]
 +
* [https://wiki.openstack.org/wiki/StarlingX/Tips_Tricks_Debugging_Techniques Tips, Tricks and Debugging Techniques]
  
== Releases ==
+
|style="vertical-align:top; width:25%;" |
The first StarlingX release is stx.2018.10 and it is available now!
+
<!-- 2nd table 2nd column contents -->
* How to get the code (placeholder)
 
* You can find a pre-build image for the October 2018 release [http://mirror.starlingx.cengn.ca/mirror/starlingx/centos/2018.10/20181110/outputs/iso/ here]
 
* [http://mirror.starlingx.cengn.ca/mirror/starlingx/master/centos/ Latest builds]
 
* [https://docs.starlingx.io/releasenotes/index.html StarlingX Release Notes (stx.2018.10)]
 
  
== Documentation ==
+
===== Code =====
These two documents will help get you started building, installing, and validating your installation of StarlingX:
+
----
* [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
+
* [https://opendev.org/starlingx Source code repositories]
* [https://docs.starlingx.io/installation_guide/index.html StarlingX Installation Guide]
+
* [https://review.opendev.org/#/q/status:open+AND+project:%255Estarlingx/%2540 Active code reviews]  
* [[StarlingX/StarlingX VirtualBox Configuration Guide]]
 
  
== Code ==
+
|style="vertical-align:top; width:25%;" |
The StarlingX project uses Gerrit as its web-based code change management and review tool.
+
<!-- 2nd table 3rd column contents -->
* [https://git.starlingx.io/cgit Gerrit repositories] maintain the StarlingX code, build instructions are in the [https://docs.starlingx.io/developer_guide/index.html StarlingX Developer Guide]
 
* [https://review.openstack.org/#/admin/projects/?filter=stx StarlingX Gerrit Projects] and [https://review.openstack.org/#/q/status:open+AND+project:%255Eopenstack/stx-%2540 Open StarlingX project reviews]
 
* [https://review.openstack.org/#/dashboard/?foreach=(project:openstack/stx-clients%20OR%20project:openstack/stx-config%20OR%20project:openstack/stx-distcloud%20OR%20project:openstack/stx-distcloud-client%20OR%20project:openstack/stx-fault%20OR%20project:openstack/stx-gui%20OR%20project:openstack/stx-ha%20OR%20project:openstack/stx-integ%20OR%20project:openstack/stx-manifest%20OR%20project:openstack/stx-metal%20OR%20project:openstack/stx-nfv%20OR%20project:openstack/stx-root%20OR%20project:openstack/stx-tools%20OR%20project:openstack/stx-update%20OR%20project:openstack/stx-upstream)%20status:open%20NOT%20owner:self%20NOT%20label:Workflow%3C=-1%20label:Verified%3E=1,zuul%20NOT%20reviewedby:self&title=StarlingX%20Review%20Inbox&Needs%20final%20%202=label:Code-Review%3E=2%20limit:50%20NOT%20label:Code-Review%3C=-1,self&Passed%20Zuul,%20No%20Negative%20Feedback%20(Small%20Fixes)=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3C=10&Passed%20Zuul,%20No%20Negative%20Feedback=NOT%20label:Code-Review%3E=2%20NOT%20label:Code-Review%3C=-1,starlingx-core%20delta:%3E10&Needs%20Feedback%20(Changes%20older%20than%205%20days%20that%20have%20not%20been%20reviewed%20by%20anyone)=NOT%20label:Code-Review%3C=-1%20NOT%20label:Code-Review%3E=1%20age:5d&You%20are%20a%20reviewer,%20but%20haven't%20voted%20in%20the%20current%20revision=NOT%20label:Code-Review%3C=-1,self%20NOT%20label:Code-Review%3E=1,self%20reviewer:self&Wayward%20Changes%20(Changes%20with%20no%20code%20review%20in%20the%20last%202days)=NOT%20is:reviewed%20age:2d StarlingX Gerrit Review Dashboard]
 
* [https://review.openstack.org/#/dashboard/?foreach=%28project%3Aopenstack%2Fstx-clients+OR+project%3Aopenstack%2Fstx-config+OR+project%3Aopenstack%2Fstx-distcloud+OR+project%3Aopenstack%2Fstx-distcloud-client+OR+project%3Aopenstack%2Fstx-fault+OR+project%3Aopenstack%2Fstx-gui+OR+project%3Aopenstack%2Fstx-ha+OR+project%3Aopenstack%2Fstx-integ+OR+project%3Aopenstack%2Fstx-manifest+OR+project%3Aopenstack%2Fstx-metal+OR+project%3Aopenstack%2Fstx-nfv+OR+project%3Aopenstack%2Fstx-root+OR+project%3Aopenstack%2Fstx-tools+OR+project%3Aopenstack%2Fstx-update+OR+project%3Aopenstack%2Fstx-upstream%29+status%3Aopen+NOT+owner%3Aself+NOT+label%3AWorkflow%3C%3D-1+label%3AVerified%3E%3D1%2Czuul+NOT+reviewedby%3Aself&title=StarlingX+Review+Inbox&Needs+final+%2B2=label%3ACode-Review%3E%3D2+limit%3A50+NOT+label%3ACode-Review%3C%3D-1%2Cself&Passed+Zuul%2C+No+Negative+Feedback+%28Small+Fixes%29=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3C%3D10&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode-Review%3E%3D2+NOT+label%3ACode-Review%3C%3D-1%2Cstarlingx-core+delta%3A%3E10&Needs+Feedback+%28Changes+older+than+5+days+that+have+not+been+reviewed+by+anyone%29=NOT+label%3ACode-Review%3C%3D-1+NOT+label%3ACode-Review%3E%3D1+age%3A5d&You+are+a+reviewer%2C+but+haven't+voted+in+the+current+revision=NOT+label%3ACode-Review%3C%3D-1%2Cself+NOT+label%3ACode-Review%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 by Status]
 
  
* [[StarlingX/CodeSubmissionGuidelines|Code Submission Guidelines]]
+
===== Governance =====
* [https://docs.starlingx.io/contributor/api_contribute_guide.html StarlingX API Contributor Guide]
+
----
 +
* [https://docs.starlingx.io/governance/index.html Governance documents]
 +
* [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]
 +
* [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/starlingX-winter-2020-meetup March 2020 meetup etherpad]
 +
* [https://etherpad.opendev.org/p/stx-virtual-PTG-June June 2020 PTG etherpad]
 +
|}
 +
<!-- 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 & Process ==
+
===== Planning & Processes =====
 +
----
 
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
 
* [[StarlingX/Release_Plan|StarlingX Release Planning]]
* [[StarlingX/Feature Development Process|StarlingX Feature Development Process (in review)]]
+
* [https://docs.starlingx.io/contributor/development_process.html Development 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 -->
  
== Story and Bug Tracking ==
+
===== Useful queries =====
We are using the OpenStack Storyboard tool for tracking feature development activities.  Each new Story shall be marked with one or more Tags, and can optionally include one or more Prefixes in the description. See [[StarlingX/Tags and Prefixes|Tags and Prefixes]] for a description of how we use them. 
+
----
 +
* [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.4.0 All active stories for StarlingX 4.0]
 +
* [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.4.0 All open bugs for StarlingX 4.0].
 +
* [https://review.opendev.org/#/dashboard/?title=StarlingX+Review+Inbox&foreach=%28%0Aproject%3Astarlingx%2Fansible%2Dplaybooks+OR%0Aproject%3Astarlingx%2Fclients+OR%0Aproject%3Astarlingx%2Fcompile+OR%0Aproject%3Astarlingx%2Fconfig+OR%0Aproject%3Astarlingx%2Fconfig%2Dfiles+OR%0Aproject%3Astarlingx%2Fcontainers+OR%0Aproject%3Astarlingx%2Fdistcloud+OR%0Aproject%3Astarlingx%2Fdistcloud%2Dclient+OR%0Aproject%3Astarlingx%2Fdocs+OR%0Aproject%3Astarlingx%2Felection+OR%0Aproject%3Astarlingx%2Ffault+OR%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fgui+OR%0Aproject%3Astarlingx%2Fha+OR%0Aproject%3Astarlingx%2Fhelm%2Dcharts+OR%0Aproject%3Astarlingx%2Finteg+OR%0Aproject%3Astarlingx%2Fmanifest+OR%0Aproject%3Astarlingx%2Fmetal+OR%0Aproject%3Astarlingx%2Fmonitor%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fmonitoring+OR%0Aproject%3Astarlingx%2Fnfv+OR%0Aproject%3Astarlingx%2Fopenstack%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Fplatform%2Darmada%2Dapp+OR%0Aproject%3Astarlingx%2Froot+OR%0Aproject%3Astarlingx%2Fspecs+OR%0Aproject%3Astarlingx%2Fstx%2Dpuppet+OR%0Aproject%3Astarlingx%2Ftest+OR%0Aproject%3Astarlingx%2Ftools+OR%0Aproject%3Astarlingx%2Fupdate+OR%0Aproject%3Astarlingx%2Fupstream+OR%0Aproject%3Astarlingx%2Futilities+OR%0Aproject%3Astarlingx%2Fzuul%2Djobs%0A%29%0Astatus%3Aopen%0ANOT+owner%3Aself%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&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 Gerrit Review Dashboard]
 +
* [https://review.opendev.org/#/dashboard/?title=StarlingX+TSC+Overview&foreach=%28%0Aproject%3Astarlingx%2Fgovernance+OR%0Aproject%3Astarlingx%2Fspecs%0A%29%0Astatus%3Aopen%0ANOT+label%3AWorkflow%3C%3D%2D1%0Alabel%3AVerified%3E%3D1%2Czuul%0ANOT+reviewedby%3Aself&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+branch%3Amaster&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&Needs+final+%2B2=label%3ACode%2DReview%3E%3D2+limit%3A50+NOT+reviewedby%3Aself+NOT+label%3Aworkflow%3E%3D1&Passed+Zuul%2C+No+Negative+Feedback=NOT+label%3ACode%2DReview%3E%3D2+NOT+label%3ACode%2DReview%3C%3D%2D1+limit%3A50+branch%3Amaster&Wayward+Changes+%28Changes+with+no+code+review+in+the+last+2+days%29=NOT+label%3ACode%2DReview%3C%3D%2D1+NOT+label%3ACode%2DReview%3E%3D1+age%3A2d+branch%3Amaster TSC Review Dashboard]
  
The StarlingX Storyboard project group is [https://storyboard.openstack.org/#!/project_group/86 here]. '''IMPORTANT:''' If you create a new story (of any kind), please mark it with the tag "stx.new" so we can find it, review it and assign it to the right team and a release.
+
|style="vertical-align:top; width:25%;" |
 +
<!-- 3rd table 3rd column contents -->
  
We are using Launchpad for tracking bugs.  [https://bugs.launchpad.net/starlingx Link to the StarlingX Launchpad] '''IMPORTANT:''' If you create a new bug, please use [[StarlingX/BugTemplate|the StarlingX Bug Template]].
+
===== StarlingX sub-projects =====
 +
----
 +
* [[StarlingX/Build|Build project]]
 +
* [[StarlingX/Config|Config project]]
 +
* [[StarlingX/Containers|Containers project]]
 +
* [[StarlingX/Devstack|Devstack Integration]]
 +
* [[StarlingX/DistCloud|Distributed Cloud project]]
 +
* [[StarlingX/Distro|Distro - Non-OpenStack project]]
 +
* [[StarlingX/DistroOpenStack|Distro - OpenStack project]]
 +
* [[StarlingX/Docs_and_Infra|Docs and Infra project]]
 +
* [[StarlingX/FlockServices|Flock Services project]]
 +
* [[StarlingX/MultiOS|MultiOS project]]
 +
* [[StarlingX/Networking|Networking project]]
 +
* [[StarlingX/Python2|Python2 to Python3 Transition]]
 +
* [[StarlingX/Releases|Releases project]]
 +
* [[StarlingX/Security|Security project]]
 +
* [[StarlingX/stxinabox|StarlingX In-a-box]]
 +
* [[StarlingX/Test|Test project]]
 +
* [[StarlingX/Zull|Zuul Enablement and Coverage]]
 +
* [[StarlingX/Distro/tpm-verify|tpm-verify]]
  
Sample queries:
 
* To find newly created stories, use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.new this query]
 
* To find stories with no sub-project tags, use [https://storyboard.openstack.org/#!/worklist/456 this worklist]
 
* To find all active stories assigned to the stx.2018.10 release, use [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.2018.10 this query]
 
* To find all active bugs assigned to the stx.2018.10 release in launchpad, use [https://bugs.launchpad.net/starlingx/+bugs?field.tag=stx.2018.10 this query].
 
* [Temporary] To find all active bugs in story board, use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&tags=stx.bug this query]
 
* Queries for the Sub-projects are defined on each Sub-project's page
 
  
 +
|style="vertical-align:top; width:25%;" |
 +
<!-- 1st table 4th column contents -->
  
Optional: You can also use Prefixes to search for Stories, but we consider Prefixes optional so these searches might not show the same results as searching for Tags.
+
===== Special Interest Groups (SIGs) =====
* Sample Prefix queries:
+
----
** To find all Stories with the [Features] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Feature this query]
+
* [[StarlingX/Packet SIG|Packet SIG]]  
** To find all Stories with the [Build] prefix use: [https://storyboard.openstack.org/#!/story/list?status=active&project_group_id=86&q=Build this query]
+
* [[StarlingX/First Contact SIG|First Contact SIG]]
 
 
== References ==
 
 
 
* [https://etherpad.openstack.org/p/stx-notes The list of repos] and other things
 
 
 
== 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]
 
 
 
== Governance ==
 
 
 
You can find more information about StarlingX governance and the TSC charter on the [https://docs.starlingx.io/governance/index.html governance section] of the documentation website.
 
 
 
For early versions and evolution of the documents see [https://etherpad.openstack.org/p/stx-governance here] and [[Starlingx/Initial Governance|on this wiki page.]]
 
 
 
|style="vertical-align:top; width:50%;" |
 
<!-- right column contents -->
 
 
 
== Culture ==
 
 
 
We are proud to be an OpenStack Foundation project!
 
* We support and adhere to the [https://www.openstack.org/legal/community-code-of-conduct/ OpenStack community Code of Conduct]
 
* We support and fully embrace the [https://governance.openstack.org/tc/reference/opens.html Four Opens]
 
* [[StarlingX/Contribution Guidelines|Contribution Guidelines]]
 
* The mailing lists are now live at http://lists.starlingx.io/.  There are two lists, starlingx-announce and starlingx-discuss.  Please subscribe.
 
* We have the #starlingX IRC channel set up on freenode. Refer to https://docs.openstack.org/infra/manual/developers.html regarding how to have your IRC account setup.
 
 
 
== Meetings ==
 
 
 
=== Weekly calls ===
 
 
 
* The list of meetings and dial-in information can be found [[Starlingx/Meetings|on this page.]]
 
* 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 PTG Agenda]
 
 
 
== Status and Planning ==
 
This section is under construction.
 
=== Overall project planning pages ===
 
* [[StarlingX/Project Priorities|Project Priorities]]
 
* [[StarlingX/Release Plan|Release Plan]]
 
* [[StarlingX/Project Plans|Project Plans]]
 
 
 
=== 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]] ||
 
|}
 
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.
 
 
 
== 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.
 
 
 
We are tracking the progress of resolving the OpenStack patches in an [https://docs.google.com/spreadsheets/d/1udAtEpQljV2JZVs-525UhWyx-5ePOaSSkKD1CS27ohU/edit?usp=sharing shared Google document].  If you need write access to the document, please request it through the Google sheet directly.
 
 
 
We are tracking the Non-OpenStack patches in a [https://docs.google.com/spreadsheets/d/1nKnkweuxcqvVOoRcpnTYMVUUv1RoAugOWXMjB7VIrfc/edit?usp=sharing a different shared Google document].  Please send an email to [mailto:bruce.e.jones@intel.com BruceJ @ Intel] with your gmail.com email address for access to the document.
 

Revision as of 20:21, 26 May 2020

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 starlingx-discuss 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