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>
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>
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>
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>
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>
Jessica Wagantall [Thu, 14 Jun 2018 02:16:26 +0000 (02:16 +0000)]
Merge "Add Jenkins Security configuration docs"
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>
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>
Anil Belur [Sun, 10 Jun 2018 05:45:52 +0000 (05:45 +0000)]
Merge "Update links and best practices in Ansible doc"
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>
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>
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>
Andrew Grimberg [Thu, 7 Jun 2018 19:43:53 +0000 (19:43 +0000)]
Merge "Add documentation on intersphinx mapping"
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>
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>
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>
Jessica Wagantall [Fri, 1 Jun 2018 21:30:58 +0000 (21:30 +0000)]
Merge "Create environment overview page"
Thanh Ha [Fri, 1 Jun 2018 20:39:14 +0000 (20:39 +0000)]
Merge "Add link to common-packer documentation"
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>
Thanh Ha [Thu, 31 May 2018 20:40:33 +0000 (20:40 +0000)]
Merge "Move Jenkins Sandbox documentation to its own file"
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>
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>
Andrew Grimberg [Thu, 31 May 2018 17:45:37 +0000 (17:45 +0000)]
Merge "Remove echo statement"
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>
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>
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>
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>
Anil Belur [Tue, 15 May 2018 22:25:33 +0000 (22:25 +0000)]
Merge "Share images between OpenStack tenants"
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>
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>
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>
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>
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>
Andrew Grimberg [Mon, 30 Apr 2018 15:51:06 +0000 (15:51 +0000)]
Merge "Add Sandbox vs Prod details"
Jessica Wagantall [Fri, 27 Apr 2018 22:30:28 +0000 (22:30 +0000)]
Merge "Add section on Jenkins Job Builder"
Anil Belur [Fri, 27 Apr 2018 22:12:02 +0000 (22:12 +0000)]
Merge "Update rtd-jobs configuration docs for v2 API"
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>
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>
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>
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>
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>
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>
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>
Anil Belur [Thu, 12 Apr 2018 01:25:49 +0000 (01:25 +0000)]
Merge "Add Jenkins Quick Start"
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>
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>
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>
Anil Belur [Fri, 6 Apr 2018 10:32:19 +0000 (10:32 +0000)]
Merge "Update log server section"
Anil Belur [Fri, 6 Apr 2018 10:32:06 +0000 (10:32 +0000)]
Merge "Update cleanup schedule for jobs & logs"
Anil Belur [Thu, 22 Mar 2018 01:35:06 +0000 (01:35 +0000)]
Merge "Link to Global JJB Job template documentation"
Jessica Wagantall [Wed, 21 Mar 2018 23:35:08 +0000 (23:35 +0000)]
Merge "Set maxdepth to 1 for TOC"
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>
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>
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>
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>
Thanh Ha [Mon, 19 Mar 2018 21:23:19 +0000 (21:23 +0000)]
Merge "Add signing details for commits"
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>
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>
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>
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>
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>
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>
Jessica Wagantall [Mon, 12 Mar 2018 20:29:32 +0000 (20:29 +0000)]
Merge "How to update patches with dependent changes"
Jessica Wagantall [Mon, 12 Mar 2018 20:29:23 +0000 (20:29 +0000)]
Merge "Rework Gerrit push patch section with more detail"
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>
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>
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>
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>
Andrew Grimberg [Wed, 7 Mar 2018 16:55:14 +0000 (16:55 +0000)]
Merge "Add Log server documentation"
Andrew Grimberg [Wed, 7 Mar 2018 16:04:51 +0000 (16:04 +0000)]
Merge "Add project-bootstrap checklist"
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>
Thanh Ha [Wed, 7 Mar 2018 01:52:01 +0000 (20:52 -0500)]
Link to section on pushing jobs to Jenkins
Provide an explicit link to the section on how to push jobs
to the Jenkins Sandbox system.
Change-Id: I3b7576d03cb53afcc052ab273d4c3500fb4318ed
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Wed, 7 Mar 2018 01:31:37 +0000 (20:31 -0500)]
Add explicit link for Jenkins Sandbox section
Change-Id: Ibaf7f78cbe8cd84770d869f7bd05315470887d59
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Wed, 7 Mar 2018 00:33:18 +0000 (00:33 +0000)]
Merge "Reword Push jobs to sandbox section"
Thanh Ha [Tue, 6 Mar 2018 17:39:32 +0000 (12:39 -0500)]
Add Log server documentation
Provide details on the Log server system, how to access it, and
how long logs are stored before they are purged.
Issue: RELENG-549
Change-Id: I72b1b87964339c6583a9a74fae61a8555a76c519
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 6 Mar 2018 17:49:21 +0000 (12:49 -0500)]
Ignore all example.org URLs when link checking
Exclude example.org from URL link checking so that we can freely
use it as a placeholder URL.
Change-Id: I76a2b3a85f1ca294676fddaffd120d7854b671e4
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 6 Mar 2018 16:56:16 +0000 (11:56 -0500)]
Add placeholder text for Jenkins sections
Placeholder text for each section as defined in RELENG-510.
Change-Id: I881c254d5f2650b42a677a06a07043c91016bf92
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 6 Mar 2018 16:47:22 +0000 (11:47 -0500)]
Reword Push jobs to sandbox section
Improve this section with links and more clear explanation
of why and when to use each method.
Change-Id: Ibf81545e6d30889a34bbf99f152565bb81610ffe
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 6 Mar 2018 16:26:52 +0000 (11:26 -0500)]
Fix Jenkins Guide headers
The TOC for this guide is not properly generated and the heading
levels appear random. Fix the headers so that we get a proper
navigation bar.
Change-Id: Ibbe08dacb5b4c1fffc0c3bb02765a27ee5f307bd
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 2 Mar 2018 19:07:18 +0000 (19:07 +0000)]
Merge "Add how to code review a change"
Trevor Bramwell [Fri, 2 Mar 2018 18:52:04 +0000 (10:52 -0800)]
Remove Syntax Highlighting from Gerrit DCO
The default pygment selection in Sphinx is python. Setting this to
'none' removes the strange highlighting of python keywords in the
DCO document.
Change-Id: I86dd5984470055867309b32b4d7c6b3e5b3eca78
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Jessica Wagantall [Fri, 2 Mar 2018 07:41:35 +0000 (23:41 -0800)]
Add how to code review a change
Add documentation on how to code review:
- Pre-review
- Review
- Merge
Issue-ID: RELENG-559
Change-Id: I527e7aafd0b9a444fc6ac5593a96567bf0015598
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Thanh Ha [Sat, 24 Feb 2018 18:30:02 +0000 (13:30 -0500)]
Add DCO information
It is important that people understand what the Sign-off-by line
means when they make a contribution.
Issue: RELENG-560
Change-Id: I1c9500188c19e428681b9ec9c9e638af2262d4ff
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 23 Feb 2018 00:46:06 +0000 (00:46 +0000)]
Merge "Documentation on the topic of pushing patches"
C.J. Collier [Fri, 16 Feb 2018 21:55:55 +0000 (13:55 -0800)]
Documentation on the topic of pushing patches
docs/gerrit.rst
- How to push a new patch [RELENG-557]
- How to update an existing patch [RELENG-558]
Change-Id: I84522e25c9f5f65a063f782bfe27b64cf80fd616
Signed-off-by: C.J. Collier <cjcollier@linuxfoundation.org>
Co-Authored-By: Jessica Wagantall <jwagantall@linuxfoundation.org>
Thanh Ha [Thu, 22 Feb 2018 23:27:11 +0000 (23:27 +0000)]
Merge "Update Gerrit over HTTPS Documentation"
Thanh Ha [Thu, 22 Feb 2018 21:14:34 +0000 (21:14 +0000)]
Merge "Add docs on how to update Jenkins"
Thanh Ha [Thu, 22 Feb 2018 21:14:19 +0000 (21:14 +0000)]
Merge "Add Ansible Role creation documentation"
Trevor Bramwell [Thu, 22 Feb 2018 20:06:18 +0000 (12:06 -0800)]
Update Gerrit over HTTPS Documentation
- Add a note explaining the Linux Foundation Gerrit server and
configuration is being used for the examples.
- Add an explicit step to download the commit-msg hook as git-review is
buggy.
- Fix wording of notes regarding the Linux Foundation Gerrit specific
configuration.
Change-Id: I864a5d6c2d35312c33193f743589932e939ef0ae
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Trevor Bramwell [Tue, 28 Nov 2017 00:02:33 +0000 (16:02 -0800)]
How To Submit Patches to Gerrit over HTTPS
Documents the steps required to configure a user's machine and
repository in order to submit to Gerrit over https.
Issue: RELENG-563
Change-Id: I4843b14467c4c3a5658427f23befddb267c868db
Signed-off-by: Trevor Bramwell <tbramwell@linuxfoundation.org>
Thanh Ha [Thu, 8 Feb 2018 02:16:28 +0000 (21:16 -0500)]
Add Ansible Role creation documentation
Change-Id: I4746492508dada3852ae50bcc7d4507c20ef1cb2
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 16 Feb 2018 21:47:35 +0000 (16:47 -0500)]
Add docs on how to update Jenkins
Change-Id: If4b7ab74bc79855eba9da53de444157b86a4ed17
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Anil Belur [Fri, 9 Feb 2018 06:51:14 +0000 (06:51 +0000)]
Merge "Add documentation on signing commits with GPG"
Anil Belur [Mon, 4 Dec 2017 07:10:44 +0000 (17:10 +1000)]
Add documentation on signing commits with GPG
Topics:
- How to generate GPG keys
- How to setup up gpg-agent
- How to sign your commit
Ref:
http://docs.opendaylight.org/en/stable-nitrogen/gerrit.html#signing-gerrit-commits
JIRA: RELENG-564
Change-Id: If61f1f51fcb1d89a7cc8a275862b871af101a3f5
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Anil Belur [Wed, 7 Feb 2018 05:08:59 +0000 (05:08 +0000)]
Merge "Document inodes issue in infrastructure guide"
Thanh Ha [Tue, 6 Feb 2018 23:16:10 +0000 (23:16 +0000)]
Merge "Add a note about who can add subprojects"
Thanh Ha [Tue, 6 Feb 2018 23:14:54 +0000 (23:14 +0000)]
Merge "Add an inventory documentation"
Thanh Ha [Tue, 6 Feb 2018 23:00:35 +0000 (18:00 -0500)]
Add a note about who can add subprojects
Change-Id: Id65d26324dec876eb690896d7fe20eb2f940502f
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 6 Feb 2018 22:28:30 +0000 (17:28 -0500)]
Include details on project-pattern param
Change-Id: I0eb56eb84d0ea14fac87459d0372da892a900cba
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Mon, 5 Feb 2018 23:54:00 +0000 (18:54 -0500)]
Document inodes issue in infrastructure guide
Make a note of the inodes issue in the infrastructure guide.
Change-Id: I3945c44622cb641e9d638daa71e135bb08d53c82
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Code Review / releng / docs.git / log