To build out HTML copy of the docs, install tox on your system, and then just run it in the root of your docs tree. It will build out the entire docs collection on your system so you can view it in a browser. It will also call out any
errors in your .rst file that will be caught by zuul.
From: Camp, MaryX <maryx.camp@intel.com>
Sent: Thursday, August 6, 2020 8:41 AM
To: Ning, Antai (Andy) <Andy.Ning@windriver.com>; starlingx-discuss@lists.starlingx.io
Cc: Khalil, Ghada <Ghada.Khalil@windriver.com>; Waines, Greg <Greg.Waines@windriver.com>; Balaraj, Juanita <Juanita.Balaraj@windriver.com>
Subject: Re: [Starlingx-discuss] stx docs input: 1883300
Thanks Andy, you did it perfectly! We edit the .rst files and there is Zuul magic (scripts) that build the HTML output.
FYI, you can view the draft HTML output from the review page - in the Zuul check section, click openstack-tox-docs, scroll down to Artifacts and click Docs preview site.
Then you can drill down into the guide you updated.
thanks again,
Mary C.
From: Ning, Antai (Andy) <Andy.Ning@windriver.com>
Sent: Thursday, August 6, 2020 11:20 AM
To: Camp, MaryX <maryx.camp@intel.com>;
starlingx-discuss@lists.starlingx.io
Cc: Khalil, Ghada <Ghada.Khalil@windriver.com>; Waines, Greg <Greg.Waines@windriver.com>; Balaraj, Juanita <Juanita.Balaraj@windriver.com>
Subject: Re: [Starlingx-discuss] stx docs input: 1883300
Hi Mary,
I updated configuration/cert_config.rst as you instructed in review:
I don't know how to build it into html though.
Thanks,
Andy
From: Camp, MaryX <maryx.camp@intel.com>
Sent: Wednesday, August 5, 2020 5:04 PM
To: Ning, Antai (Andy) <Andy.Ning@windriver.com>;
starlingx-discuss@lists.starlingx.io <starlingx-discuss@lists.starlingx.io>
Cc: Khalil, Ghada <Ghada.Khalil@windriver.com>; Waines, Greg <Greg.Waines@windriver.com>; Balaraj, Juanita <Juanita.Balaraj@windriver.com>
Subject: RE: [Starlingx-discuss] stx docs input: 1883300
Hi Andy,
Thanks for letting us know about this doc change. It looks like this software bug fix requires an update to this user document:
https://docs.starlingx.io/configuration/cert_config.html, in the Local Docker registry section. [source file = configuration/cert_config.rst]
Can you please open a review against this guide in the docs repo and add the line “Related-Bug: 1883300” in your commit message? That will help us keep track of everything, since the original SW bug is already
Fixed.
Please let me know if you have any questions or issues.
From: Ning, Antai (Andy) <Andy.Ning@windriver.com>
Sent: Wednesday, August 5, 2020 11:20 AM
To: starlingx-discuss@lists.starlingx.io
Cc: Khalil, Ghada <Ghada.Khalil@windriver.com>; Waines, Greg <Greg.Waines@windriver.com>; Balaraj, Juanita <Juanita.Balaraj@windriver.com>;
Camp, MaryX <maryx.camp@intel.com>
Subject: [Starlingx-discuss] stx docs input: 1883300
Hi All:
Here is the doc info for:
Support for ICA signed ssl, docker_registry certifcate installation:
The fix is delivered as:
With this bug fix released, ICA (intermediate CA) signed ssl, docker_registry
certificate can be installed by the following command respectively:
system certificate-install -m ssl <ssl cert pem file>
system certificate-install -m docker_registry <docker registry cert pem file>
An ICA signed ssl, docker_registry certificate contains the final server
certificate, and the intermediate CA certificates signing the final server
certificate.
In the pem file passed to system certificate install command, the certificates
should be ordered such that each of the certificate is signed by the succeeding
one, with the final server certificate as the very first in the list.
Please let me know if you have any questions.
Thanks,
Andy