docs.git
2 years agoAdd a section on YANG Tools leafref resolution 06/97006/2
Robert Varga [Thu, 22 Jul 2021 11:07:11 +0000 (13:07 +0200)]
Add a section on YANG Tools leafref resolution

The implementation of leafref resolution functions has been corrected
and it is catching bad path specifications. Document this change in
behaviour.

Change-Id: I96dabd4fd046388d11309119367a41907cc0b871
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
2 years agoClean up upgrade process a bit 81/96981/1
Robert Varga [Wed, 21 Jul 2021 18:49:28 +0000 (20:49 +0200)]
Clean up upgrade process a bit

Fix a few spelling and formatting mistakes.

Change-Id: Ib52ea8db6179c1ba08676bf25246f355f17fc099
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
2 years agoUpdate Phosphorus NETCONF reference 42/96942/1
Robert Varga [Tue, 20 Jul 2021 11:20:21 +0000 (13:20 +0200)]
Update Phosphorus NETCONF reference

We have a regression in netconf-2.0.0, update the upgrade guide
to reference fixed-up netconf-2.0.1.

Change-Id: If1b5a547a6d15c449de94e99fd6130ed54518dfd
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
2 years agoUpdate platform upgrade guide for Phosphorus 91/96791/13
Robert Varga [Fri, 2 Jul 2021 16:54:41 +0000 (18:54 +0200)]
Update platform upgrade guide for Phosphorus

The platform is changing in a number of incompatible ways, shedding
a lot of code which was unused or has been provided only for backwards
compatibility. Update the upgrade guide to highlight these.

Change-Id: I53afd65b51386a082201f4cbda5bf5bea67c571a
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
2 years agoUpdate releases downloads and schedule 97/96597/2
Guillaume Lambert [Tue, 22 Jun 2021 15:01:36 +0000 (17:01 +0200)]
Update releases downloads and schedule

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ic7256ae8e6f8d8a7afb326bf1ff126388466aadf

2 years agoUpdate releng IRC documentation URL 55/96555/1
Guillaume Lambert [Wed, 16 Jun 2021 18:10:44 +0000 (20:10 +0200)]
Update releng IRC documentation URL

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ic0b963d97decf40cc13774eb724b2cd476750b4f

2 years agoIgnore spelling warnings in release notes 78/96478/1
Guillaume Lambert [Wed, 16 Jun 2021 08:38:56 +0000 (10:38 +0200)]
Ignore spelling warnings in release notes

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I013e6636adaf29273b37367d260d997272531ad1
(cherry picked from commit 395054fcee73d40a88f9e3b73740cef819d554fd)

2 years agoUpdate IRC chat locations 34/96534/3
Guillaume Lambert [Tue, 15 Jun 2021 18:57:10 +0000 (20:57 +0200)]
Update IRC chat locations

Freenode IRC channels locations are no more reachable.
Official OpenDaylight and LFN channels have migrated to Libera.Chat.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6bf69adb168630ea31ae7f447ffa7b6399375264

2 years agoUpdate INFO.yaml IRC chat locations 35/96535/1
Guillaume Lambert [Tue, 15 Jun 2021 19:19:36 +0000 (21:19 +0200)]
Update INFO.yaml IRC chat locations

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: If33fb1605c09742ac2c83b9d8cf17f1b171f410f

2 years agoCheck Silicon official page in docs-linkcheck 25/96525/1
Guillaume Lambert [Mon, 14 Jun 2021 08:55:57 +0000 (10:55 +0200)]
Check Silicon official page in docs-linkcheck

The Si official page has been published and should not be ignored by
docs-linkcheck anymore.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I910fd5733714a66a78e4309d17f7016ca25175c2

2 years agoEnforce Spellchecker in CI 37/96437/9
Guillaume Lambert [Sun, 6 Jun 2021 16:33:25 +0000 (18:33 +0200)]
Enforce Spellchecker in CI

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I7b4d8e69045b730fb9c59decae29922268564fa3

2 years agoRework Java coding guidelines 36/96436/3
Guillaume Lambert [Sun, 6 Jun 2021 12:27:15 +0000 (14:27 +0200)]
Rework Java coding guidelines

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Iff204a17b5a0cc4a3c6bae0399776ca4947f041d

2 years agoRework newcomer contributor guide 35/96435/3
Guillaume Lambert [Sat, 5 Jun 2021 20:14:25 +0000 (22:14 +0200)]
Rework newcomer contributor guide

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6b8ff34cb2b7ab406e728cd3eb90fa1bc69f21b5

2 years agoFix more and more spellchecker warnings 33/96433/2
Guillaume Lambert [Sat, 5 Jun 2021 19:32:34 +0000 (21:32 +0200)]
Fix more and more spellchecker warnings

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I085785e937d72db050dc839ad33c56b9ee8354a4

2 years agoRework logging subsytem documentation 32/96432/2
Guillaume Lambert [Fri, 4 Jun 2021 19:04:58 +0000 (21:04 +0200)]
Rework logging subsytem documentation

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ica010170bfb6d8fe058515031dbda01ff24b13a3

2 years agoRework developer guide for Neutron 31/96431/2
Guillaume Lambert [Fri, 4 Jun 2021 18:52:33 +0000 (20:52 +0200)]
Rework developer guide for Neutron

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I5d5a3a56c47568db78f7f841752cacbabe25d0ae

2 years agoRework odl-parent developer guide 30/96430/2
Guillaume Lambert [Fri, 4 Jun 2021 18:38:52 +0000 (20:38 +0200)]
Rework odl-parent developer guide

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I92d033ae2e5530595248c2ee4d214a4d29095932

2 years agoRework tests component developer guide 29/96429/2
Guillaume Lambert [Fri, 4 Jun 2021 15:17:26 +0000 (17:17 +0200)]
Rework tests component developer guide

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Icf1c199b2d79ced0d66e15dcde9a1a46964a07f2

2 years agoRework developer guide considerations 28/96428/1
Guillaume Lambert [Fri, 4 Jun 2021 14:36:12 +0000 (16:36 +0200)]
Rework developer guide considerations

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I06d99ff21b9c4d197dde1e667ab435e1d3a8391f

2 years agoRework JUnit developer guide 27/96427/1
Guillaume Lambert [Fri, 4 Jun 2021 14:26:37 +0000 (16:26 +0200)]
Rework JUnit developer guide

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I1af7b1140ef3836c7c4496e4e337fb44ffb6cda6

2 years agoRework Yangtools developer guide 26/96426/2
Guillaume Lambert [Fri, 4 Jun 2021 14:06:49 +0000 (16:06 +0200)]
Rework Yangtools developer guide

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ia28a67442f4571f2ecd8ce44b1a6a052a7519731

2 years agoRework docs documentation 25/96425/2
Guillaume Lambert [Fri, 4 Jun 2021 13:07:18 +0000 (15:07 +0200)]
Rework docs documentation

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ia8f577b2c07748db6290ea67937d78ce1fe774b9

3 years agoFix even more spellchecker warnings 23/96423/3
Guillaume Lambert [Thu, 3 Jun 2021 10:11:03 +0000 (12:11 +0200)]
Fix even more spellchecker warnings

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6a4ea52c9ef02d4134e97729501a7e0371bfbbd4

3 years agoFix pre-commit and tox and gitlint settings 10/96410/1
Guillaume Lambert [Wed, 2 Jun 2021 19:03:10 +0000 (21:03 +0200)]
Fix pre-commit and tox and gitlint settings

- create a .gitlint configuration to enforce subject line < 50 char
  and body lines < 72 char and a Signed-off-by field presence.
- (auto)update repository revisions in pre-commit configuration file
- fix pre-commit tox profile to make it work locally
- create a gitlint profile that works in CI
- create pre-commit-install and pre-commit-uninstall tox profiles to
  (un)install hooks locally and (un)perform tests at each "git commit"
  call (i.e. without calling manually the pre-commit tox profile)
- precise pre-commit stages/types in the pre-commit configuration file
  so that hooks are installed correctly. This avoids messages about
  skipped tests when they are run at a wrong stage.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I75b3b54b13e3d865ad6f563630bb0034456e7fe1

3 years agoFix more spellchecker warnings 05/96405/2
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

3 years agoFix some spellchecker warnings 04/96404/1
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

3 years agoFix some dead links 03/96403/1
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

3 years agoDecrease Sphinx tox profiles logs verbosity 02/95902/2
Guillaume Lambert [Fri, 23 Apr 2021 13:25:01 +0000 (15:25 +0200)]
Decrease Sphinx tox profiles logs verbosity

This will ease gate failures analysis.

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I0ae21afe7502383bf55113a23d99b23af13eb644

3 years agoFix some regex in docs/conf.py 03/95903/1
Guillaume Lambert [Fri, 23 Apr 2021 13:49:31 +0000 (15:49 +0200)]
Fix some regex in docs/conf.py

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I847bcbb0744f7049097cdb840f0835cc9af46d9b

3 years agoUpdate Si SR1 release schedule 98/95898/1
Guillaume Lambert [Fri, 23 Apr 2021 06:56:08 +0000 (08:56 +0200)]
Update Si SR1 release schedule

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I9a1ce08b1293153a60d1e4dbb85df6487167d5df

3 years agoremove netvirt from Phosphorus 92/95792/6
Navid Ghazisaidi [Wed, 14 Apr 2021 18:45:34 +0000 (11:45 -0700)]
remove netvirt from Phosphorus

Signed-off-by: Navid Ghazisaidi <navid.ghazisaidi@verizon.com>
Change-Id: Iad61e9b069f97aeb4ab498384008355a77b67b68

3 years agoUpdate Download page 85/95485/1
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
(cherry picked from commit 55bdfaf98976003268a70a0789bbbfa447eeeec5)

3 years agoMerge "Adjust code after branching silicon"
Luis Gomez [Fri, 9 Apr 2021 18:30:03 +0000 (18:30 +0000)]
Merge "Adjust code after branching silicon"

3 years agoAdjust code after branching silicon 86/95686/1
Luis Gomez [Wed, 7 Apr 2021 02:36:53 +0000 (19:36 -0700)]
Adjust code after branching silicon

Signed-off-by: Luis Gomez <ecelgp@gmail.com>
Change-Id: If0dbeab119cace3fd193183eb66b67e08fe7db8f

3 years agoUpdate Release Schedule for Phosphorus 14/95614/2
Guillaume Lambert [Wed, 31 Mar 2021 10:02:53 +0000 (12:02 +0200)]
Update Release Schedule for Phosphorus

now that Silicon is released.

JIRA: TSC-305
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6f7e01bb2c74bd0c68d17cd7382acd58f60d2af4

3 years agoImprove release schedule introduction 13/95613/2
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

3 years agoFix Jenkins docs-linkcheck false positives 15/95615/2
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

3 years agoFix tranportpce release notes JQL queries 10/95610/1
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

3 years agoMerge "introducing jira ticketing guideline"
Guillaume Lambert [Tue, 30 Mar 2021 14:50:51 +0000 (14:50 +0000)]
Merge "introducing jira ticketing guideline"

3 years agoMerge "Update documentation about update process"
Guillaume Lambert [Mon, 29 Mar 2021 09:28:56 +0000 (09:28 +0000)]
Merge "Update documentation about update process"

3 years agoMerge "Spelling corrections in Yang Tools guide"
Guillaume Lambert [Mon, 29 Mar 2021 08:00:26 +0000 (08:00 +0000)]
Merge "Spelling corrections in Yang Tools guide"

3 years agoUpdate documentation about update process 94/95094/7
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>
3 years agointroducing jira ticketing guideline 54/95554/5
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

3 years agoImprove spelling and grammar in the apps guide 05/83605/13
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>
3 years agoSpelling corrections in Yang Tools guide 70/88870/6
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

3 years agoUpdate developing apps guide for archetype 1.4.0-SNAPSHOT 36/95536/1
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

3 years agoUpdate AAA issue links 04/95504/1
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>
3 years agoUpdate Silicon upgrade guide 03/95503/1
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>
3 years agoautomating release notes pages using jira filters. 61/95461/1
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

3 years agoUpdate the list of MRI projects in Silicon 83/95283/2
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>
3 years agoUpdate Silicon Code Freeze schedule 29/95229/1
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

3 years agoUpdate genius/netvirt classification 12/95012/1
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>
3 years agoMerge "Migrate old wiki component tests best practices"
Luis Gomez [Fri, 29 Jan 2021 05:32:39 +0000 (05:32 +0000)]
Merge "Migrate old wiki component tests best practices"

3 years agoMerge "Migrate old wiki considerations on tests"
Luis Gomez [Fri, 29 Jan 2021 05:32:20 +0000 (05:32 +0000)]
Merge "Migrate old wiki considerations on tests"

3 years agoMerge "Migrate old wiki Junit best practices"
Luis Gomez [Fri, 29 Jan 2021 05:31:19 +0000 (05:31 +0000)]
Merge "Migrate old wiki Junit best practices"

3 years agoMerge "embed and fix metada of the technical charter pdf"
Luis Gomez [Fri, 29 Jan 2021 05:29:36 +0000 (05:29 +0000)]
Merge "embed and fix metada of the technical charter pdf"

3 years agoMerge "Migrate old wiki Copyright best practices"
Luis Gomez [Fri, 29 Jan 2021 05:28:44 +0000 (05:28 +0000)]
Merge "Migrate old wiki Copyright best practices"

3 years agoMerge "Migrate old wiki Logging subsystem best practices"
Luis Gomez [Fri, 29 Jan 2021 05:26:32 +0000 (05:26 +0000)]
Merge "Migrate old wiki Logging subsystem best practices"

3 years agoMerge "Migrate old wiki commit message best practices"
Luis Gomez [Fri, 29 Jan 2021 05:25:49 +0000 (05:25 +0000)]
Merge "Migrate old wiki commit message best practices"

3 years agoMerge "Split coding guidelines by language"
Luis Gomez [Fri, 29 Jan 2021 05:24:48 +0000 (05:24 +0000)]
Merge "Split coding guidelines by language"

3 years agoMerge "improve documentation structure"
Luis Gomez [Fri, 29 Jan 2021 05:24:08 +0000 (05:24 +0000)]
Merge "improve documentation structure"

3 years agoMerge "Update cluster documentation"
Guillaume Lambert [Tue, 26 Jan 2021 17:08:03 +0000 (17:08 +0000)]
Merge "Update cluster documentation"

3 years agoUpdate cluster documentation 19/94119/4
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>
3 years agoMigrate old wiki component tests best practices 21/94821/1
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

3 years agoMigrate old wiki considerations on tests 20/94820/1
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

3 years agoMigrate old wiki Junit best practices 01/94801/3
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

3 years agoembed and fix metada of the technical charter pdf 11/94811/2
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

3 years agoMigrate old wiki Copyright best practices 00/94800/2
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

3 years agoMigrate old wiki Logging subsystem best practices 98/94798/2
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

3 years agoMigrate old wiki commit message best practices 86/94786/1
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

3 years agoSplit coding guidelines by language 18/94718/1
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

3 years agoimprove documentation structure 98/94698/1
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

3 years agomigrate coding guidelines from the old wiki 69/94269/6
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

3 years agoadd a contributor guide for newcomers 86/93386/16
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

3 years agoAdd Guillaume Lambert to committers 64/94264/2
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

3 years agoFix downloads page 40/93840/4
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

3 years agoUpdate Aluminium SR1 download page 37/93837/2
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

3 years agoadd a spellchecker tox profile 28/93828/2
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

3 years agoMerge "Ignore ssh:// links in docs-linkcheck"
Thanh Ha (zxiiro) [Wed, 28 Oct 2020 12:57:00 +0000 (12:57 +0000)]
Merge "Ignore ssh:// links in docs-linkcheck"

3 years agoIgnore ssh:// links in docs-linkcheck 56/93456/2
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

3 years agoExpand Silicon upgrade guide 99/93399/8
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>
3 years agoResolve app.add_stylesheet() is deprecated 23/93423/1
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

3 years agoRun linkchecker in serial mode 77/93177/1
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

3 years agoAdd an example NPE 88/93088/1
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>
3 years agoFix a typo in Silicon planning 43/93043/1
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>
3 years agoMerge "Start Silicon platform upgrade guide"
Thanh Ha (zxiiro) [Mon, 12 Oct 2020 12:35:11 +0000 (12:35 +0000)]
Merge "Start Silicon platform upgrade guide"

3 years agoUpdate MRI project list 24/93024/1
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>
3 years agoStart Silicon platform upgrade guide 34/92934/3
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>
3 years agoupdate tpce prefilled description in release notes 94/92694/2
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)

3 years agoAdd project release notes templates 92/92692/3
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)

3 years agoUpdate Silicon release schedule 17/92617/1
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

3 years agoUpdate intersphinx for Silicon 13/92613/1
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>
3 years agoUpdate config for Silicon release 11/92611/2
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>
3 years agoAdd Aluminium release to downloads 09/92609/1
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

3 years agoSupport the new cut-branch-jobs script 54/92454/2
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>
3 years agoMerge "Add rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst"
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"

3 years agoAdd rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst 41/92441/3
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

3 years agoAdd rfc8040 urls for docs/getting-started-guide/clustering.rst 40/92440/3
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>
3 years agoUpdate Sodium-SR4 link header 22/92322/1
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>
3 years agoUpdate the SR4 release of the Sodium schedule 70/90970/3
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>