docs.git
2 years agoAdd transportpce to Si SR3 release notes 88/98388/2
Gilles Thouenon [Wed, 10 Nov 2021 10:35:20 +0000 (11:35 +0100)]
Add transportpce to Si SR3 release notes

Signed-off-by: Gilles Thouenon <gilles.thouenon@orange.com>
Change-Id: I74236be59fba048c68ddd9b0418a803434862581

2 years agoUpdate release notes for Silicon-SR3 47/98347/3
jenkins-releng [Sun, 7 Nov 2021 23:40:33 +0000 (23:40 +0000)]
Update release notes for Silicon-SR3

Signed-off-by: jenkins-releng <jenkins-releng@opendaylight.org>
Change-Id: I3d3439420197deb0872b58a4cfab1383d4bd299d
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>
2 years agoFix release announcement links 80/98080/1
guillaume.lambert [Tue, 9 Nov 2021 13:48:21 +0000 (14:48 +0100)]
Fix release announcement links

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I53c85707d68c3d9272f6a4d9b90c8292afee842a
(cherry picked from commit 9c1152a1714310a0e3e012bef28b9de96482d03f)

2 years agoUpdate release schedule for Sulfur, P SR1 & Si SR3 18/97818/2
guillaume.lambert [Tue, 19 Oct 2021 18:16:44 +0000 (20:16 +0200)]
Update release schedule for Sulfur, P SR1 & Si SR3

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I06c2166dbe2f7e90f3dd202db6a0b833a119ef6a
(cherry picked from commit 843d91aacd0abe4b9ee3655a72bbae0de0c93f30)

2 years agoCheck enchant-2 exec presence in tox spelling job 14/97814/1
guillaume.lambert [Thu, 23 Sep 2021 07:26:37 +0000 (09:26 +0200)]
Check enchant-2 exec presence in tox spelling job

enchant-2 has superseded enchant (v1) in recent GNU/Linux distributions
such as debian 11.
We do not need to ask enchant installation if enchant-2 executable is
detected on the system.

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I8b453534934737bdd11ba4e22cdf5b3e6ae62474
(cherry picked from commit d54083eb676301e1408533b64c71474666756860)

2 years agoUpdate download page for Phosphorus 13/97813/2
guillaume.lambert [Fri, 15 Oct 2021 08:21:36 +0000 (10:21 +0200)]
Update download page for Phosphorus

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: Ib19e88cde15971e9ed0ce19f7e5f34f654a37e4b
(cherry picked from commit 5ef82ef6568d2163268c9b43718cc57f5ee59331)

2 years agoUpdate download page for Silicon SR2 63/97363/1
guillaume.lambert [Mon, 30 Aug 2021 14:16:36 +0000 (16:16 +0200)]
Update download page for Silicon SR2

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: Id59c39f940a6d3549960fddb6586820b8f875463

2 years agoFix release notes index 62/97362/1
guillaume.lambert [Mon, 30 Aug 2021 14:12:01 +0000 (16:12 +0200)]
Fix release notes index

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I42e1f49110c5d3bc64abbb80d92aa2cd86feccb6

2 years agoAdd transportpce to Si SR2 release notes 61/97361/1
guillaume.lambert [Mon, 30 Aug 2021 12:49:39 +0000 (14:49 +0200)]
Add transportpce to Si SR2 release notes

$ git log --oneline -27 |grep -v Merge | \
sed 's@^\(........\)[^ ]* @
* `\1 <https://git.opendaylight.org/gerrit/q/\1>`_\n  : @'

Signed-off-by: guillaume.lambert <guillaume.lambert@orange.com>
Change-Id: I7345656b599875ef4f06b0902ffa4c092c471b5b

2 years agoUpdate release notes for Silicon-SR2 78/97278/2
jenkins-releng [Fri, 20 Aug 2021 09:49:13 +0000 (09:49 +0000)]
Update release notes for Silicon-SR2

Signed-off-by: jenkins-releng <jenkins-releng@opendaylight.org>
Change-Id: I769004c2e0f8682b36fefb7404545771574bdaae

2 years agoUpdate releases downloads and schedule 84/96484/3
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 81/96481/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
(cherry picked from commit dacb4f0cc0302bed5eb4f8dab8a4d189a50d745a)

2 years agoUpdate IRC chat locations 77/96477/4
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
(cherry picked from commit 37f611b0ebeb8a6bccf27b2d973796753c2e5382)

2 years agoUpdate INFO.yaml IRC chat locations 76/96476/4
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
(cherry picked from commit 2ac4f89d4f82826fcbc3f87181f3ea1139b85414)

2 years agoIgnore spelling warnings in release notes 43/96543/3
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

2 years agoMerge "Enforce Spellchecker in CI" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:52 +0000 (00:21 +0000)]
Merge "Enforce Spellchecker in CI" into stable/silicon

2 years agoMerge "Rework Java coding guidelines" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:41 +0000 (00:21 +0000)]
Merge "Rework Java coding guidelines" into stable/silicon

2 years agoMerge "Rework newcomer contributor guide" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:27 +0000 (00:21 +0000)]
Merge "Rework newcomer contributor guide" into stable/silicon

2 years agoMerge "Fix more and more spellchecker warnings" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:19 +0000 (00:21 +0000)]
Merge "Fix more and more spellchecker warnings" into stable/silicon

2 years agoMerge "Rework logging subsytem documentation" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:11 +0000 (00:21 +0000)]
Merge "Rework logging subsytem documentation" into stable/silicon

2 years agoMerge "Rework developer guide for Neutron" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:21:03 +0000 (00:21 +0000)]
Merge "Rework developer guide for Neutron" into stable/silicon

2 years agoMerge "Rework odl-parent developer guide" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:53 +0000 (00:20 +0000)]
Merge "Rework odl-parent developer guide" into stable/silicon

2 years agoMerge "Rework tests component developer guide" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:44 +0000 (00:20 +0000)]
Merge "Rework tests component developer guide" into stable/silicon

2 years agoMerge "Rework developer guide considerations" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:35 +0000 (00:20 +0000)]
Merge "Rework developer guide considerations" into stable/silicon

2 years agoMerge "Rework JUnit developer guide" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:26 +0000 (00:20 +0000)]
Merge "Rework JUnit developer guide" into stable/silicon

2 years agoMerge "Rework Yangtools developer guide" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:18 +0000 (00:20 +0000)]
Merge "Rework Yangtools developer guide" into stable/silicon

2 years agoMerge "Rework docs documentation" into stable/silicon
Luis Gomez [Wed, 16 Jun 2021 00:20:06 +0000 (00:20 +0000)]
Merge "Rework docs documentation" into stable/silicon

2 years agoUpdate Silicon SR1 docs links 39/96439/2
Robert Varga [Mon, 7 Jun 2021 09:42:43 +0000 (11:42 +0200)]
Update Silicon SR1 docs links

A number of MRI projects have wrong version pointers, fix that up.

Change-Id: Iba3c3ebee78ee5e75892a4a4bf354c93d5a51147
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>
2 years agoAdd transportpce to Si SR1 release notes 21/96521/5
Guillaume Lambert [Mon, 14 Jun 2021 08:48:07 +0000 (10:48 +0200)]
Add transportpce to Si SR1 release notes

$ git log --oneline -43 |grep -v Merge | \
sed 's@^\(........\)[^ ]* @
* `\1 <https://git.opendaylight.org/gerrit/q/\1>`_\n  : @'

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

2 years agoDecrease Sphinx tox profiles logs verbosity 26/96526/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

2 years agoEnforce Spellchecker in CI 73/96473/2
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
(cherry picked from commit c1f65083c009e092abd86a588350bc8d79ee2511)

2 years agoUpdate release notes for Silicon-SR1 21/96421/4
jenkins-releng [Thu, 3 Jun 2021 04:17:31 +0000 (04:17 +0000)]
Update release notes for Silicon-SR1

Signed-off-by: jenkins-releng <jenkins-releng@opendaylight.org>
Change-Id: I463b600901f90ce1e2247b71c6dca74b7e3272a1

2 years agoFix some regex in docs/conf.py 24/96524/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

2 years agoCheck Silicon official page in docs-linkcheck 22/96522/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

3 years agoRework Java coding guidelines 72/96472/1
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
(cherry picked from commit db3baf9996bed482712798267f844bba5862f08e)

3 years agoRework newcomer contributor guide 71/96471/1
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
(cherry picked from commit 057404502463b9939370c8873ecead34d09ef13b)

3 years agoFix more and more spellchecker warnings 70/96470/1
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
(cherry picked from commit 77da9c5665739946cb9ed23f4e4f3dc537066755)

3 years agoRework logging subsytem documentation 69/96469/1
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
(cherry picked from commit 1bdb00ccb3157fd189e52ff3f6316793a59ef8e3)

3 years agoRework developer guide for Neutron 68/96468/1
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
(cherry picked from commit 9e145ac9ec7ea359a392846fae3ea89f7b20ea8d)

3 years agoRework odl-parent developer guide 67/96467/1
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
(cherry picked from commit c0d06785b890803a1d3994ffb001f843859440b0)

3 years agoRework tests component developer guide 66/96466/1
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
(cherry picked from commit 053c7edd75c413e8b684273a0938d1984f284c4c)

3 years agoRework developer guide considerations 25/96325/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
(cherry picked from commit 213990d700663103e85db33492d0a242e1c55a41)

3 years agoRework JUnit developer guide 24/96324/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
(cherry picked from commit 02561038a3031b9bc46959094c99fcc18988cd64)

3 years agoRework Yangtools developer guide 23/96323/1
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
(cherry picked from commit c592f7c059e7ea7beec38a443d8a57ddddecd0cc)

3 years agoRework docs documentation 22/96322/1
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
(cherry picked from commit fd28dd8168a0b7b6003864581f5645bc0d3266d0)

3 years agoFix even more spellchecker warnings 21/96321/2
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
(cherry picked from commit 4a03e12ea11c3365b59c0965de2db36ce39a75ec)

3 years agoFix pre-commit and tox and gitlint settings 20/96320/2
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
(cherry picked from commit 18f25b40e64bc60341d4036f09db14401fe9aaf6)

3 years agoFix more spellchecker warnings 19/96319/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
(cherry picked from commit 8d1bac9b58b814359a3e21415220269468485718)

3 years agoUpdate conf.py intersphinx controller version 34/96434/1
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

3 years agoFix some spellchecker warnings 17/96317/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
(cherry picked from commit d1b7686813219d0dc10ff2847d8d83dccdbf9e0d)

3 years agoFix some dead links 16/96316/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
(cherry picked from commit 25889c05abefcec60626b2d4d4b8057bf0782790)

3 years agoUpdate Al SR3 and SR2 release dates 97/95897/3
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

3 years agoUpdate Si SR1 and Al SR4 release schedule 96/95896/1
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

3 years agoUpdate Download page 66/95766/4
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

3 years agoAdjust code after branching silicon 85/95685/4
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

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