summary |
shortlog | log |
commit |
commitdiff |
review |
tree
first ⋅ prev ⋅ next
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>
Thanh Ha [Mon, 5 Feb 2018 18:03:38 +0000 (13:03 -0500)]
Add an inventory documentation
Create a page that describes the locations of all the infra that
projects should be aware of.
Change-Id: I2a128af01dfaa2267f70d366430e6a63589c31d1
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 30 Jan 2018 21:41:18 +0000 (16:41 -0500)]
Shorten the helpdesk docs link
Cosmetic thing but let's keep it short before anyone starts linking
to it.
Change-Id: Ic404b59a35282ec8cf0dd41e723313b9e92e18a9
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 26 Jan 2018 17:24:40 +0000 (12:24 -0500)]
Add a project documentation guide
Describes the process a project can go through to get their
project setup with ReadTheDocs and Sphinx documentation.
Key topics include "Bootstrap a New Project" and "Add a project
to ReadTheDocs".
Issue: RELENG-762
Change-Id: I4110a1ba39327a83ec70873ca0715747a8f3e84e
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Andrew Grimberg [Mon, 29 Jan 2018 22:26:10 +0000 (22:26 +0000)]
Merge "Add HelpDesk documentation"
Thanh Ha [Fri, 26 Jan 2018 19:31:37 +0000 (14:31 -0500)]
Remove unused RSTcheckBear
Remove RSTcheckBear it had a typo and was not working in the first
place. There are checks for features with RSTcheckBear that we
cannot disable but require in our docs so let's leave this disabled.
Change-Id: I15f0e1a4e04c1e73c9ecbabd8cf13fae02be124b
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 26 Jan 2018 18:15:13 +0000 (13:15 -0500)]
Add HelpDesk documentation
Change-Id: Ib66ab3908b0da60c06f31859895622e5a0615875
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 03:00:08 +0000 (22:00 -0500)]
Link in lfdocs-conf project
Change-Id: Ic2c69e77b87d3c2754fc747fcf2cf8303bfcc830
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Thu, 25 Jan 2018 02:39:56 +0000 (21:39 -0500)]
Switch to using lfdocs-conf 0.1.3
Change-Id: Iaf0e568c7fb0c607064e0483f657d70bfd55055c
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Wed, 17 Jan 2018 02:50:07 +0000 (21:50 -0500)]
Switch to using lfdocs-conf project
Change-Id: I5136e196e26ba27670be81beabac37618a532c14
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Mon, 15 Jan 2018 22:19:43 +0000 (17:19 -0500)]
Remove docs-conf submodule
Change-Id: Ic30d2cc3876bd7fcf72d0ec93d194d7092410ec7
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Jessica Wagantall [Thu, 26 Oct 2017 22:23:51 +0000 (15:23 -0700)]
Add Jenkins guide documentation
Sections include:
- Sandbox Overview
- How to get access to the Sandbox
- Pushing jobs to the Sandbox
- Executing jobs in the Sandbox
Change-Id: Iabadb6fc6fd3090af6b7070fb71dd4fed9ca8542
Issue-ID: RELENG-510
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Anil Belur [Mon, 4 Dec 2017 01:18:39 +0000 (11:18 +1000)]
Fix gerrit guide title formatting
Underlines or overlines must be at least as long as the
title text.
Change-Id: I031c8f3a33b3de22aff7703906f8c5574a3e4d30
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Jessica Wagantall [Wed, 25 Oct 2017 17:50:35 +0000 (10:50 -0700)]
Add Gerrit documentation (How to clone)
Topics include:
- How to clone the code
- Clone via SSH
- Clone via anonymous HTTP
- Clone via HTTP
- Clone with commit-msg hook
- Setting up Gerrit
- Generating SSH keys for your system
- Registering your SSH key with Gerrit
Issue-ID: RELENG-556
Change-Id: I95ab738908f9e7c6a0dab43629f2d187b2a67c8b
Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org>
Thanh Ha [Wed, 8 Nov 2017 21:25:58 +0000 (16:25 -0500)]
Add docs-conf submodule
Change-Id: I3949df6d7fb4721caedd3b7b05d26a58c5c24bef
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Sat, 14 Oct 2017 15:05:38 +0000 (11:05 -0400)]
Bump Sphinx minimal dependencies to latest
Change-Id: I5c032ea889b7a17be9614516e3e51a2963b068c6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Sat, 14 Oct 2017 14:59:35 +0000 (10:59 -0400)]
Add LF Logo
Change-Id: Ia82ca35196630689f67f8b1b6fb5f2091a6e5c6d
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Sat, 14 Oct 2017 14:50:06 +0000 (10:50 -0400)]
Add custom navbar ala OpenDaylight docs
Change-Id: I2af32b6847a6dd1242efd6b9c320a22eff0d8d76
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 13 Oct 2017 18:52:26 +0000 (14:52 -0400)]
Add Global JJB Best Practices link
Issue: RELENG-507
Change-Id: Iceaa17073e320cc327c3ae97a24653a2e45ff825
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 13 Oct 2017 18:29:15 +0000 (14:29 -0400)]
Move best practices guide to docs
Change-Id: Id4f9e01c0af3243ca4d3dce2df989d29042d24e8
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 13 Oct 2017 18:24:13 +0000 (14:24 -0400)]
Update links for lftools and global-jjb
Issue: RELENG-507
Change-Id: I780b6a20497eb9587733ca4e6324b0a25b68d401
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Fri, 13 Oct 2017 16:51:12 +0000 (12:51 -0400)]
Docs layout to pull in guides and tools
Setup initial layout and populate with todo comments.
Change-Id: I18ac021bca467f5157004e6d25463225544c4ad6
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Thanh Ha [Tue, 3 Oct 2017 20:48:03 +0000 (16:48 -0400)]
Bootstrap docs project
Change-Id: I4a12b03eb5afc228f01986732ebca736dce0a5e4
Signed-off-by: Thanh Ha <thanh.ha@linuxfoundation.org>
Andrew Grimberg [Mon, 2 Oct 2017 15:32:12 +0000 (15:32 +0000)]
Initial empty repository
Code Review / releng / docs.git / log