Guillaume Lambert [Tue, 1 Jun 2021 18:02:13 +0000 (20:02 +0200)]
Fix more spellchecker warnings
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ie11a9fe46ac3fb267a994062dd99d95a190c02a4
(cherry picked from commit
8d1bac9b58b814359a3e21415220269468485718)
Guillaume Lambert [Sat, 5 Jun 2021 19:40:30 +0000 (21:40 +0200)]
Update conf.py intersphinx controller version
Controller Version 3.0.6 declared in conf.py can no more be retrieved
and use for intersphinx builds.
According to integration/distribution, the version 3.0.8 is the one
targeted for Silicon SR1.
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I82d756a06f5bb55f8d5f8fb66159314d8f46cd0a
Guillaume Lambert [Tue, 1 Jun 2021 14:58:31 +0000 (16:58 +0200)]
Fix some spellchecker warnings
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Icadc2a6aaaed2c8cc6312ec3d4ee331abfb0a0a3
(cherry picked from commit
d1b7686813219d0dc10ff2847d8d83dccdbf9e0d)
Guillaume Lambert [Tue, 1 Jun 2021 15:12:58 +0000 (17:12 +0200)]
Fix some dead links
update Karaf website Anchors in the security considerations section.
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I2b0ae525b950229523043c9817f30e888e11030e
(cherry picked from commit
25889c05abefcec60626b2d4d4b8057bf0782790)
Guillaume Lambert [Fri, 23 Apr 2021 06:53:05 +0000 (08:53 +0200)]
Update Al SR3 and SR2 release dates
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I4a028c22d8b57b31d29351eb3ed0830e0b32401e
Guillaume Lambert [Fri, 23 Apr 2021 06:42:18 +0000 (08:42 +0200)]
Update Si SR1 and Al SR4 release schedule
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I9a1ce08b1293153a60d1e4dbb85df6487167d5df
Guillaume Lambert [Tue, 13 Apr 2021 15:54:29 +0000 (17:54 +0200)]
Update Download page
JIRA: DOCS-135
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Id5ea71c727006ee850618fb99df7b2c5cbfbb1df
Luis Gomez [Wed, 7 Apr 2021 02:24:51 +0000 (19:24 -0700)]
Adjust code after branching silicon
Signed-off-by: Luis Gomez <ecelgp@gmail.com>
Change-Id: Ic4debf4e778e877e728359cec4d43c4ca0ec33e4
Guillaume Lambert [Wed, 31 Mar 2021 10:10:06 +0000 (12:10 +0200)]
Improve release schedule introduction
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I32f7ad31f1caccf69bad728e1a737f0a0d768d8a
Guillaume Lambert [Wed, 31 Mar 2021 10:29:17 +0000 (12:29 +0200)]
Fix Jenkins docs-linkcheck false positives
Ignore static contents and IETF URLs often not reachable from Jenkins minions
because of hosting connectivity issues.
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ib338dd95058a55502825177be68acb5c39195faf
Guillaume Lambert [Tue, 30 Mar 2021 19:18:36 +0000 (21:18 +0200)]
Fix tranportpce release notes JQL queries
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I3d8426d91fe943f7c58d50e6ab34dd42c14ae451
Guillaume Lambert [Tue, 30 Mar 2021 14:50:51 +0000 (14:50 +0000)]
Merge "introducing jira ticketing guideline"
Guillaume Lambert [Mon, 29 Mar 2021 09:28:56 +0000 (09:28 +0000)]
Merge "Update documentation about update process"
Guillaume Lambert [Mon, 29 Mar 2021 08:00:26 +0000 (08:00 +0000)]
Merge "Spelling corrections in Yang Tools guide"
tadei.bilan [Tue, 9 Feb 2021 14:11:46 +0000 (16:11 +0200)]
Update documentation about update process
Update documentation of update process due to akka upgrade in controller.
JIRA: CONTROLLER-1962
Change-Id: Id404aebd837cb580987acf983460943cb2690e54
Signed-off-by: tadei.bilan <tadei.bilan@pantheon.tech>
Navid G [Thu, 25 Mar 2021 01:13:26 +0000 (18:13 -0700)]
introducing jira ticketing guideline
Signed-off-by: Navid G <navid.ghazisaidi@verizon.com>
Change-Id: I92c0824f8d2aaec4717434a8fcbb77004d6dadce
David Baugher [Wed, 14 Aug 2019 00:38:48 +0000 (17:38 -0700)]
Improve spelling and grammar in the apps guide
Change-Id: I20f4cd3b9f751ba1cfd1e99b423fcbf1cb6648ff
Co-authored-by: guillaume.lambert <guillaume.lambert@orange.com>
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
David Baugher [Fri, 3 Apr 2020 01:13:44 +0000 (18:13 -0700)]
Spelling corrections in Yang Tools guide
JIRA: DOCS-120
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Change-Id: I7b14497fc4500ad6a884441e67a2e9ee166f83a3
Sangwook Ha [Sun, 21 Mar 2021 23:34:23 +0000 (16:34 -0700)]
Update developing apps guide for archetype 1.4.0-SNAPSHOT
- Add a new archetype version for Aluminum (1.4.0-SNAPSHOT)
- Update the 'yang-version' to 1.1 and 'revision' to '2021-03-21'
in 'hello.yang'
- Update HelloWorld example and provide working instructions based on
1.4.0-SNAPSHOT: implement 'HelloService' with 'HelloProvide' instead
of adding a separate class 'HelloWorldImpl'.
- Update API explorer instructions to reflect the changes (OpenAPI v3)
made in Aluminium
- Change indentation to use 4-space tabs: 3-space indentation for
the numbered list was the source of incorrect indention for Java code
with extra space
- Update a few capitalization inconsistencies
Signed-off-by: Sangwook Ha <sangwook.ha@verizon.com>
Change-Id: Ic4aa8d4490b6c8cdc73ca33ae946cf28d983dcec
Robert Varga [Fri, 12 Mar 2021 13:32:05 +0000 (14:32 +0100)]
Update AAA issue links
The project reference, the split and the versions are wrong,
simplify them by listing fixed issues only.
Change-Id: I099f79190f96c3477fdbfe87088300fab520950f
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Robert Varga [Fri, 12 Mar 2021 13:24:56 +0000 (14:24 +0100)]
Update Silicon upgrade guide
Update versions and beef up change log a bit.
Change-Id: I6cc2185b8b418448aeb490474476c091298e84ab
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Navid G [Tue, 9 Mar 2021 23:06:54 +0000 (15:06 -0800)]
automating release notes pages using jira filters.
Signed-off-by: Navid G <navid.ghazisaidi@verizon.com>
Change-Id: I59ddd1a1facaf9fd29e9611b952dabb6267da49a
Robert Varga [Mon, 22 Feb 2021 15:38:56 +0000 (16:38 +0100)]
Update the list of MRI projects in Silicon
We have split of a number of projects, update the list.
Change-Id: Iba9dcef054d52584cea06fc1c1dd8aa4c6659716
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Guillaume Lambert [Fri, 19 Feb 2021 06:32:25 +0000 (07:32 +0100)]
Update Silicon Code Freeze schedule
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I0d833e0661277134e4ec29145cace9e87a338926
Robert Varga [Wed, 3 Feb 2021 15:01:33 +0000 (16:01 +0100)]
Update genius/netvirt classification
Both Genius and NetVirt have become self-managed in Silicon, move
them to the appropriate section.
Change-Id: I9bbfa44188342cf61f8052df86f34f764f4748d2
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Luis Gomez [Fri, 29 Jan 2021 05:32:39 +0000 (05:32 +0000)]
Merge "Migrate old wiki component tests best practices"
Luis Gomez [Fri, 29 Jan 2021 05:32:20 +0000 (05:32 +0000)]
Merge "Migrate old wiki considerations on tests"
Luis Gomez [Fri, 29 Jan 2021 05:31:19 +0000 (05:31 +0000)]
Merge "Migrate old wiki Junit best practices"
Luis Gomez [Fri, 29 Jan 2021 05:29:36 +0000 (05:29 +0000)]
Merge "embed and fix metada of the technical charter pdf"
Luis Gomez [Fri, 29 Jan 2021 05:28:44 +0000 (05:28 +0000)]
Merge "Migrate old wiki Copyright best practices"
Luis Gomez [Fri, 29 Jan 2021 05:26:32 +0000 (05:26 +0000)]
Merge "Migrate old wiki Logging subsystem best practices"
Luis Gomez [Fri, 29 Jan 2021 05:25:49 +0000 (05:25 +0000)]
Merge "Migrate old wiki commit message best practices"
Luis Gomez [Fri, 29 Jan 2021 05:24:48 +0000 (05:24 +0000)]
Merge "Split coding guidelines by language"
Luis Gomez [Fri, 29 Jan 2021 05:24:08 +0000 (05:24 +0000)]
Merge "improve documentation structure"
Guillaume Lambert [Tue, 26 Jan 2021 17:08:03 +0000 (17:08 +0000)]
Merge "Update cluster documentation"
tadei.bilan [Wed, 9 Dec 2020 11:53:14 +0000 (13:53 +0200)]
Update cluster documentation
Add section about Split Brain Resolver and multi data center cluster
JIRA: CONTROLLER-1971
Change-Id: I71ead2f5f071795c08f37981e6272a4e0a6de675
Signed-off-by: tadei.bilan <tadei.bilan@pantheon.tech>
Guillaume Lambert [Tue, 26 Jan 2021 15:19:46 +0000 (16:19 +0100)]
Migrate old wiki component tests best practices
to developper guides and rework them
https://wiki-archive.opendaylight.org/view/BestPractices/Component_Tests
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I5ea66eae18e4271ea5d010ff8d641daebd05db8a
Guillaume Lambert [Tue, 26 Jan 2021 14:31:11 +0000 (15:31 +0100)]
Migrate old wiki considerations on tests
to developper guides
https://wiki-archive.opendaylight.org/view/BestPractices/Tests
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I45a3186218bed77b80c282d6a9caa838ee247c05
Guillaume Lambert [Mon, 25 Jan 2021 20:06:17 +0000 (21:06 +0100)]
Migrate old wiki Junit best practices
to developper guides and rework them
https://wiki-archive.opendaylight.org/view/Build_Time_Testing_with_JUnit
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: If86742f96d83b9ba184b119fb11d0ac2b31535f5
Guillaume Lambert [Tue, 26 Jan 2021 11:11:54 +0000 (12:11 +0100)]
embed and fix metada of the technical charter pdf
from
https://www.opendaylight.org/wp-content/uploads/sites/14/2018/01/ODL-Technical-Charter-LF-Projects-LLC-FINAL.pdf
Title Metadata are displayed at the top of the browser Window.
They should reflect the content of the charter and not how it was produced.
Since contributors must comply with this technical charter
and its content is quoted by contributor guides,
it should preferably be embedded in the documentation to avoid dead link.
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I21df665c285bda15a2981c4403ce2f3150fd1716
Guillaume Lambert [Mon, 25 Jan 2021 20:52:29 +0000 (21:52 +0100)]
Migrate old wiki Copyright best practices
and rework them
https://wiki-archive.opendaylight.org/view/BestPractices/Developer_Best_Practices#Copyright
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Iae1e53bd5e3248bdf389c9bd55ce86be38b3b982
Guillaume Lambert [Mon, 25 Jan 2021 17:20:08 +0000 (18:20 +0100)]
Migrate old wiki Logging subsystem best practices
to developper guides and rework them
https://wiki-archive.opendaylight.org/view/BestPractices/Logging_Best_Practices
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6d120b10fc846da69b5d9c551d40d25c49e6bd38
Guillaume Lambert [Mon, 25 Jan 2021 13:46:37 +0000 (14:46 +0100)]
Migrate old wiki commit message best practices
and rework them
https://wiki-archive.opendaylight.org/view/BestPractices/Commit_Messages
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Id5385ac0b94b4939ff3441beea83412a868f3779
Guillaume Lambert [Thu, 21 Jan 2021 20:10:01 +0000 (21:10 +0100)]
Split coding guidelines by language
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I0d9b7355746ddd37f82c66b983c837a531352118
Guillaume Lambert [Thu, 21 Jan 2021 16:03:08 +0000 (17:03 +0100)]
improve documentation structure
- improve titles and folder names
- make a clean separation between developer and contributors guides
- create or fix or reformat index pages
- put contributor guides after getting started guides in the main index
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I823d87513d454f0399121a854d7724cd89c04e94
Guillaume Lambert [Fri, 18 Dec 2020 13:09:59 +0000 (14:09 +0100)]
migrate coding guidelines from the old wiki
and
- fix some typos
- fix checkstyle and SpotBugs enforcement descriptions.
they are now enforced by default since Magnesium.
JIRA: TSC-296
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I72bcd0fd21cc902bf1b97b5cd3f32c063536376c
guillaume.lambert [Mon, 26 Oct 2020 10:15:14 +0000 (11:15 +0100)]
add a contributor guide for newcomers
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I525d41a2da56257ae4eab55229fd40f2156257b6
Thanh Ha [Thu, 17 Dec 2020 16:25:40 +0000 (11:25 -0500)]
Add Guillaume Lambert to committers
Per nomination
https://lists.opendaylight.org/g/documentation/topic/new_committer_nomination/
78874443
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I679766cc7a602f407289870593d7b986081d61a6
Luis Gomez [Sun, 15 Nov 2020 22:20:27 +0000 (14:20 -0800)]
Fix downloads page
It seems like www.opendaylight.org and other places in docs point
to https://docs.opendaylight.org/en/latest/downloads.html so we
have to restore the page and use a link to Aluminium.
Signed-off-by: Luis Gomez <ecelgp@gmail.com>
Change-Id: I0ba8beb33f18ebc9097d106e5749d4d37596f1ad
Luis Gomez [Sat, 14 Nov 2020 01:09:11 +0000 (17:09 -0800)]
Update Aluminium SR1 download page
Signed-off-by: Luis Gomez <ecelgp@gmail.com>
Change-Id: I2c73ae9b5bb91e578a400a9115d2255d4ffe0955
guillaume.lambert [Fri, 13 Nov 2020 11:30:12 +0000 (12:30 +0100)]
add a spellchecker tox profile
inspired from openStack
https://github.com/openstack/qa-specs/blob/master/tox.ini
https://doughellmann.com/blog/tag/sphinxcontrib-spelling/
https://pypi.org/project/sphinxcontrib-spelling/
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: Ibef7c2cb23d1ebc0ed7583c5a15fcf657a1b27e7
Thanh Ha (zxiiro) [Wed, 28 Oct 2020 12:57:00 +0000 (12:57 +0000)]
Merge "Ignore ssh:// links in docs-linkcheck"
Thanh Ha [Wed, 28 Oct 2020 12:30:59 +0000 (08:30 -0400)]
Ignore ssh:// links in docs-linkcheck
Ignore links that are the SSH protocol.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Id458c810b0adf72922d3880b86e5605179ead67c
Robert Varga [Tue, 27 Oct 2020 00:21:18 +0000 (01:21 +0100)]
Expand Silicon upgrade guide
Document MD-SAL impacts and future removals.
Change-Id: I5ab87798da8a2a9d4629e30892467ddcd0d776fa
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Thanh Ha [Tue, 27 Oct 2020 18:09:48 +0000 (14:09 -0400)]
Resolve app.add_stylesheet() is deprecated
/w/workspace/docs-tox-verify-silicon/docs/conf.py:74:
RemovedInSphinx40Warning: The app.add_stylesheet() is deprecated.
Please use app.add_css_file() instead.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I2d44a41d240381e2b1f9dee70aa5af2bed7acd1d
Thanh Ha [Mon, 19 Oct 2020 12:20:20 +0000 (08:20 -0400)]
Run linkchecker in serial mode
See if we can improve linkchecker's passrate by running the linkchecker
in serial mode rather than parallel.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I0ebe91d20a5629f49e17542d36643ecd5b2767d6
Robert Varga [Fri, 16 Oct 2020 08:28:21 +0000 (10:28 +0200)]
Add an example NPE
MD-SAL impact is stricter validation. Add an example of an exception
that can be reported.
Change-Id: I2afae53b196eb2546bb18a8919ae3c39de03ab02
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Robert Varga [Wed, 14 Oct 2020 09:58:57 +0000 (11:58 +0200)]
Fix a typo in Silicon planning
We probably did not have this milestone done a year ago, let's try
to meet it this year.
Change-Id: Iac677ffa4df46f614f1efa29543ef6d7c051c0b3
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Thanh Ha (zxiiro) [Mon, 12 Oct 2020 12:35:11 +0000 (12:35 +0000)]
Merge "Start Silicon platform upgrade guide"
Robert Varga [Mon, 12 Oct 2020 12:18:05 +0000 (14:18 +0200)]
Update MRI project list
MRI project now include Controller and InfraUtils, make sure our
release plan reflects that.
Change-Id: I6fbbf9de0a0fe452b1b23f81467626008d55cb11
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
Robert Varga [Wed, 7 Oct 2020 12:26:00 +0000 (14:26 +0200)]
Start Silicon platform upgrade guide
This is the basic upgrade document, with some of the highlights
listed. Further content will be provided as additional patches.
Change-Id: If384ca410a012a395a0cdd4277a7742fc1db31e3
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
guillaume.lambert [Mon, 28 Sep 2020 08:22:34 +0000 (10:22 +0200)]
update tpce prefilled description in release notes
NB: this corresponds to the description update proposed and
shipped within the stable/aluminium branch.
JIRA: TRNSPRTPCE-331
Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I5c5ac7b89fb9c86c7c28faedef32f52829856589
(cherry picked from commit
67086977de1ebc9e64b4cb98943f887d67b0981f)
Luis Gomez [Fri, 25 Sep 2020 03:37:57 +0000 (20:37 -0700)]
Add project release notes templates
Change-Id: Ib56f571d653e844b24a2c3af6879e708106cd5fe
Signed-off-by: Luis Gomez <ecelgp@gmail.com>
(cherry picked from commit
916ab9cca4fe5eb11384a653bae313878831dc4a)
Thanh Ha [Wed, 23 Sep 2020 15:40:08 +0000 (11:40 -0400)]
Update Silicon release schedule
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I1776f9409d2864c50ff79ddafa63297c6165606a
Thanh Ha [Tue, 22 Sep 2020 20:13:51 +0000 (16:13 -0400)]
Update intersphinx for Silicon
Change-Id: I30cafbc696bb6dd671e56418a418f0354cf5b2f7
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Thanh Ha [Tue, 22 Sep 2020 19:42:18 +0000 (15:42 -0400)]
Update config for Silicon release
Change-Id: I5379e9217a2eaf368add0a9f28ebe78826b6df31
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Thanh Ha [Tue, 22 Sep 2020 19:30:42 +0000 (15:30 -0400)]
Add Aluminium release to downloads
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Id4e9b8151553985746f7f5a6a873a7b4c3d9de91
Thanh Ha [Tue, 15 Sep 2020 23:36:56 +0000 (19:36 -0400)]
Support the new cut-branch-jobs script
Updates the branch cutting documentation to support the new
cut-branch-jobs.py script introduced by
change I6360f3a47285197cd9a9be1e95156ea174c919ba in the releng/builder
project.
Issue: RELENG-152
Change-Id: I4b63d561ef22306fc74e25d9641596f92be6f869
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Thanh Ha (zxiiro) [Mon, 14 Sep 2020 13:01:34 +0000 (13:01 +0000)]
Merge "Add rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst"
aman1403 [Fri, 11 Sep 2020 13:10:32 +0000 (18:40 +0530)]
Add rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst
Signed-off-by: aman1403 <170030039@iitdh.ac.in>
Change-Id: I8f1d2b6a0d1d09adff14d6221b2ab90dde98aef7
aman1403 [Fri, 11 Sep 2020 12:58:48 +0000 (18:28 +0530)]
Add rfc8040 urls for docs/getting-started-guide/clustering.rst
Change-Id: I8f1d2b6a0d1d09adff14d6221b2ab90dde98aef8
Signed-off-by: aman1403 <170030039@iitdh.ac.in>
Thanh Ha [Sat, 29 Aug 2020 01:32:33 +0000 (21:32 -0400)]
Update Sodium-SR4 link header
Change-Id: Ida02578d91281e9387a3b83bd192da86761a6a3e
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
David Baugher [Tue, 7 Jul 2020 20:25:49 +0000 (13:25 -0700)]
Update the SR4 release of the Sodium schedule
Change-Id: Ic2c4b25175d27e47a6d64030514a8ec863e851aa
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Guillaume Lambert [Mon, 17 Aug 2020 14:06:04 +0000 (16:06 +0200)]
fix iana-afn-safi spelling in migration guide
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I1f207b209bc80eb2c1b74ce9678e6afc66c8164f
David Baugher [Thu, 13 Aug 2020 21:05:22 +0000 (14:05 -0700)]
Remove the Magnesium release notes from Latest
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Change-Id: I948130604bf32f08b9a8c746e5e32849af7545d5
Thanh Ha (zxiiro) [Wed, 12 Aug 2020 01:34:16 +0000 (01:34 +0000)]
Merge "Fix Magnesium-SR2 release date to Aug 11"
Thanh Ha (zxiiro) [Wed, 12 Aug 2020 01:27:50 +0000 (01:27 +0000)]
Merge "Rewrite script to activate project docs versions"
Thanh Ha [Wed, 12 Aug 2020 01:25:50 +0000 (21:25 -0400)]
Fix Magnesium-SR2 release date to Aug 11
Magnesium-SR2 was released on August 11, 2020 so fix the release date
to reflect that.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I860cff8d64cba7a10e9650dccba41fa23fa88133
Thanh Ha (zxiiro) [Wed, 12 Aug 2020 01:21:35 +0000 (01:21 +0000)]
Merge "Add branch cutting checklist"
Thanh Ha (zxiiro) [Wed, 12 Aug 2020 01:19:37 +0000 (01:19 +0000)]
Merge "Update downloads page for Magnesium SR2"
Thanh Ha [Wed, 12 Aug 2020 01:15:42 +0000 (21:15 -0400)]
Rewrite script to activate project docs versions
Rewrite the script to activate project docs versions for all supported
ODL autorelease projects. This script maintains a list in the project
and needs to be run manually by a docs maintainer.
Issue: DOCS-129
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I158b9f2f50aacce0160b73bc79dd544dbf5b328d
Thanh Ha [Wed, 12 Aug 2020 00:02:13 +0000 (20:02 -0400)]
Add branch cutting checklist
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Ib27690b5473aba246a7508b92401895429199d85
Thanh Ha [Tue, 11 Aug 2020 23:07:07 +0000 (19:07 -0400)]
Remove docs branching scripts
Functionality of these scripts have been moved to releng/builder under
the autorelease project via I0aa6838d1fd4e2df536a4e30fb8751b7d3a466bf
to be handled as part of branch cutting activities for managed
projects.
There's the script docs_master_branch_update.sh needs to be rewritten
as it does not work for our purposes and in it's current state is quite
broken. We'll handle this as a separate task but removing here as this
script is not in use in production today.
Issue: DOCS-129
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: If3f9b61636643c065ef11aa048debeb92422628e
Thanh Ha [Tue, 11 Aug 2020 17:45:54 +0000 (13:45 -0400)]
Cleanup empty .gitmodules file
The .gitmodules file is empty and we've long removed submodules
from this project so let's clean that up.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Ic913f178071f10e6935a38cd362b4fe22a532ea3
Thanh Ha [Tue, 11 Aug 2020 17:44:45 +0000 (13:44 -0400)]
Remove empty tools directory
This directory contains nothing but a README. We are no longer using
anything here for any reason so let's clean up the repo.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: If570c272f28af10391cacfc56adfd77cc0e3d69c
Thanh Ha [Tue, 11 Aug 2020 17:37:27 +0000 (13:37 -0400)]
Remove p4plugin docs
This project hasn't been active since the Oxygen release so remove from
the docs project.
Issue: DOCS-128
Change-Id: I9f39638424be1e2508d3acc1e9e3a7ea6dc11dd6
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Thanh Ha [Tue, 11 Aug 2020 14:04:16 +0000 (10:04 -0400)]
Adjust formatting for branch-cutting instructions
Formatting is off for some of the wording as the incorrect syntax
or indentation level was used.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I9f19b5c2395034f2ee846ee422ce3566d547763e
Anil Belur [Mon, 10 Aug 2020 10:54:53 +0000 (20:54 +1000)]
Update downloads page for Magnesium SR2
Change-Id: Ic6e1575bc8a81a8c67969a082fa3ab17c7903d79
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Anil Belur [Mon, 10 Aug 2020 07:27:09 +0000 (17:27 +1000)]
Update the JDK version to 11
Change-Id: Icf083f081e2a0e9ab846c35abfc7cc64bd7e9459
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Thanh Ha [Thu, 6 Aug 2020 14:35:32 +0000 (10:35 -0400)]
Show diff on pre-commit failure
Make pre-commit print the diff of files on failure so that it's easier
to see what needs to be changed. Also update all the hook versions
since we haven't done so in awhile.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I3fcb85d791b0e1f1ec9340b15a4ad1c2bd3ade61
Thanh Ha (zxiiro) [Tue, 4 Aug 2020 11:15:05 +0000 (11:15 +0000)]
Merge "Add INFO.yaml for docs"
Anil Belur [Tue, 4 Aug 2020 01:03:26 +0000 (11:03 +1000)]
Add INFO.yaml for docs
Change-Id: I91c0b513f8016f08e48c1424d7e5c89bc293730b
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
Thanh Ha [Mon, 20 Jul 2020 20:24:23 +0000 (16:24 -0400)]
Resolve link redirects to the current links
This patch updates all links to the current URLs to avoid
getting a redirect.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Ic5689fcb384e9e0b0f94124b33e540c033d6cd64
Thanh Ha [Fri, 15 Nov 2019 18:11:02 +0000 (13:11 -0500)]
Enable docs-linkcheck to validate the links
This patch enables the linkchecker to run against links in the docs.
It also takes care of broken links that were detected as part of this
work.
Issue: DOCS-40
Change-Id: I7fff59927b2d88b2e9feefc175068d9cd45cedc6
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Thanh Ha (zxiiro) [Mon, 20 Jul 2020 17:00:41 +0000 (17:00 +0000)]
Merge "Do not fail on warnings for docs-linkcheck"
Thanh Ha [Mon, 20 Jul 2020 16:52:55 +0000 (12:52 -0400)]
Do not fail on warnings for docs-linkcheck
This is a workaround due to sphinx-tabs being incompatible with the
Sphinx linkchecker which throws a warning. We mainly use linkchecker
to catch broken links so we don't really need to fail on warnings as
the main "docs" builder will still fail for warning level issues so
this is a reasonable workaround.
Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I58619d4984bd0b58b145cb4b362cef5783e62441
jenkins-releng [Mon, 20 Jul 2020 15:38:26 +0000 (15:38 +0000)]
Update release notes for Magnesium-SR1
Signed-off-by: jenkins-releng <jenkins-releng@opendaylight.org>
Change-Id: Ied8e5d8fd3d71202e33faf7d304364397f812a74
Jamo Luhrsen [Fri, 10 Jul 2020 16:40:17 +0000 (16:40 +0000)]
Merge "Update archetype example"
Jamo Luhrsen [Wed, 17 Jun 2020 20:00:35 +0000 (13:00 -0700)]
Simplify and clarify features/behaviors sections
This will hopefully make a little more clear what people
should include in which section around new or changed
features and behaviors.
Signed-off-by: Jamo Luhrsen <jluhrsen@gmail.com>
Change-Id: Ia8a552081bd86d60afba071398121a3b80c06425
Jamo Luhrsen [Wed, 17 Jun 2020 19:54:29 +0000 (12:54 -0700)]
Remove details in New Features section
The additional details in the "New and Modified Features"
section is adding confusion for people trying to follow
this template.
Signed-off-by: Jamo Luhrsen <jluhrsen@gmail.com>
Change-Id: Ic5c1a98e8699a1765f4ea2cfad3eff529089dd5f