Merge "Rework Yangtools developer guide" into stable/silicon

Merge "Rework docs documentation" into stable/silicon

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>

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

Decrease Sphinx tox profiles logs verbosity

This will ease gate failures analysis.

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

Update release notes for Silicon-SR1

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

Fix some regex in docs/conf.py

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

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

Rework Yangtools developer guide

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

Rework docs documentation

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

Fix even more spellchecker warnings

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I6a4ea52c9ef02d4134e97729501a7e0371bfbbd4
(cherry picked from commit 4a03e12ea11c3365b59c0965de2db36ce39a75ec)

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)

Fix more spellchecker warnings

Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ie11a9fe46ac3fb267a994062dd99d95a190c02a4
(cherry picked from commit 8d1bac9b58b814359a3e21415220269468485718)

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

Fix some spellchecker warnings

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

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)

Update Al SR3 and SR2 release dates

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

Update Si SR1 and Al SR4 release schedule

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

Update Download page

JIRA: DOCS-135
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Id5ea71c727006ee850618fb99df7b2c5cbfbb1df

Adjust code after branching silicon

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

Improve release schedule introduction

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

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

Fix tranportpce release notes JQL queries

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

Merge "introducing jira ticketing guideline"

Merge "Update documentation about update process"

Merge "Spelling corrections in Yang Tools guide"

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>

introducing jira ticketing guideline

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

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>

Spelling corrections in Yang Tools guide

JIRA: DOCS-120
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Change-Id: I7b14497fc4500ad6a884441e67a2e9ee166f83a3

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

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>

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>

automating release notes pages using jira filters.

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

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>

Update Silicon Code Freeze schedule

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

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>

Merge "Migrate old wiki component tests best practices"

Merge "Migrate old wiki considerations on tests"

Merge "Migrate old wiki Junit best practices"

Merge "embed and fix metada of the technical charter pdf"

Merge "Migrate old wiki Copyright best practices"

Merge "Migrate old wiki Logging subsystem best practices"

Merge "Migrate old wiki commit message best practices"

Merge "Split coding guidelines by language"

Merge "improve documentation structure"

Merge "Update cluster documentation"

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>

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

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

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

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

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

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

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

Split coding guidelines by language

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

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

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

add a contributor guide for newcomers

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

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

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

Update Aluminium SR1 download page

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

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

Merge "Ignore ssh:// links in docs-linkcheck"

Ignore ssh:// links in docs-linkcheck

Ignore links that are the SSH protocol.

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Id458c810b0adf72922d3880b86e5605179ead67c

Expand Silicon upgrade guide

Document MD-SAL impacts and future removals.

Change-Id: I5ab87798da8a2a9d4629e30892467ddcd0d776fa
Signed-off-by: Robert Varga <robert.varga@pantheon.tech>

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

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

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>

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>

Merge "Start Silicon platform upgrade guide"

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>

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>

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)

Add project release notes templates

Change-Id: Ib56f571d653e844b24a2c3af6879e708106cd5fe
Signed-off-by: Luis Gomez <ecelgp@gmail.com>
(cherry picked from commit 916ab9cca4fe5eb11384a653bae313878831dc4a)

Update Silicon release schedule

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: I1776f9409d2864c50ff79ddafa63297c6165606a

Update intersphinx for Silicon

Change-Id: I30cafbc696bb6dd671e56418a418f0354cf5b2f7
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update config for Silicon release

Change-Id: I5379e9217a2eaf368add0a9f28ebe78826b6df31
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Add Aluminium release to downloads

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Id4e9b8151553985746f7f5a6a873a7b4c3d9de91

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>

Merge "Add rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst"

Add rfc8040 urls for docs/getting-started-guide/persistence_and_backup.rst

Signed-off-by: aman1403 <170030039@iitdh.ac.in>
Change-Id: I8f1d2b6a0d1d09adff14d6221b2ab90dde98aef7

Add rfc8040 urls for docs/getting-started-guide/clustering.rst

Change-Id: I8f1d2b6a0d1d09adff14d6221b2ab90dde98aef8
Signed-off-by: aman1403 <170030039@iitdh.ac.in>

Update Sodium-SR4 link header

Change-Id: Ida02578d91281e9387a3b83bd192da86761a6a3e
Signed-off-by: Thanh Ha <zxiiro@gmail.com>

Update the SR4 release of the Sodium schedule

Change-Id: Ic2c4b25175d27e47a6d64030514a8ec863e851aa
Signed-off-by: David Baugher <dbaugher@luminanetworks.com>

fix iana-afn-safi spelling in migration guide

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

Remove the Magnesium release notes from Latest

Signed-off-by: David Baugher <dbaugher@luminanetworks.com>
Change-Id: I948130604bf32f08b9a8c746e5e32849af7545d5

Merge "Fix Magnesium-SR2 release date to Aug 11"

Merge "Rewrite script to activate project docs versions"

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

Merge "Add branch cutting checklist"

Merge "Update downloads page for Magnesium SR2"

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

Add branch cutting checklist

Signed-off-by: Thanh Ha <zxiiro@gmail.com>
Change-Id: Ib27690b5473aba246a7508b92401895429199d85

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

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

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

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>

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

Update downloads page for Magnesium SR2

Change-Id: Ic6e1575bc8a81a8c67969a082fa3ab17c7903d79
Signed-off-by: Anil Belur <abelur@linuxfoundation.org>