releng/docs.git
6 years agoFix sandbox typos 89/11889/1
Tim Johnson [Fri, 20 Jul 2018 19:15:20 +0000 (15:15 -0400)]
Fix sandbox typos

Split out from Ic40a4bb082b60e3d4550cc2a1703802f4e139332.

Change-Id: I09bc85534cdfe4a2c4e8f3593ca5f5c29f6a17d5
Signed-off-by: Tim Johnson <tijohnson@linuxfoundation.org>
6 years agoMerge "Add Artifact Upload permission to LF Deploy Role"
Andrew Grimberg [Fri, 20 Jul 2018 15:28:11 +0000 (15:28 +0000)]
Merge "Add Artifact Upload permission to LF Deploy Role"

6 years agoAdd emacs metadata to .gitignore 71/11871/1
Tim Johnson [Thu, 19 Jul 2018 23:50:11 +0000 (16:50 -0700)]
Add emacs metadata to .gitignore

Change-Id: I81fcbea4e77786e79ff9653eee39f239c4444718
Signed-off-by: Tim Johnson <tijohnson@linuxfoundation.org>
6 years agoAdd Artifact Upload permission to LF Deploy Role 66/11866/1
Thanh Ha [Thu, 19 Jul 2018 22:39:03 +0000 (18:39 -0400)]
Add Artifact Upload permission to LF Deploy Role

This permission is necessary in order to use the Rest API
/service/local/artifact/maven/content

Change-Id: I4ede2e3ea6f77a558d50ff2731280d803e7cefb0
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Add pre-commit hook for trailing-whitespace"
Andrew Grimberg [Thu, 19 Jul 2018 15:01:15 +0000 (15:01 +0000)]
Merge "Add pre-commit hook for trailing-whitespace"

6 years agoRemove obsolete note about post-build-script 50/11850/1
Thanh Ha [Wed, 18 Jul 2018 23:30:29 +0000 (19:30 -0400)]
Remove obsolete note about post-build-script

This note no longer applies since most projects should be on JJB
2.0.3 or later at this point.

Change-Id: I457300147ecef35cb5047882a3ed9fd7d7bd9534
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd pre-commit hook for trailing-whitespace 31/11831/1
Thanh Ha [Wed, 18 Jul 2018 01:28:53 +0000 (21:28 -0400)]
Add pre-commit hook for trailing-whitespace

Install using tox:

    tox -e check-hooks

ref: https://pre-commit.com

Change-Id: Ie7882b59f1817708b5365cb0490e644d3a411b93
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoUpdate jenkins-init-script to use global-jjb 08/11808/1
Thanh Ha [Tue, 17 Jul 2018 15:03:22 +0000 (11:03 -0400)]
Update jenkins-init-script to use global-jjb

Patch I68e242297db03752fcc415e5465e7bfa8ab66d79 in global-jjb added
support for a centralized jenkins-init-script. Update bootstrap
instructions to refer to that instead of having projects create their
own.

Change-Id: If7dc0eb8f972fd08de018228758e2fb6944bd392
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd script to scan for best practices 52/10052/6
Thanh Ha [Mon, 16 Apr 2018 23:48:28 +0000 (19:48 -0400)]
Add script to scan for best practices

Script ensures we are following best practices in our documentation.

Change-Id: Ibb7f62230657fb0cc1fb7e186f315aefd02dada2
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoDO NOT tell user to `sudo pip` 27/11727/1
Thanh Ha [Wed, 11 Jul 2018 15:47:41 +0000 (11:47 -0400)]
DO NOT tell user to `sudo pip`

We should never tell a user to `sudo pip` as this is a fast way to
break your package manager.

Change-Id: I98a63e03d7b6dd323a08da3529f5e1ae739f778b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Nexus 2 lftools info 59/11559/9
Jessica Wagantall [Tue, 26 Jun 2018 19:37:00 +0000 (12:37 -0700)]
Add Nexus 2 lftools info

Add documentation on how to create Nexus 2 repos
using lftools.
Add examples of the files taken as parameter.

Change-Id: I7c3344d83b9419aed1c9a367ec4e35011eb0bedb
Issue-ID: RELENG-954
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoUpdate intersphinx URL 60/11560/1
Jessica Wagantall [Tue, 26 Jun 2018 20:11:58 +0000 (13:11 -0700)]
Update intersphinx URL

Update sphinx URL for "Link to other
projects’ documentation"

Change-Id: Iad4cfbc2e1834a77cb52d4498a76c7fc86b95ced
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoMerge changes from topic '11393'
Andrew Grimberg [Sat, 23 Jun 2018 15:07:06 +0000 (15:07 +0000)]
Merge changes from topic '11393'

* changes:
  Add Nexus 3 bootstrap docs
  Add Nexus as log server cfg docs
  Add Nexus 2 bootstrap documentation

6 years agoMerge "Add retain_anchors to JJB CLI configuration"
Andrew Grimberg [Sat, 23 Jun 2018 15:02:38 +0000 (15:02 +0000)]
Merge "Add retain_anchors to JJB CLI configuration"

6 years agoMerge "Mention that crudini is required for script"
Andrew Grimberg [Sat, 23 Jun 2018 14:55:51 +0000 (14:55 +0000)]
Merge "Mention that crudini is required for script"

6 years agoFix jenkins-files link syntax 40/11540/1
Thanh Ha [Sat, 23 Jun 2018 13:20:37 +0000 (09:20 -0400)]
Fix jenkins-files link syntax

Syntax was wrong causing the link to not link to the write URL.

Change-Id: I761915698d38d22506353ad76ead15cf0c55b194
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoFix jenkins ssh credential id 38/11538/1
Andrew Grimberg [Sat, 23 Jun 2018 00:44:20 +0000 (17:44 -0700)]
Fix jenkins ssh credential id

The scripts, per the documentation, all expect that the Jenkins SSH
credential will have an ID of jenkins-ssh. Make sure it is actually
recorded that way.

Change-Id: I986c3094a0907ae08d988c6f2a37d83c3a620bcc
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
6 years agoAdd Nexus 3 bootstrap docs 54/11454/5
Thanh Ha [Wed, 20 Jun 2018 16:47:26 +0000 (12:47 -0400)]
Add Nexus 3 bootstrap docs

Issue: RELENG-966
Change-Id: I697085b5a3d8fac0288d9ab04e85da8cbd529676
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Nexus as log server cfg docs 93/11393/6
Thanh Ha [Mon, 18 Jun 2018 19:52:16 +0000 (15:52 -0400)]
Add Nexus as log server cfg docs

Change-Id: Ife2210a87ca2f4690233b2b3c8967a3c231f0dab
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Nexus 2 bootstrap documentation 86/11386/9
Thanh Ha [Mon, 18 Jun 2018 17:29:46 +0000 (13:29 -0400)]
Add Nexus 2 bootstrap documentation

Issue: RELENG-965
Change-Id: I6be9dd48463a9985900e899c5558e8e9afd5cb81
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd retain_anchors to JJB CLI configuration 10/11510/1
Anil Belur [Thu, 21 Jun 2018 23:43:32 +0000 (09:43 +1000)]
Add retain_anchors to JJB CLI configuration

Change-Id: Ie9a765a04b96dc4573ef31714af86c34d4528808
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
6 years agoMerge "Be more specific for the user data file"
Anil Belur [Thu, 21 Jun 2018 21:58:46 +0000 (21:58 +0000)]
Merge "Be more specific for the user data file"

6 years agoBe more specific for the user data file 98/11498/1
Andrew Grimberg [Thu, 21 Jun 2018 20:05:14 +0000 (13:05 -0700)]
Be more specific for the user data file

jenkins-init-system is a confusing name for an OpenStack User Data file
and can easily cause someone to create an improperly identified managed
config file

Change-Id: I7f1f2711ef00a9990f718eaf313ad0a3f524a76e
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
6 years agoMention that crudini is required for script 87/11487/2
Thanh Ha [Thu, 21 Jun 2018 17:03:07 +0000 (13:03 -0400)]
Mention that crudini is required for script

Change-Id: Ib4e8ad52a14b34c2c5fc040e0c1e3d67b1c4e380
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd missing space in section header 86/11486/1
Thanh Ha [Thu, 21 Jun 2018 17:00:38 +0000 (13:00 -0400)]
Add missing space in section header

Change-Id: Ie86d76bb0493eb474380752adc9e502b40a17fe6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Nexus 2 users and roles docs. 60/11360/9
Jessica Wagantall [Fri, 15 Jun 2018 21:25:14 +0000 (14:25 -0700)]
Add Nexus 2 users and roles docs.

Add Nexus 2 documentation explaining users, roles
and privileges and how they are all related.
Include links to official documentation.

Change-Id: I24629d55b6dc6e961aa00a2bf401961cdc0ff2e4
Issue-ID: RELENG-969
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoMerge "Add Nexus 2 repo docs."
Thanh Ha [Wed, 20 Jun 2018 15:02:50 +0000 (15:02 +0000)]
Merge "Add Nexus 2 repo docs."

6 years agoAdd Nexus 2 repo docs. 24/11324/8
Jessica Wagantall [Fri, 15 Jun 2018 02:48:29 +0000 (19:48 -0700)]
Add Nexus 2 repo docs.

Add Nexus 2 documentation on repositories.
This documentation contains a brief explanation
on the repos used by most LF projects.

Change-Id: I6c32876da8fc9d6576bbde6343a9880abbb7504c
Issue-ID: RELENG-968
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoAdd section for MeetBot guide 88/11088/25
Anil Belur [Wed, 6 Jun 2018 22:02:13 +0000 (08:02 +1000)]
Add section for MeetBot guide

MeetBot Guide:
- Start and end a meeting
- Take notes
- Post-meeting work

Ref: https://wiki.acumos.org/display/MEET/Meetbot+Tips

JIRA: RELENG-876
Change-Id: I94486a1edd821f511d4cb84ceec18df50d8d486b
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
6 years agoAdd npm / nodejs metadata to .gitignore 91/11391/1
Thanh Ha [Mon, 18 Jun 2018 19:13:01 +0000 (15:13 -0400)]
Add npm / nodejs metadata to .gitignore

Change-Id: I1e958b1897e1e2bfea4274b7a55f33d5c586932f
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd post bootstrap considerations 41/11141/2
Thanh Ha [Fri, 8 Jun 2018 15:34:55 +0000 (11:34 -0400)]
Add post bootstrap considerations

Change-Id: I9a96fc880cb307ade1a6ec5d0e00c2d3a898d8bb
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoComplete ci-management bootstrap steps 00/10900/18
Thanh Ha [Wed, 30 May 2018 21:58:20 +0000 (17:58 -0400)]
Complete ci-management bootstrap steps

Issue: RELENG-981
Change-Id: Ia372d258bb5db9d6944346bab73ca0509ce2a463
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Jenkins Bootstrap documentation 03/10903/13
Thanh Ha [Thu, 31 May 2018 00:25:15 +0000 (20:25 -0400)]
Add Jenkins Bootstrap documentation

Issue: RELENG-981
Change-Id: I1f1902bb4c699ea43e3df319b483ebfb395733e3
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoSwitch instances of PROJECT_DOMAIN to example.org 54/11354/2
Thanh Ha [Fri, 15 Jun 2018 19:48:48 +0000 (15:48 -0400)]
Switch instances of PROJECT_DOMAIN to example.org

example.org reads better and we seem to have a mixed use of
PROJECT_DOMAIN vs example.org, let's just switch to the one format
for consistency.

Change-Id: I556c285220bf366b7da9cf0545937610978545bd
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Add Jenkins Security configuration docs"
Jessica Wagantall [Thu, 14 Jun 2018 02:16:26 +0000 (02:16 +0000)]
Merge "Add Jenkins Security configuration docs"

6 years agoAdd Report Issue ribbon 55/11155/6
Thanh Ha [Sun, 10 Jun 2018 04:14:53 +0000 (00:14 -0400)]
Add Report Issue ribbon

Add a ribbon on the top right of the page which when clicked will
direct the reader to LF Jira to open an issue with the doc. It also
prefills the description with the version of dosc and current page
the user was viewing when they clicked the ribbon.

Change-Id: If8be81ec7a1c4a9b7b4ed21e5cafe65c98845e42
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd Jenkins Security configuration docs 51/11151/2
Thanh Ha [Sat, 9 Jun 2018 17:46:12 +0000 (13:46 -0400)]
Add Jenkins Security configuration docs

Issue: RELENG-981
Change-Id: I95917b9768a5cf70b39f9c0c5f922239a3881276
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Update links and best practices in Ansible doc"
Anil Belur [Sun, 10 Jun 2018 05:45:52 +0000 (05:45 +0000)]
Merge "Update links and best practices in Ansible doc"

6 years agoUse auto-enumerated lists and fix formatting 54/11154/1
Anil Belur [Sat, 9 Jun 2018 22:30:30 +0000 (08:30 +1000)]
Use auto-enumerated lists and fix formatting

Change-Id: Id0fcaf1a357cae17e730247311b17209502fdd94
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
6 years agoUpdate links and best practices in Ansible doc 53/11153/1
Thanh Ha [Sat, 9 Jun 2018 18:39:54 +0000 (14:39 -0400)]
Update links and best practices in Ansible doc

Update links to remove unnecessary namespacing and add upstream
Ansible intersphinx link so that we do not have to direct link.

Change-Id: I63aa47ad055fd5ec7f72b69e4dde4f71646000c6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd GitHub DCO setup instructions 40/11140/4
Thanh Ha [Fri, 8 Jun 2018 15:28:42 +0000 (11:28 -0400)]
Add GitHub DCO setup instructions

Change-Id: I02987ba54fe72d3f11806f46d2e52b9ee26298dc
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Add documentation on intersphinx mapping"
Andrew Grimberg [Thu, 7 Jun 2018 19:43:53 +0000 (19:43 +0000)]
Merge "Add documentation on intersphinx mapping"

6 years agoAdd Jenkins GitHub integration instructions 85/10985/2
Thanh Ha [Tue, 5 Jun 2018 03:02:16 +0000 (23:02 -0400)]
Add Jenkins GitHub integration instructions

Change-Id: I50c48911a62a4dc618d414cf9681a78214939a8d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoRename to infra-bootstrap 73/10973/2
Thanh Ha [Mon, 4 Jun 2018 19:27:30 +0000 (15:27 -0400)]
Rename to infra-bootstrap

This doc is about bootstrapping a brand new infra for a new project.
Rename to classify it more appropriately.

Change-Id: I93f2a425b70dfe414bdbd0e0abfd2e74aadfdd56
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoAdd documentation on intersphinx mapping 22/10922/4
Thanh Ha [Fri, 1 Jun 2018 01:21:11 +0000 (21:21 -0400)]
Add documentation on intersphinx mapping

Provide intersphinx documentation that might not be obvious
from the upstream Sphinx documentation.

Change-Id: I6d92cf4e03e662ad6880a7f9f61bdc54759dc6f0
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Create environment overview page"
Jessica Wagantall [Fri, 1 Jun 2018 21:30:58 +0000 (21:30 +0000)]
Merge "Create environment overview page"

6 years agoMerge "Add link to common-packer documentation"
Thanh Ha [Fri, 1 Jun 2018 20:39:14 +0000 (20:39 +0000)]
Merge "Add link to common-packer documentation"

6 years agoFix doc link to "Sharing instance images" 08/10908/2
Thanh Ha [Thu, 31 May 2018 17:42:58 +0000 (13:42 -0400)]
Fix doc link to "Sharing instance images"

Change-Id: I081679edd43396ddc7d85bb6580d5ee584e5a8bb
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoMerge "Move Jenkins Sandbox documentation to its own file"
Thanh Ha [Thu, 31 May 2018 20:40:33 +0000 (20:40 +0000)]
Merge "Move Jenkins Sandbox documentation to its own file"

6 years agoMove Jenkins Sandbox documentation to its own file 13/10913/1
Trevor Bramwell [Wed, 30 May 2018 22:14:48 +0000 (15:14 -0700)]
Move Jenkins Sandbox documentation to its own file

Includes a hidden toctree on the Jenkins documentation page to keep
Sphinx from complaining the file is not included.

Issue: RELENG-921
Change-Id: Ife0de85051acbc6eb80e6a97e124b7f0eef302fe
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
6 years agoCreate environment overview page 96/10896/4
Andrew Grimberg [Wed, 30 May 2018 20:55:10 +0000 (13:55 -0700)]
Create environment overview page

New projects in particular need documentation on the services that are
being given to them in a standard environment setup.

They should also be informed of conventions and requirements related to
code that is being contributed as seed code and the differences between
pre-formation and post-formation phases of the infrastructure

Issue: RELENG-732
Change-Id: I1c9bd03c3fc3ed42ede8e42da896ce59698c3925
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
6 years agoMerge "Remove echo statement"
Andrew Grimberg [Thu, 31 May 2018 17:45:37 +0000 (17:45 +0000)]
Merge "Remove echo statement"

6 years agoAdd documentation on build minions 31/10731/10
Jessica Wagantall [Mon, 21 May 2018 08:29:41 +0000 (01:29 -0700)]
Add documentation on build minions

Add informtion on Jenkins build minions
- Explanation on the topic
- Pointer to packer images section
- How to configure a cloud and templates

Issue: RELENG-548
Change-Id: I69103e717e704cc78128cf500886b5a97051a0d7
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoRemove echo statement 01/10901/1
Thanh Ha [Thu, 31 May 2018 00:12:09 +0000 (20:12 -0400)]
Remove echo statement

Sphinx already prints 'The HTML pages are in docs/_build/html.' at the
end of a build. This is redundent and not cross platform compatible
(fails on Windows).

Change-Id: I993893bc797e579d2b3d34cf6c2c9230264cb1ca
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoUpdate Nexus Sonatype link 36/10836/3
Jessica Wagantall [Tue, 29 May 2018 18:02:21 +0000 (11:02 -0700)]
Update Nexus Sonatype link

Do not link project commercial page.
Only link official Nexus 2 documentation.

Change-Id: Iba67524f58327cc639b58a9ab62b517ab9f68348
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoAdd Nexus 2 documentation 66/10666/3
Jessica Wagantall [Wed, 16 May 2018 05:14:48 +0000 (22:14 -0700)]
Add Nexus 2 documentation

Add Nexus 2 Repository Manager documentation
- Add basic introduction
- Add explanation on how to browse
- Add helpful images

Issue: RELENG-952
Change-Id: I0b16dfc6f163d984e317d21907652844800e15b8
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoMerge "Share images between OpenStack tenants"
Anil Belur [Tue, 15 May 2018 22:25:33 +0000 (22:25 +0000)]
Merge "Share images between OpenStack tenants"

6 years agoRemove completed TODO items 77/10377/2
Thanh Ha [Wed, 2 May 2018 19:41:43 +0000 (15:41 -0400)]
Remove completed TODO items

Change-Id: Iaf2115da12642cff1583cc064e19048bae9f8d7b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoShare images between OpenStack tenants 68/10368/3
Andrew Grimberg [Wed, 2 May 2018 19:12:17 +0000 (12:12 -0700)]
Share images between OpenStack tenants

Document how to share OpenStack images between different tenants on
the same OpenStack cloud provider.

Issue: RELENG-851
Change-Id: Ic038afa78774ce0b67c815c871396278f6e5239c
Signed-off-by: Andrew Grimberg <agrimberg@linuxfoundation.org>
6 years agoAdd link to common-packer documentation 76/10376/1
Thanh Ha [Wed, 2 May 2018 19:40:32 +0000 (15:40 -0400)]
Add link to common-packer documentation

Change-Id: I4dde340173c05976bf8e17879c2a5904275a5078
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoFix links to use doc links rather than labels 75/10375/1
Thanh Ha [Wed, 2 May 2018 19:38:02 +0000 (15:38 -0400)]
Fix links to use doc links rather than labels

Doc links are a little nicer if you want to link to a specific
doc rather than a section within a doc.

Change-Id: Ia3656c1de4cea48754e3f6dc6d8b76d7acd5f9d0
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
6 years agoRe-word best-practices 17/10317/5
Jessica Wagantall [Tue, 1 May 2018 20:20:20 +0000 (13:20 -0700)]
Re-word best-practices

- Do not use "you" in sentences.
- Capitalize few of the brand names used.
- Re-word some instructions to make it more direct
  with less wording.

Issue: RELENG-507
Change-Id: I92813bf51ec13a2339df3dc5065266223cfe51a4
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
6 years agoMerge "Add Sandbox vs Prod details"
Andrew Grimberg [Mon, 30 Apr 2018 15:51:06 +0000 (15:51 +0000)]
Merge "Add Sandbox vs Prod details"

7 years agoMerge "Add section on Jenkins Job Builder"
Jessica Wagantall [Fri, 27 Apr 2018 22:30:28 +0000 (22:30 +0000)]
Merge "Add section on Jenkins Job Builder"

7 years agoMerge "Update rtd-jobs configuration docs for v2 API"
Anil Belur [Fri, 27 Apr 2018 22:12:02 +0000 (22:12 +0000)]
Merge "Update rtd-jobs configuration docs for v2 API"

7 years agoUpdate rtd-jobs configuration docs for v2 API 61/10261/2
Thanh Ha [Fri, 27 Apr 2018 16:44:55 +0000 (12:44 -0400)]
Update rtd-jobs configuration docs for v2 API

Update the project documentation section to reflect changes in
global-jjb to use the v2 RTD API.

Change-Id: I6171007fd13fbc08c2cf22ef11ee21fc201a4ebe
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoAdd section on Jenkins Job Builder 00/9900/27
Anil Belur [Tue, 10 Apr 2018 09:56:53 +0000 (19:56 +1000)]
Add section on Jenkins Job Builder

- Jenkins Job Builder
  - JJB Overview
  - Install JJB
  - Virtual Environments
  - Install JJB using pip

RELENG-551
Change-Id: I93c11f2f71c360a92b709a7fbbd4c566caca6997
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
7 years agoAdd Sandbox vs Prod details 20/10220/6
Jessica Wagantall [Tue, 24 Apr 2018 22:15:06 +0000 (15:15 -0700)]
Add Sandbox vs Prod details

- Add an explanation on Jenkins Sandbox and how it
compares to Jenkins Production.
- Where to access them.
- Limitations.
- Move entire section right before Jenkins Sandbox topic.
- Add a small correction to the title "Get access to the
  Sandbox" to make it more specific (corrected to
  "Get access to the Jenkins Sandbox"

Change-Id: I7c06e8666f2591e43891362bcfa0065752779546
Issue-ID: RELENG-547
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoRemove step about setting lf-ansible 22/10222/1
Thanh Ha [Wed, 25 Apr 2018 00:12:34 +0000 (20:12 -0400)]
Remove step about setting lf-ansible

This set is no longer necessary because we are using Ansible Galaxy.

Change-Id: If4ffb8019e3c52f752182c6542ff296f6fd12cd9
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoAdd .readthedocs.conf 06/10206/1
Thanh Ha [Tue, 24 Apr 2018 17:02:17 +0000 (13:02 -0400)]
Add .readthedocs.conf

According to RTD they support a repo level config file now. Let's
try it with lf-docs and port it to more projects if it works.

https://docs.readthedocs.io/en/latest/yaml-config.html

Change-Id: Idae136065804d7103126b870bcb8a570859e46b0
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoFix Gerrit topic title. 98/10198/1
Jessica Wagantall [Mon, 23 Apr 2018 20:46:38 +0000 (13:46 -0700)]
Fix Gerrit topic title.

Fix Gerrit documentation topic title to
make it imperative like all other topic
titles.

Change-Id: I66f3276fdaa57392f283f2330b8f5163d9609d68
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoFail Sphinx build even on warnings 81/10181/1
Thanh Ha [Fri, 20 Apr 2018 18:43:32 +0000 (14:43 -0400)]
Fail Sphinx build even on warnings

Change-Id: Id1ee90c2a463567c4cc8f7fd770c1b622d0f6ee0
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoMerge "Add Jenkins Quick Start"
Anil Belur [Thu, 12 Apr 2018 01:25:49 +0000 (01:25 +0000)]
Merge "Add Jenkins Quick Start"

7 years agoAdd Jenkins Quick Start 43/9743/12
Jessica Wagantall [Wed, 4 Apr 2018 21:00:10 +0000 (14:00 -0700)]
Add Jenkins Quick Start

Add Jenkins initial overview and introduction to jjb.
Add Jenkins Quick Start:
  - Quick start introduction and explanation on how
    jobs are defined.
  - Example of a project yaml and explanation on how
    to add local jobs and global-jjb jobs
Jenkins Production and Sandbox introduction

Issue: RELENG-546
Change-Id: I848ab61f2924686cd0f71e3f3e3e9f4cec5ade00
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoAdd note about SNI issues with Nexus 53/9853/1
Thanh Ha [Mon, 9 Apr 2018 17:57:46 +0000 (13:57 -0400)]
Add note about SNI issues with Nexus

Issue: RELENG-806
Change-Id: Id4251ea866b4c76e36cfd5f1996f03991b66b674
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoAdd links to Change-Id docs 44/9844/1
Thanh Ha [Mon, 9 Apr 2018 14:14:06 +0000 (10:14 -0400)]
Add links to Change-Id docs

Includes some minor word editing as well.

Change-Id: I512485e1252fea1b44a43b1056233089f47aac5e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoMerge "Update log server section"
Anil Belur [Fri, 6 Apr 2018 10:32:19 +0000 (10:32 +0000)]
Merge "Update log server section"

7 years agoMerge "Update cleanup schedule for jobs & logs"
Anil Belur [Fri, 6 Apr 2018 10:32:06 +0000 (10:32 +0000)]
Merge "Update cleanup schedule for jobs & logs"

7 years agoMerge "Link to Global JJB Job template documentation"
Anil Belur [Thu, 22 Mar 2018 01:35:06 +0000 (01:35 +0000)]
Merge "Link to Global JJB Job template documentation"

7 years agoMerge "Set maxdepth to 1 for TOC"
Jessica Wagantall [Wed, 21 Mar 2018 23:35:08 +0000 (23:35 +0000)]
Merge "Set maxdepth to 1 for TOC"

7 years agoUpdate log server section 04/9504/4
Anil Belur [Tue, 20 Mar 2018 01:07:06 +0000 (11:07 +1000)]
Update log server section

Update the file compression format and Jenkins Sandbox and
Production locations.

Change-Id: I9e5345a5d8f2ef1df7312b6eff2e468f6dcd42bc
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
7 years agoLink to Global JJB Job template documentation 33/9533/1
Thanh Ha [Wed, 21 Mar 2018 17:03:01 +0000 (13:03 -0400)]
Link to Global JJB Job template documentation

Issue: RELENG-552
Change-Id: I46e7088d65bdb1dd4eb9fe1175d328e75633b81d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoUpdate cleanup schedule for jobs & logs 84/9484/11
Anil Belur [Mon, 19 Mar 2018 06:03:02 +0000 (16:03 +1000)]
Update cleanup schedule for jobs & logs

JIRA: RELENG-550
Change-Id: If2aa67761d402f557ab837ff80fa3021539c56d2
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
7 years agoFail build on Sphinx warnings 01/9501/2
Thanh Ha [Mon, 19 Mar 2018 22:20:51 +0000 (18:20 -0400)]
Fail build on Sphinx warnings

Resolve Sphinx warnings and enable flag to fail the build on
warnings. Sphinx has many warnings that should be treated as
real issues so is a useful flag to set.

Change-Id: I96ee6cab4617b2b42cc91dda5a795a8ef658a42f
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoMerge "Add signing details for commits"
Thanh Ha [Mon, 19 Mar 2018 21:23:19 +0000 (21:23 +0000)]
Merge "Add signing details for commits"

7 years agoSet maxdepth to 1 for TOC 98/9498/1
Thanh Ha [Mon, 19 Mar 2018 20:56:39 +0000 (16:56 -0400)]
Set maxdepth to 1 for TOC

We now have quite a few Guides listed so lower the maxdepth
to 1 so that the landing page is not as busy.

Change-Id: I6bd78bc728b4c8c676ec362836992b751dbe5612
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoAdd signing details for commits 45/9345/17
Jessica Wagantall [Wed, 7 Mar 2018 21:23:07 +0000 (13:23 -0800)]
Add signing details for commits

- Prerequisites before using Gerrit
- Signing Gerrit Commits
  - Generating the GPG key
  - Install gpg
  - Adding your key to Gerrit
  - Set up Git to sign commits
  - Commit and push a change

Change-Id: I8ebe6615ead80608e9256e782e63de1302c856ad
Issue-ID: RELENG-556
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoAppendix Gerrit Topics 83/9383/5
Thanh Ha [Sun, 11 Mar 2018 04:49:57 +0000 (23:49 -0500)]
Appendix Gerrit Topics

Additional detail regarding Gerrit Topics and 3 ways to push
them depending on preference.

Issue: https://jira.opendaylight.org/browse/DOCS-21
Change-Id: Ia257a1a5a08aaf3ed13612316b424f16bd197e4d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoImprove 'Update an existing patch' section 19/9319/2
Thanh Ha [Wed, 7 Mar 2018 17:33:54 +0000 (12:33 -0500)]
Improve 'Update an existing patch' section

Add more details and reword some of the sections so that it is more
complete. Pull in some information from the OpenDaylight docs wiki
https://wiki.opendaylight.org/view/Documentation/Tools#Common_Doc_Tasks

Issue: https://jira.opendaylight.org/browse/DOCS-41
Change-Id: Ie683c4cea16be40525e8af6788e884fafc3d2e86
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoMove Infrastructure Guide to LF Internal section 16/9416/1
Thanh Ha [Tue, 13 Mar 2018 15:49:32 +0000 (11:49 -0400)]
Move Infrastructure Guide to LF Internal section

These docs are not really end user docs and is more for the
releng team consumption so move to more appropriate section.

Change-Id: I9523b7270e58ca05974c1b05181510d2934bcf46
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoCorrect document titles 04/9404/1
Jessica Wagantall [Mon, 12 Mar 2018 20:42:55 +0000 (13:42 -0700)]
Correct document titles

Correct documentation titles to make them
imperative mode.

Change-Id: Idfa872fb76462474daa02776029c72baf5097519
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoMerge "How to update patches with dependent changes"
Jessica Wagantall [Mon, 12 Mar 2018 20:29:32 +0000 (20:29 +0000)]
Merge "How to update patches with dependent changes"

7 years agoMerge "Rework Gerrit push patch section with more detail"
Jessica Wagantall [Mon, 12 Mar 2018 20:29:23 +0000 (20:29 +0000)]
Merge "Rework Gerrit push patch section with more detail"

7 years agoHow to update patches with dependent changes 84/9384/5
Thanh Ha [Sun, 11 Mar 2018 05:06:12 +0000 (00:06 -0500)]
How to update patches with dependent changes

Add details on how to update patches that have dependent
changes in Gerrit.

Issue: https://jira.opendaylight.org/browse/DOCS-21
Change-Id: Id4cd47bcb6e6aee08ae64a2d6e19153e14c3c5f4
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoAdd Packer Image documentation 06/9306/5
Thanh Ha [Wed, 7 Mar 2018 01:33:16 +0000 (20:33 -0500)]
Add Packer Image documentation

Provide documentation on how one can use JJB / Jenkins jobs
in the Jenkins Sandbox in order to develop and test new image
types.

Issue: RELENG-829
Change-Id: I9b2109f5b0e165bff2be3af267857a7ff02e19d8
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoRework Gerrit push patch section with more detail 26/9326/4
Thanh Ha [Wed, 7 Mar 2018 18:50:39 +0000 (13:50 -0500)]
Rework Gerrit push patch section with more detail

Improve the details provided in the patch push section of the Gerrit
guide and add appropriate interdoc links to jump around.

Also replace instances of you/your with we/our.

Issue: https://jira.opendaylight.org/browse/DOCS-41
Change-Id: Id9e96dba28f9f22b8c93a7b0e5546138cfa4c520
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
7 years agoUpdate inventory list 61/9361/1
Jessica Wagantall [Thu, 8 Mar 2018 18:34:36 +0000 (10:34 -0800)]
Update inventory list

Remove build.iotivity.org from the inventory list

Change-Id: I96ff121f8d26acf979a55ef33eeae6229527bcf5
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
7 years agoMerge "Add Log server documentation"
Andrew Grimberg [Wed, 7 Mar 2018 16:55:14 +0000 (16:55 +0000)]
Merge "Add Log server documentation"

7 years agoMerge "Add project-bootstrap checklist"
Andrew Grimberg [Wed, 7 Mar 2018 16:04:51 +0000 (16:04 +0000)]
Merge "Add project-bootstrap checklist"

7 years agoAdd project-bootstrap checklist 86/8386/4
Thanh Ha [Fri, 12 Jan 2018 20:33:30 +0000 (15:33 -0500)]
Add project-bootstrap checklist

Issue: RELENG-513
Change-Id: I79d6b44d6538af6d6ef459c318a19240c4fac485
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>