[Starlingx-discuss] stx-tools: document isn't aligned with code

[Arevalo, Mario Alfredo C]

Hi Changcheng and Abraham,

I have sent a new version in order to update the documentation according
to the new changes in Dockerfile[s]. You can take a look in this link:

https://review.openstack.org/#/c/601308/

sorry for any inconvenience.

Best regards.
Mario.
________________________________________
From: Arce Moreno, Abraham
Sent: Wednesday, November 21, 2018 7:35 AM
To: Liu, Changcheng; starlingx-discuss at lists.starlingx.io; Arevalo, Mario Alfredo C
Subject: RE: stx-tools: document isn't aligned with code

Hi again Changcheng,

> I’m following below document to create-starlingx-packages. It’s not
> aligned with latest code.

You are right...

> https://docs.starlingx.io/developer_guide/index.html#create-
> starlingx-packages
> <https://docs.starlingx.io/developer_guide/index.html#create-starlingx-
> packages>
> Could the man, who’s responsible for continuous-integration, clean the
> document and make it more clear?

Under this review we will include the changes to align with Mario's cleanup:
 [Developer Guide] Setup Building Docker Container [0]

The logic behind to accommodate the new "Developer Guide" flow proposal
would look like:

FYI "..." means content is not intended to be changed.

- Requirements
  - ...
- Development Environment Setup
  - ...
- Prepare the Base Docker Image
  - Configuration
    - Sample localrc
  - Build Base Docker Image
- Build the CentOS Mirror Repository
  - Run Mirror Docker Container
  - Download Packages
  - Verify Packages
  - Packages Structure
  - Create CentOS Mirror Repository
- Create StarlingX Packages
  - Run Building Docker Container
  - Download Source Code Repositories
  - Build Packages
- Build StarlingX ISO
- Build Installer
  - ...
- Build Avoidance
  - ...

In summary, "flow proposal" could look like:

- Prepare Base Docker Image
  - Build "base image"
- Build the CentOS Mirror Repository
  - Run container from "base image"
  - Get mirror files
- Create StarlingX Packages
  - Run container from "base image"
  - Get StarlingX source code
  - Build StarlingX packages
- Build StarlingX ISO

>      1. The stx-tools code isn’t aligned with the above document since base-
> build/build target has been removed.
>        2. Besides this, README.rst is not updated in time when the build rule
> has been changed.

README.rst from stx-tools project is going under a review process [1] so please
feel free to leave your comments.

[0] https://review.openstack.org/#/c/619043/
[1] https://review.openstack.org/#/c/601308/