[Starlingx-discuss] Build guide need be updated with layered build
Hi Doc/build team, The build guide wiki [0] is out of date since latest code has been switched to layered build. There is some major change for the step, such as you need sync code first, then download srpm/tarball. Please help update the wiki, otherwise new guy will be blocked for the build environment setup. BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment. [0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e... [1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807... Best Regards Shuicheng
Folks have you reviewed the updated layered build guide [0]? If there is issues with this document, please provide update to the docs team and launchpad issues. I have been using this documentation for a couple of weeks now. We should not be working in a wiki, but in the actual documentation so we can improve the overall Developer experience. Please review it and enhance as needed. Thanks Sau! [0] https://docs.starlingx.io/developer_resources/Layered_Build.html On 5/1/20 10:19 PM, Lin, Shuicheng wrote:
Hi Doc/build team,
The build guide wiki [0] is out of date since latest code has been switched to layered build.
There is some major change for the step, such as you need sync code first, then download srpm/tarball.
Please help update the wiki, otherwise new guy will be blocked for the build environment setup.
BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment.
[0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e...
[1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807...
Best Regards
Shuicheng
_______________________________________________ Starlingx-discuss mailing list Starlingx-discuss@lists.starlingx.io http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
Shuicheng, thank you. What would help the docs team out is 1) someone knowledgeable in this topic posting a doc update or 2) someone posting a rough draft of the changes to a new LP issue for the docs team. brucej From: Lin, Shuicheng <shuicheng.lin@intel.com> Sent: Friday, May 1, 2020 10:19 PM To: starlingx-discuss@lists.starlingx.io Subject: [Starlingx-discuss] Build guide need be updated with layered build Hi Doc/build team, The build guide wiki [0] is out of date since latest code has been switched to layered build. There is some major change for the step, such as you need sync code first, then download srpm/tarball. Please help update the wiki, otherwise new guy will be blocked for the build environment setup. BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment. [0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e... [1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807... Best Regards Shuicheng
Thank you Shuicheng for the input, we appreciate your technical guidance. Adding Poornima to the thread, as she has volunteered to work on this guide [2]. Question: a guide for Layered Build [3] already exists in the STX documentation. I don't know the history of this guide, should it be updated or replaced? [2] https://storyboard.openstack.org/#!/story/2007223 [3] https://docs.starlingx.io/developer_resources/Layered_Build.html Thanks again, Mary Camp PTIGlobal Technical Writer | maryx.camp@intel.com<mailto:maryx.camp@intel.com> From: Jones, Bruce E <bruce.e.jones@intel.com> Sent: Monday, May 4, 2020 4:05 PM To: Lin, Shuicheng <shuicheng.lin@intel.com>; starlingx-discuss@lists.starlingx.io Subject: Re: [Starlingx-discuss] Build guide need be updated with layered build Shuicheng, thank you. What would help the docs team out is 1) someone knowledgeable in this topic posting a doc update or 2) someone posting a rough draft of the changes to a new LP issue for the docs team. brucej From: Lin, Shuicheng <shuicheng.lin@intel.com<mailto:shuicheng.lin@intel.com>> Sent: Friday, May 1, 2020 10:19 PM To: starlingx-discuss@lists.starlingx.io<mailto:starlingx-discuss@lists.starlingx.io> Subject: [Starlingx-discuss] Build guide need be updated with layered build Hi Doc/build team, The build guide wiki [0] is out of date since latest code has been switched to layered build. There is some major change for the step, such as you need sync code first, then download srpm/tarball. Please help update the wiki, otherwise new guy will be blocked for the build environment setup. BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment. [0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e... [1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807... Best Regards Shuicheng
On 5/4/20 3:06 PM, Camp, MaryX wrote:
Thank you Shuicheng for the input, we appreciate your technical guidance.
Adding Poornima to the thread, as she has volunteered to work on this guide [2].
Question: a guide for Layered Build [3] already exists in the STX documentation. I don’t know the history of this guide, should it be updated or replaced?
Updated/polished would be good. It's very dense with examples (which is good), I think certain parts need to be amplified on to make it clear what needs to be built when and how. Sau!
[2] https://storyboard.openstack.org/#!/story/2007223
[3] https://docs.starlingx.io/developer_resources/Layered_Build.html
Thanks again,
Mary Camp
PTIGlobal Technical Writer | maryx.camp@intel.com <mailto:maryx.camp@intel.com>
*From:* Jones, Bruce E <bruce.e.jones@intel.com> *Sent:* Monday, May 4, 2020 4:05 PM *To:* Lin, Shuicheng <shuicheng.lin@intel.com>; starlingx-discuss@lists.starlingx.io *Subject:* Re: [Starlingx-discuss] Build guide need be updated with layered build
Shuicheng, thank you. What would help the docs team out is 1) someone knowledgeable in this topic posting a doc update or 2) someone posting a rough draft of the changes to a new LP issue for the docs team.
brucej
*From:* Lin, Shuicheng <shuicheng.lin@intel.com <mailto:shuicheng.lin@intel.com>> *Sent:* Friday, May 1, 2020 10:19 PM *To:* starlingx-discuss@lists.starlingx.io <mailto:starlingx-discuss@lists.starlingx.io> *Subject:* [Starlingx-discuss] Build guide need be updated with layered build
Hi Doc/build team,
The build guide wiki [0] is out of date since latest code has been switched to layered build.
There is some major change for the step, such as you need sync code first, then download srpm/tarball.
Please help update the wiki, otherwise new guy will be blocked for the build environment setup.
BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment.
[0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e...
[1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807...
Best Regards
Shuicheng
_______________________________________________ Starlingx-discuss mailing list Starlingx-discuss@lists.starlingx.io http://lists.starlingx.io/cgi-bin/mailman/listinfo/starlingx-discuss
Hi Mary/Poornima, Master code supports layered build. When do the environment setup, developer should follow layered build guide. While for stx 3.0, developer should follow current "development-environment-setup" page. So I suggest to update "development-environment-setup" to add a link point to layered build guide. Best Regards Shuicheng From: Camp, MaryX <maryx.camp@intel.com> Sent: Tuesday, May 5, 2020 6:07 AM To: Jones, Bruce E <bruce.e.jones@intel.com>; Lin, Shuicheng <shuicheng.lin@intel.com>; starlingx-discuss@lists.starlingx.io; N, Poornima Y <poornima.y.n@intel.com> Subject: RE: [Starlingx-discuss] Build guide need be updated with layered build Thank you Shuicheng for the input, we appreciate your technical guidance. Adding Poornima to the thread, as she has volunteered to work on this guide [2]. Question: a guide for Layered Build [3] already exists in the STX documentation. I don't know the history of this guide, should it be updated or replaced? [2] https://storyboard.openstack.org/#!/story/2007223 [3] https://docs.starlingx.io/developer_resources/Layered_Build.html Thanks again, Mary Camp PTIGlobal Technical Writer | maryx.camp@intel.com<mailto:maryx.camp@intel.com> From: Jones, Bruce E <bruce.e.jones@intel.com<mailto:bruce.e.jones@intel.com>> Sent: Monday, May 4, 2020 4:05 PM To: Lin, Shuicheng <shuicheng.lin@intel.com<mailto:shuicheng.lin@intel.com>>; starlingx-discuss@lists.starlingx.io<mailto:starlingx-discuss@lists.starlingx.io> Subject: Re: [Starlingx-discuss] Build guide need be updated with layered build Shuicheng, thank you. What would help the docs team out is 1) someone knowledgeable in this topic posting a doc update or 2) someone posting a rough draft of the changes to a new LP issue for the docs team. brucej From: Lin, Shuicheng <shuicheng.lin@intel.com<mailto:shuicheng.lin@intel.com>> Sent: Friday, May 1, 2020 10:19 PM To: starlingx-discuss@lists.starlingx.io<mailto:starlingx-discuss@lists.starlingx.io> Subject: [Starlingx-discuss] Build guide need be updated with layered build Hi Doc/build team, The build guide wiki [0] is out of date since latest code has been switched to layered build. There is some major change for the step, such as you need sync code first, then download srpm/tarball. Please help update the wiki, otherwise new guy will be blocked for the build environment setup. BTW, before that, we could refer the commit message in [1] to figure what we need to change to setup build environment. [0]: https://docs.starlingx.io/developer_resources/build_guide.html#development-e... [1]: https://opendev.org/starlingx/tools/commit/d51f8050cd20926c20d28c67d8967e807... Best Regards Shuicheng
participants (4)
-
Camp, MaryX
-
Jones, Bruce E
-
Lin, Shuicheng
-
Saul Wold