Thank you Abraham!
One change to the below – now that we have a wiki, we don’t need 3) below. We can just link to the docs from the wiki, which now has a link to it from starlingx.io.
brucej
It makes sense Bruce, thanks for your inputs!
From: Jones, Bruce E
Sent: Friday, June 15, 2018 1:13 PM
To: Arce Moreno, Abraham <abraham.arce.moreno@intel.com>;
starlingx-discuss@lists.starlingx.io
Subject: RE: Software Development Methodologies and Tools
We should follow the OpenStack documentation process and methodology, which I believe means that we can have documents that get published as web pages.
The OpenStack Dev Guide is a great example to follow. I don’t think we need to re-produce all of that content. Instead, we should point at that, and our document should cover where we are different. For instance,
how to clone the repos and do builds and tests. How we use Storyboard.
I believe the steps are something like:
1)
Get the stx-docs repo created
2)
Ramp on the steps needed to write documents and publish documents using OpenStack infra. See [1]
3)
Create a landing page (replacing our Etherpad) and go from there and build out the docs.
Abraham, please keep things more on the developer facing side. I want to work myself on the “how do we plan this project” side.
Makes sense?
[1]
https://docs.openstack.org/doc-contrib-guide/index.html
From: Arce Moreno, Abraham [mailto:abraham.arce.moreno@intel.com]
Sent: Thursday, June 14, 2018 3:31 PM
To: starlingx-discuss@lists.starlingx.io
Subject: [Starlingx-discuss] Software Development Methodologies and Tools
Our actual StarlingX Etherpad Main Page give us a great overview of the resources to get involved in our community [0]
As a next step, in your experience, how would you suggest to approach the creation of a
“software dev methodology and tools (repo, bug tracking, feature tracking, etc”
How it should look like? Should be it a webpage? a document? Is our OpenStack Developer’s Guide [1] a good example of how this could be implemented and tracked [2]?
Any recommendation is highly valuable to allow us to propose a strong set resources for our community. Thanks in advance.
[0] https://etherpad.openstack.org/p/starlingx
[1]
https://docs.openstack.org/infra/manual/developers.html
[2]
https://storyboard.openstack.org/#!/project/721