Morgan, Andrew,
Good points about CI/CD for documentation. I am going through the docs from
a HEAT and OOM deployment perspective and ran into some issues - one of them.
https://jira.onap.org/browse/DOC-160 = ReadTheDocs links to Confluence
fail to adhere to moved pages - require Jenkins link validation job
Everything in public is the way to go - thank you
https://lists.onap.org/pipermail/onap-discuss/2017-November/006218.html
I currently cannot get job creation on the sandbox Jenkins server - raising
a LF ticket - let us know if you are able to get a job up.
https://wiki.onap.org/display/DW/Configuring+Jenkins
https://jenkins.onap.org/sandbox/
Thank you
/michael
-Original Message-
From: onap-discuss-boun...@lists.onap.org
[mailto:onap-discuss-boun...@lists.onap.org] On Behalf Of Andrew Grimberg
Sent: Monday, November 13, 2017 10:20
To: morgan.richo...@orange.com; rb2...@att.com; gg2...@att.com; DEBEAU Eric
IMT/OLN <eric.deb...@orange.com>; thanh...@linuxfoundation.org;
onap-discuss@lists.onap.org
Subject: Re: [onap-discuss] [ONAP] [releng] add rest doc check on jenkins gating
Greetings Morgan,
First, as ONAP is an open source project, please ask your questions out in the
public. Closed door discussions do not help the community. As such, I've added
the ONAP discuss list.
Second, global-jjb is an also open source and anyone can contribute to it. The
project generally sees a release every 2 weeks, though we do sometimes do off
cycle point releases to fix bugs. You just need to contribute in the LF gerrit
[0] as global-jjb is shared by all of the projects that engage LF Release
Engineering services.
-Andy-
[0]
https://gerrit.linuxfoundation.org/infra/#/admin/projects/releng/global-jjb
On 11/13/2017 05:46 AM, morgan.richo...@orange.com wrote:
> Hi
>
> do you think it would be possible to add a documentation gating on the
> generic macro?
>
> the idea would be for any repo, if "docs" sub-directory exists, to
> perform a doc8 check
>
> it will avoid hundreds of Warnings and Errors and provide a better
> overall quality Each project will remain responsible of the integrity
> of its rst files, the doc project cannot be responsible for the rst of
> all the projects
>
> My idea would be to add "ci-management-doc" in {project}-verify-jjb as
> we have a check unicode
> (https://git.onap.org/ci-management/tree/jjb/ci-management/ci-manageme
> nt.yaml)
>
> ci-management-doc will be declared in
> https://git.onap.org/ci-management/tree/jjb/global-macros.yaml
>
> - builder:
> name: ci-management-check-doc
> builders:
> - shell: |
> $WORKSPACE/scripts/check-code.sh
>
> and check-code will perform a simple doc8 check (see
> https://git.opnfv.org/opnfvdocs/tree/scripts/docs-build.sh or create
> virtual env and run a tox -edocs on each repo on patch submission
> jenkins jobs env is not always easy to setup, is there any sandbox to
> test jenkins jobs in ONAP?
>
> if errors => jenkins vote -1
> at the beginning some projects may have to fix their doc
> errors...before getting a +1 from jenkins, but the sooner the better...
> most of the projects are already clean on this aspect
>
> in // I strongly suggest to add the -W option in the docs project when
> generating sphinx documentation. -W means Warnings = Errors, jenkins
> will vote -1 if there is 1 Warning. This option is adopted in
> OpenStack and some OPNFV projects.
> As for the project gating, at the beginning some people may complain
> but at the end it is better for the community...
>
> what is your view?
> Who is contributing to the generic jobs/macros? Shall I suggest a
> patch (as said I am blind to test..so I assume ci-management team
> (Andrew?) would have a better view on how to do this) shall I open a
> ticket in helpdesk?
>
> Thanks
>
> /Morgan
>
>
> __
> ___
>
>
> Ce message et ses pieces jointes peuvent contenir des informations
> confidentielles ou privilegiees et ne doivent donc pas etre diffuses,
> exploites ou copies sans autorisation. Si vous avez recu ce message
> par erreur, veuillez le signaler a l'expediteur et le detruire ainsi
> que les pieces jointes. Les messages electroniques etant susceptibles
> d'alteration, Orange decline toute responsabilite si ce message a ete
> altere, deforme ou falsifie. Merci.
>
> This message and its attachments may contain confidential or
> privileged information that may be protected by law; they should not
> be distributed, used or copied without authorisation.
> If you have received this email in error, please notify the sender an
