doc.git
2 years agoMerge "Remove indirect deps" into honolulu honolulu
Eric Debeau [Thu, 30 Sep 2021 14:40:51 +0000 (14:40 +0000)]
Merge "Remove indirect deps" into honolulu

2 years agoMerge "Make funcparserlib + lfdocs-conf work on RTD" into honolulu
Eric Debeau [Thu, 30 Sep 2021 14:40:21 +0000 (14:40 +0000)]
Merge "Make funcparserlib + lfdocs-conf work on RTD" into honolulu

2 years agoMerge "Split concreate and abstract dependencies" into honolulu
Eric Debeau [Thu, 30 Sep 2021 14:39:44 +0000 (14:39 +0000)]
Merge "Split concreate and abstract dependencies" into honolulu

2 years agoRemove indirect deps 21/124621/1
Cédric Ollivier [Wed, 29 Sep 2021 14:22:01 +0000 (16:22 +0200)]
Remove indirect deps

It leverages the latest lfdocs-conf (0.7.7) updates

Issue-ID: DOC-765
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: Id2b63f273ddfb41487b6424e3d14fbdf4cbd837d
(cherry picked from commit 036feae5d7b96952da0f4fccefcdefe2eee72c8f)

2 years agoMake funcparserlib + lfdocs-conf work on RTD 20/124620/1
Cédric Ollivier [Tue, 28 Sep 2021 15:20:21 +0000 (17:20 +0200)]
Make funcparserlib + lfdocs-conf work on RTD

RTD doesn't manage upper constraints. We do add here bounds (abstract
dependencies) until lfdocs-conf is fixed.

Issue-ID: DOC-765

Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
Change-Id: I7e59613f0be37b85b02a3bf208e454e1d1ca69a4
(cherry picked from commit 617f9f32cc38b85393118b761d27e0f0dedaef31)

2 years agoSplit concreate and abstract dependencies 19/124619/1
Cédric Ollivier [Tue, 28 Sep 2021 11:48:21 +0000 (13:48 +0200)]
Split concreate and abstract dependencies

It adds 2 upper-constraints to pin all the dependencies.
It modifies a little bit the official upper-constraints.txt from
OpenStack due to Sphinx (4.2.0 as asked by lfdocs-conf vs 3.5.2) and
due to setuptools (58.1.0 as used in ONAP gates vs 54.1.1).

In a long run, etc/upper-constraints.os.txt should be removed once ONAP
is synced with OpenStack. For it's part, etc/upper-constraints.onap.txt
should be centralized for all ONAP projects and then removed from this
particular project.

It should be noted that lfdocs-conf still mismatches concrete and
abstract deps.

Issue-ID: DOC-765

Change-Id: Iccf1e4cdab93acc9c55acb16cb11e3b3fcef3291
Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
(cherry picked from commit ee3abf180c9df7813f16ee9fba7958860fc9ea6b)

2 years agoUpdate the date of the 8.0.1 Honolulu MR 80/124580/1
Andreas Geissler [Tue, 28 Sep 2021 10:33:10 +0000 (10:33 +0000)]
Update the date of the 8.0.1 Honolulu MR
Issue-ID: DOC-763

Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de>
Change-Id: Id93d74809d286e3fc11c02dbfdde57bc12714d5a
(cherry picked from commit 99d881b99b494d64ced8bc30d19847e3a951be7b)

2 years agoAdded 1st version of the Honolulu Maintenance Release notes 78/124178/2
Andreas Geissler [Fri, 10 Sep 2021 11:02:36 +0000 (11:02 +0000)]
Added 1st version of the Honolulu Maintenance Release notes
Issue-ID: DOC-763

Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de>
Change-Id: Ib4d308f01ae3abe353cb2991e6af30cd3801707d
(cherry picked from commit 58a981c40405e500f949923f986fe39ad1bf8dc1)

2 years agofix broken link in setting-up-environment.rst 79/124179/1
thmsdt [Thu, 29 Jul 2021 11:19:59 +0000 (13:19 +0200)]
fix broken link in setting-up-environment.rst

Issue-ID: DOC-755

Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ib8f86ff1bbce589a45d45573106cfe47656c8376
(cherry picked from commit bf7a147c93e4ddf725c54b0853f6836a48030c2e)

3 years agoUpdated Release Date to 11th May 26/121026/1
andreasgeissler [Tue, 4 May 2021 07:53:18 +0000 (09:53 +0200)]
Updated Release Date to 11th May

Issue-ID: DOC-728

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I302b93a36bd1205473945a8f2a17034f07fe369e
(cherry picked from commit 1fbcf689a19367ff9237adc864578d4353809358)

3 years agoAdd reference to OSA repo from main documentation page 22/121022/1
Krzysztof Opasiak [Fri, 31 May 2019 23:02:41 +0000 (01:02 +0200)]
Add reference to OSA repo from main documentation page

In order to make it easy for users to find, let's add OSA reference
to the main page of ONAP documentation

Issue-ID: SECCOM-239
Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
Change-Id: I2c009a1a21289c2dd18f0e60122a24ec86aefb40
(cherry picked from commit 5c91534a6d304bf1076ab45e6010dfd490b2a9de)

3 years agoFix .gitreview with honolulu 27/120927/1
Eric Debeau [Tue, 27 Apr 2021 09:43:15 +0000 (11:43 +0200)]
Fix .gitreview with honolulu

By default, the master branch is selected by git-review clients.
Change the defaultbranch to honolulu in .gitreview file.

Issue-ID: DOC-738

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Ibe989b3433138e046485ec4bab62a250abca51c6

3 years agoHonolulu: Moved CLAMP (not part of the release) to "Migrated Projects" 23/120923/1
Thomas Kulik [Tue, 27 Apr 2021 08:24:44 +0000 (10:24 +0200)]
Honolulu: Moved CLAMP (not part of the release) to "Migrated Projects"

Issue-ID: DOC-737

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: If9910c0fdc60cbd7d7ae67a465ea74f4a277f486

3 years agoMerge "[DOC] Decrease Sphinx tox profiles logs verbosity" into honolulu
Thomas Kulik [Tue, 27 Apr 2021 07:42:03 +0000 (07:42 +0000)]
Merge "[DOC] Decrease Sphinx tox profiles logs verbosity" into honolulu

3 years agoUpdate Project specific release note page 39/120839/1
andreasgeissler [Thu, 22 Apr 2021 08:12:25 +0000 (10:12 +0200)]
Update Project specific release note page

Issue-ID: DOC-728

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: Iba2666912aca5445e01f340e7defcf952631dedc
(cherry picked from commit 51ecad266717b1f4593e752a0ae179d066068c88)

3 years agoFix architecture func diagram 31/120831/1
byungwoojun [Fri, 23 Apr 2021 13:50:37 +0000 (09:50 -0400)]
Fix architecture func diagram

Fix architecture func diagram and its description

Issue-ID: DOC-736
Signed-off-by: byungwoojun <byung-woo.jun@ericsson.com>
Change-Id: I83fe2908e1537595e29f1f18c2a789c5172ebe19
(cherry picked from commit 136a3651f508c0c4a042970adea23a9c315e162c)

3 years ago[DOC] Decrease Sphinx tox profiles logs verbosity 30/120830/1
Guillaume Lambert [Fri, 23 Apr 2021 09:14:34 +0000 (11:14 +0200)]
[DOC] Decrease Sphinx tox profiles logs verbosity

to ease gate failures analysis as proposed by Eric.

Issue-ID: DOC-710
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I5fe51e5794f58ca0200be57aa161d2f965523776
(cherry picked from commit dbf91770dfd60a27bdb0a0ccbb4ce51e6d1e0c2c)

3 years agoCreate composite note for Honolulu Release 23/120823/1
Eric Debeau [Thu, 22 Apr 2021 09:58:28 +0000 (11:58 +0200)]
Create composite note for Honolulu Release

Composite release note to describe the main evolution for Honolulu

Issue-ID: DOC-728

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Ic66b573a5efb506c7c2c6e4dd8cf1f348d884bf2
(cherry picked from commit 5ca5dc10400b0b1262189409fe8f9fdac32082b7)

3 years agoUpdate architecture description for Honolulu 21/120821/1
byungwoojun [Tue, 13 Apr 2021 20:00:03 +0000 (16:00 -0400)]
Update architecture description for Honolulu

Updated architecture descrition to add CPS for Honolulu

Issue-ID: DOC-734

Signed-off-by: byungwoojun <byung-woo.jun@ericsson.com>
Change-Id: Iea30427ec85edc43d728f8302d972003e59e57ec
(cherry picked from commit ce69aa59a6ebae37f3cbafd63e944a7e367d9d2f)

3 years agoUpdate conf.py and conf.yaml 86/120686/4
andreasgeissler [Tue, 20 Apr 2021 07:25:30 +0000 (09:25 +0200)]
Update conf.py and conf.yaml
Issue-ID: DOC-729

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: Ic5c73957db4513e7c4498d7a5d4c17cfc5bc36c9

3 years agoupdate checkdocs.sh wiki_lifecycle_state 48/120648/1
Thomas Kulik [Mon, 19 Apr 2021 15:13:12 +0000 (17:13 +0200)]
update checkdocs.sh wiki_lifecycle_state

Issue-ID: DOC-735

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: I0c0a9adbaeb3b434651c746ffbe177e805b2820f

3 years agoMerge "[DOC] Installation guidelines for PaaS components"
Andreas Geissler [Tue, 13 Apr 2021 11:15:19 +0000 (11:15 +0000)]
Merge "[DOC] Installation guidelines for PaaS components"

3 years agoupdate checkdocs.sh to provide lifecycle state information+ 95/120395/1
Thomas Kulik [Mon, 12 Apr 2021 08:19:38 +0000 (10:19 +0200)]
update checkdocs.sh to provide lifecycle state information+

Issue-ID: DOC-732

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: I24504f503a141352b5e93dc02219841042aee314

3 years agoUpdated to consider new PTL 28/120228/1
Thomas Kulik [Tue, 6 Apr 2021 12:42:07 +0000 (14:42 +0200)]
Updated to consider new PTL

Issue-ID: DOC-731

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: Id463c55efb7db10cf695d418f6d80fb4d8a4b9c6

3 years agoUpdate the components list and move Portal to "unmaintained" 18/120118/3
andreasgeissler [Thu, 1 Apr 2021 15:27:20 +0000 (17:27 +0200)]
Update the components list and move Portal to "unmaintained"

Issue-ID: DOC-721

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I668d593bd562a307a5e237bec6246c87c2424837

3 years agoMerge "Update conf.py and Documentation Release Notes for Honolulu"
Eric Debeau [Thu, 1 Apr 2021 13:47:02 +0000 (13:47 +0000)]
Merge "Update conf.py and Documentation Release Notes for Honolulu"

3 years agoID corrected for Thomas Kulik 79/120079/1
Thomas Kulik [Thu, 1 Apr 2021 09:57:00 +0000 (11:57 +0200)]
ID corrected for Thomas Kulik

Issue-ID: DOC-722

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: Ic0671cfafae11c4c19ffbb4df898007f79ad51d0

3 years agoUpdate conf.py and Documentation Release Notes for Honolulu 78/120078/3
andreasgeissler [Thu, 1 Apr 2021 08:17:03 +0000 (10:17 +0200)]
Update conf.py and Documentation Release Notes for Honolulu

Issue-ID: DOC-727

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I78ffbc5ba306ed9868fecbea24d07cfaf7e5d049

3 years agoIssue-ID: DOC-730 65/120065/1
Thomas Kulik [Wed, 31 Mar 2021 12:53:19 +0000 (14:53 +0200)]
Issue-ID: DOC-730
update checkdocs.sh to recognize multiple tox.ini

Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: I317133a71f1338215985a1157e37d1048f8c5129

3 years agoCorrected DMaaP name and linking to unmaintained projects 06/120006/2
andreasgeissler [Tue, 30 Mar 2021 09:35:30 +0000 (11:35 +0200)]
Corrected DMaaP name and linking to unmaintained projects

Issue-ID: DOC-723

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I0c333f68e56f1b02c4f87e724586c8c0aa05f057

3 years agoSigned-off-by: Thomas Kulik <thomas.kulik@telekom.de> 57/119957/1
Thomas Kulik [Mon, 29 Mar 2021 10:56:54 +0000 (12:56 +0200)]
Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Issue-ID: DOC-726
update checkdocs.sh to read INFO.yaml  (project lifecycle state)

Change-Id: I68a676bcdd4725ae43fe33043ec5114f4268cac1
Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
3 years agoCorrect kubectl command in cloud-site manual 97/119897/1
andreasgeissler [Fri, 26 Mar 2021 11:06:54 +0000 (12:06 +0100)]
Correct kubectl command in cloud-site manual

Issue-ID: DOC-715

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I0d579707fc68b1a0d27562ce0a5b3a5659fe0578

3 years agoMerge "Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>"
Andreas Geissler [Fri, 26 Mar 2021 08:09:49 +0000 (08:09 +0000)]
Merge "Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>"

3 years agoMerge "Added a warning about the scope of the B&R description"
Sofia Wallin [Thu, 25 Mar 2021 13:26:34 +0000 (13:26 +0000)]
Merge "Added a warning about the scope of the B&R description"

3 years agoSigned-off-by: Thomas Kulik <thomas.kulik@telekom.de> 25/119725/1
Thomas Kulik [Wed, 24 Mar 2021 13:28:05 +0000 (14:28 +0100)]
Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Updated to use gerrit mirror.
Issue-ID: DOC-724

Change-Id: I56ed568c926ee48e2f230c325df86f34f3de395b
Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
3 years ago[DOC] Installation guidelines for PaaS components 40/118840/8
Sylwia Jakubek [Fri, 5 Mar 2021 07:53:58 +0000 (07:53 +0000)]
[DOC] Installation guidelines for PaaS components

Linked documentation of guidelines for installation of Prometheus Stack and Cert-Manager

Issue-ID: OOM-2701
Signed-off-by: Sylwia Jakubek <sylwia.jakubek@nokia.com>
Change-Id: I90a1fb29a296927a8e695566939566f75e925258

3 years agoMerge "Add CPS in release notes, API, Architecture and Component pages Update AAI...
Eric Debeau [Fri, 19 Mar 2021 12:21:14 +0000 (12:21 +0000)]
Merge "Add CPS in release notes, API, Architecture and Component pages Update AAI UI in Component pages"

3 years agoAdd CPS in release notes, API, Architecture and Component pages 11/119511/3
andreasgeissler [Thu, 18 Mar 2021 15:00:37 +0000 (16:00 +0100)]
Add CPS in release notes, API, Architecture and Component pages
Update AAI UI in Component pages

Issue-ID: DOC-721

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I7a66fbdf2876a26d2e8e45fd3cdc9dff122debb4

3 years agoPromoting Thomas Kulik as committer 07/119507/1
Sofia Wallin [Thu, 18 Mar 2021 14:20:27 +0000 (15:20 +0100)]
Promoting Thomas Kulik as committer

I would like to nominate Thomas Kulik as a committer to the doc project.

Thomas has made significant contribution to the team such as supporting in
maintaining the tool chain, organizing sessions for events,
actively participating in meetings, troubleshooting as well as working with
end to end documentation.

Issue-ID: DOC-722

Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
Change-Id: I0a0e1cc37061035859336f9fad497f3e8ac48d9f

3 years agoAdded a warning about the scope of the B&R description 65/119365/2
andreasgeissler [Tue, 16 Mar 2021 11:10:55 +0000 (12:10 +0100)]
Added a warning about the scope of the B&R description

Issue-ID: DOC-718

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I26322041651995b7f649abd38664e8f42adffb27

3 years agoPolicy/Clamp doc update 44/119444/3
osgn422w [Wed, 17 Mar 2021 12:05:56 +0000 (13:05 +0100)]
Policy/Clamp doc update

update the documentation to reflect
the merge of clamp into Policy framework

Issue-ID: REQ-684
Change-Id: I2948f7af24a4beadabed21a929f22c4e6984f55d
Signed-off-by: osgn422w <gervais-martial.ngueko@intl.att.com>
3 years agoMerge "[DOC] Add link to VID documentation (Instantiate Service, “Macro” mode (PNF...
Eric Debeau [Wed, 10 Mar 2021 13:10:38 +0000 (13:10 +0000)]
Merge "[DOC] Add link to VID documentation (Instantiate Service, “Macro” mode (PNF example)) Issue-ID: VID-970"

3 years agoUpdate the Release date and corrected component changes 44/119044/1
andreasgeissler [Wed, 10 Mar 2021 09:42:16 +0000 (10:42 +0100)]
Update the Release date and corrected component changes
in composite release note
Issue-ID: DOC-709

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I6e94cf6996be246322a107c0bf788e126e32c9e0

3 years ago[DOC] Add link to VID documentation (Instantiate Service, “Macro” mode (PNF example)) 20/118820/5
Marcin Rzepecki [Thu, 4 Mar 2021 15:13:45 +0000 (16:13 +0100)]
[DOC] Add link to VID documentation (Instantiate Service, “Macro” mode (PNF example))
Issue-ID: VID-970

Signed-off-by: Marcin Rzepecki <marcin.rzepecki@nokia.com>
Change-Id: I20ff95a88ef013afb0cb80401e18f93238580032

3 years agoMerge "[DOC] Resource Onboarding - licenses"
Andreas Geissler [Mon, 22 Feb 2021 09:23:32 +0000 (09:23 +0000)]
Merge "[DOC] Resource Onboarding - licenses"

3 years agoMerge "[DOC] Run autopep8 on conf.py"
Andreas Geissler [Thu, 18 Feb 2021 16:01:30 +0000 (16:01 +0000)]
Merge "[DOC] Run autopep8 on conf.py"

3 years agoMerge "[DOC] Add python linters for conf.py in tox.ini"
Andreas Geissler [Thu, 18 Feb 2021 15:55:30 +0000 (15:55 +0000)]
Merge "[DOC] Add python linters for conf.py in tox.ini"

3 years agoMerge "[DOC] Remove useless entries in requirements.txt"
Andreas Geissler [Thu, 18 Feb 2021 15:51:34 +0000 (15:51 +0000)]
Merge "[DOC] Remove useless entries in requirements.txt"

3 years agoMerge "[DOC] Improve words whitelist"
Andreas Geissler [Thu, 18 Feb 2021 15:49:42 +0000 (15:49 +0000)]
Merge "[DOC] Improve words whitelist"

3 years agoMerge "[DOC] Use words whitelist default filename"
Andreas Geissler [Thu, 18 Feb 2021 15:49:17 +0000 (15:49 +0000)]
Merge "[DOC] Use words whitelist default filename"

3 years ago[DOC] Run autopep8 on conf.py 41/117941/2
Guillaume Lambert [Wed, 17 Feb 2021 10:48:28 +0000 (11:48 +0100)]
[DOC] Run autopep8 on conf.py

Issue-ID: DOC-710
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I95b674bd459f97afcab05ce71f217ac70114cf1b

3 years ago[DOC] Add python linters for conf.py in tox.ini 40/117940/2
Guillaume Lambert [Wed, 17 Feb 2021 10:46:10 +0000 (11:46 +0100)]
[DOC] Add python linters for conf.py in tox.ini

and configure them with some project default standards

Issue-ID: DOC-710
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I94505a4db4b64b77dfb37bc4fc041d2e0264c900

3 years ago[DOC] Resource Onboarding - licenses 16/118016/1
JerzySzachniewicz [Mon, 15 Feb 2021 10:56:10 +0000 (11:56 +0100)]
[DOC] Resource Onboarding - licenses

Issue-ID: SDC-3471
Signed-off-by: JerzySzachniewicz <jerzy.szachniewicz@nokia.com>
Change-Id: I9d5d5d0c841246f829d1ec20dc6589d6bc626b74

3 years agoMerge "Added composite release note for Guilin 7.0.1"
Sofia Wallin [Tue, 16 Feb 2021 07:45:41 +0000 (07:45 +0000)]
Merge "Added composite release note for Guilin 7.0.1"

3 years ago[DOC] Remove useless entries in requirements.txt 52/117852/1
Guillaume Lambert [Mon, 15 Feb 2021 14:36:41 +0000 (15:36 +0100)]
[DOC] Remove useless entries in requirements.txt

Issue-ID: DOC-710
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Iaa23acd1b87900ec96eb832ecbe339cf5f553198

3 years agoAdded composite release note for Guilin 7.0.1 34/117834/1
andreasgeissler [Mon, 15 Feb 2021 09:55:15 +0000 (10:55 +0100)]
Added composite release note for Guilin 7.0.1

Issue-ID: DOC-709

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I44005e42556b020e97c97c7c01a1b0297073f0bb

3 years agoAdded DOC release note for 7.0.1 29/117829/1
andreasgeissler [Mon, 15 Feb 2021 09:24:40 +0000 (10:24 +0100)]
Added DOC release note for 7.0.1

Issue-ID: DOC-704

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I3edb18126d2baa4dc93c164249d052d62b7865ec

3 years ago[DOC] Improve words whitelist 68/117668/1
Guillaume Lambert [Wed, 10 Feb 2021 10:23:33 +0000 (11:23 +0100)]
[DOC] Improve words whitelist

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ie8717e321bc1e05dd9b7969ed067952e66e4a813

3 years ago[DOC] Use words whitelist default filename 67/117667/1
Guillaume Lambert [Wed, 10 Feb 2021 10:21:02 +0000 (11:21 +0100)]
[DOC] Use words whitelist default filename

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I00c67d2c749023e9f342f27edff62f21af45a563

3 years agoMerge "[DOC] Fix sphinx add_stylesheet deprecated method"
Eric Debeau [Tue, 9 Feb 2021 13:23:41 +0000 (13:23 +0000)]
Merge "[DOC] Fix sphinx add_stylesheet deprecated method"

3 years agoMerge "[DOC] Fix tox docs-linkcheck profile issues"
Eric Debeau [Tue, 9 Feb 2021 13:23:18 +0000 (13:23 +0000)]
Merge "[DOC] Fix tox docs-linkcheck profile issues"

3 years agoMerge "[DOC] Reactivate docs-linkcheck profile"
Eric Debeau [Tue, 9 Feb 2021 13:22:26 +0000 (13:22 +0000)]
Merge "[DOC] Reactivate docs-linkcheck profile"

3 years agoMerge "[DOC] Enforce warnings at docs buildtime"
Eric Debeau [Tue, 9 Feb 2021 13:22:12 +0000 (13:22 +0000)]
Merge "[DOC] Enforce warnings at docs buildtime"

3 years agoMerge "[DOC] Remove tox.ini doppelganger"
Eric Debeau [Tue, 9 Feb 2021 13:21:56 +0000 (13:21 +0000)]
Merge "[DOC] Remove tox.ini doppelganger"

3 years agoMerge "[DOC] Fix docs buildtime warnings"
Eric Debeau [Tue, 9 Feb 2021 13:21:40 +0000 (13:21 +0000)]
Merge "[DOC] Fix docs buildtime warnings"

3 years agoMerge "[DOC] Use sphinxcontrib-needs versions < 0.6.0"
Eric Debeau [Tue, 9 Feb 2021 13:21:26 +0000 (13:21 +0000)]
Merge "[DOC] Use sphinxcontrib-needs versions < 0.6.0"

3 years ago[DOC] vFWCL design tutorial 92/117092/8
ramagp [Sun, 24 Jan 2021 16:32:34 +0000 (16:32 +0000)]
[DOC] vFWCL design tutorial

This describes step by step instructions for vfwcl design

Change-Id: Ie6f88703e1923c06dec7ad45db78ef847cb68607
Issue-ID: DOC-708
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years ago[DOC] vFW service deployment tutorial 91/117091/7
ramagp [Sun, 24 Jan 2021 16:23:31 +0000 (16:23 +0000)]
[DOC] vFW service deployment tutorial

This describes step by step instructions for vfw deployment

Change-Id: I4bf1bbbf02d0fc05cfd1d967c47eefe4453636c1
Issue-ID: DOC-708
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years ago[DOC] Fix sphinx add_stylesheet deprecated method 68/117368/3
Guillaume Lambert [Tue, 2 Feb 2021 14:35:50 +0000 (15:35 +0100)]
[DOC] Fix sphinx add_stylesheet deprecated method

by using add_css_file instead

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Ib8af980dc116fc551ca180c28cfb658bb6f86299

3 years ago[DOC] Fix tox docs-linkcheck profile issues 65/117365/3
Guillaume Lambert [Tue, 2 Feb 2021 14:07:08 +0000 (15:07 +0100)]
[DOC] Fix tox docs-linkcheck profile issues

- ignore URLs logically unreachable such as about:config
- and create a code block for the git clone URL that is not reachable
- ignore URLs with anchors (especially the ones ill-generated
  from external objects, mainly onap-integration)
- enforce tox docs-lincheck profile

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I619d8d5697a35bf2bdf3ee2ed59ca9f5733e7802

3 years ago[DOC] Reactivate docs-linkcheck profile 64/117364/3
Guillaume Lambert [Tue, 2 Feb 2021 13:15:40 +0000 (14:15 +0100)]
[DOC] Reactivate docs-linkcheck profile

so that it can be used to identify broken links.
Since there are still issues with some links, force tox results
to success.

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: Iec1a5d913ad4fe6823476be545cb833084f146e5

3 years ago[DOC] Enforce warnings at docs buildtime 56/117356/2
Guillaume Lambert [Tue, 2 Feb 2021 12:07:40 +0000 (13:07 +0100)]
[DOC] Enforce warnings at docs buildtime

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I36294591e42737592ffecdd5ec8f7d231d3c50d1

3 years ago[DOC] Remove tox.ini doppelganger 70/117370/2
Guillaume Lambert [Tue, 2 Feb 2021 14:48:14 +0000 (15:48 +0100)]
[DOC] Remove tox.ini doppelganger

in docs folder

- same profiles are declared in tox.ini.
  They can be calld from the docs folder without it.
- once run from the docs folder, this generates invalid files
  in doc/.tox for linters setup (e.g.  docs/.tox/[..]/invalid.rst).
  They can cause warnings treated as errors by root tox profiles.

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I473ae1193c1e5b124c8532a1b8185f01c67c70de

3 years ago[DOC] Fix docs buildtime warnings 55/117355/1
Guillaume Lambert [Tue, 2 Feb 2021 11:25:17 +0000 (12:25 +0100)]
[DOC] Fix docs buildtime warnings

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I28e269ee146df465e5b9230bd0356e4766c90089

3 years ago[DOC] Use sphinxcontrib-needs versions < 0.6.0 54/117354/1
Guillaume Lambert [Tue, 2 Feb 2021 11:20:11 +0000 (12:20 +0100)]
[DOC] Use sphinxcontrib-needs versions < 0.6.0

This latest version introduces a new services support functionality
- that cannot be easily disabled here
- and that requires additional configuration parameters to link GitHub issues.
We cannot provide these parameters since this project uses JIRA.
As a result, sphinx generates a warning.
https://sphinxcontrib-needs.readthedocs.io/en/service/services/index.html

Issue-ID: DOC-692
Signed-off-by: Guillaume Lambert <guillaume.lambert@orange.com>
Change-Id: I3bfa231467804729deacbe70f1180c06b3eec978

3 years ago[DOC] Tutorial for vfw service design 90/117090/6
ramagp [Sun, 24 Jan 2021 16:04:05 +0000 (16:04 +0000)]
[DOC] Tutorial for vfw service design

This describes step by step instructions for vfw design

Change-Id: I9910b43e6d596bbcb397cc6789dc973992b91c7f
Issue-ID: DOC-708
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years agorestructured UserGuide Section and corrected CLI Userguide Link 50/117050/1
andreasgeissler [Thu, 21 Jan 2021 15:08:52 +0000 (16:08 +0100)]
restructured UserGuide Section and corrected CLI Userguide Link
Issue-ID: DOC-705

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I1ef195b181d18ea47c99aec77a3e90bfcb8736a9

3 years agoMerge "[DOC] Update Service Design documentation section"
Andreas Geissler [Thu, 14 Jan 2021 13:17:16 +0000 (13:17 +0000)]
Merge "[DOC] Update Service Design documentation section"

3 years agoMerge "Instructions for control loop design"
Andreas Geissler [Thu, 14 Jan 2021 13:15:24 +0000 (13:15 +0000)]
Merge "Instructions for control loop design"

3 years ago[DOC] Update Service Design documentation section 71/111971/3
ramagp [Tue, 1 Sep 2020 12:36:24 +0000 (12:36 +0000)]
[DOC] Update Service Design documentation section

This is to update few notes under Service Design section

Change-Id: I6c401fceaf79d5fd74fadfb93902f1b67a63c903
Issue-ID: DOC-664
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years ago[Add K8S site] Remove SO VNFAdapter manual version change V1->V2 26/116526/1
deen1985 [Mon, 28 Dec 2020 10:11:33 +0000 (11:11 +0100)]
[Add K8S site] Remove SO VNFAdapter manual version change V1->V2

Change-Id: I4ca90b654c150b1f28ddaeb442cafdf529f730c3
Signed-off-by: Damian Nowak <damian.nowak@nokia.com>
Issue-ID: DOC-698

3 years agoMerge "[DOC] changes to backup and restore ONAP component specific data bases"
Andreas Geissler [Thu, 10 Dec 2020 15:17:56 +0000 (15:17 +0000)]
Merge "[DOC] changes to backup and restore ONAP component specific data bases"

3 years ago[DOC] changes to backup and restore ONAP component specific data bases 06/114806/5
ramagp [Thu, 12 Nov 2020 08:06:29 +0000 (08:06 +0000)]
[DOC] changes to backup and restore ONAP component specific data bases

Change-Id: I5e40c8b7a4a310414022224df82998b469fe556a
Issue-ID: DOC-682
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years agoInstructions for control loop design 65/116265/2
ramagp [Wed, 9 Dec 2020 17:05:15 +0000 (17:05 +0000)]
Instructions for control loop design

Change-Id: I49d4409c0939fbfd63a5e30dec518642e1de4005
Issue-ID: DOC-681
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
3 years agoMerge "Remove remaining warnings during Documentation buildings"
Sofia Wallin [Mon, 7 Dec 2020 10:34:06 +0000 (10:34 +0000)]
Merge "Remove remaining warnings during Documentation buildings"

3 years agoRemove remaining warnings during Documentation buildings 45/116145/2
Eric Debeau [Fri, 4 Dec 2020 21:19:02 +0000 (22:19 +0100)]
Remove remaining warnings during Documentation buildings

correct files to remove warnings
Remove orphan links
Correct bad links

Issue-ID: DOC-692

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Iac1fea50a4edaf6ef38b97a1b5d689fab0206a15

3 years agoMerge "Update architecture section"
Andreas Geissler [Mon, 7 Dec 2020 08:30:45 +0000 (08:30 +0000)]
Merge "Update architecture section"

3 years agoUpdate architecture section 44/116144/3
Eric Debeau [Fri, 4 Dec 2020 19:30:22 +0000 (20:30 +0100)]
Update architecture section

Update content for Guilin
Update figure (provided by Architectue sub-committee)
Add new section for CDS

Issue-ID: DOC-695
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Ia3c09e9fd47068feb9c28311be875491e6508abd

3 years agoMinor fix to the list of Project Specific Release Notes. 31/116131/1
Sofia Wallin [Fri, 4 Dec 2020 13:57:59 +0000 (14:57 +0100)]
Minor fix to the list of Project Specific Release Notes.

Removing "Project" which is not consistent.
Issue-ID: DOC-694

Signed-off-by: Sofia Wallin <sofia.wallin@est.tech>
Change-Id: I8310fbed05e0944d2b689c6da6ac2133deded1da

3 years agoMerge "Removed outdated SO/Libs reference and missing DMaaP API doc"
Sofia Wallin [Thu, 3 Dec 2020 13:07:27 +0000 (13:07 +0000)]
Merge "Removed outdated SO/Libs reference and missing DMaaP API doc"

3 years agoAdd functional and non-functional requirements lists 47/116047/3
Eric Debeau [Wed, 2 Dec 2020 22:29:24 +0000 (23:29 +0100)]
Add functional and non-functional requirements lists

As decided in PTL meeting (30 november 2020), add list of
functional and non-functional requirements

Add :orphan: to avoid remaining warnings during Documentation build

Issue-ID: DOC-687

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I305057e0de909e0165d0ca8a05b426e97ed1b111

3 years agoRemoved outdated SO/Libs reference and missing DMaaP API doc 60/116060/2
andreasgeissler [Thu, 3 Dec 2020 09:29:53 +0000 (10:29 +0100)]
Removed outdated SO/Libs reference and missing DMaaP API doc

Issue-ID: DOC-672

Signed-off-by: andreasgeissler <andreas-geissler@telekom.de>
Change-Id: I6d9ab697cff82a5af5cee91f20568f13152e8ae2

3 years agoMerge "changes needed in Service Distribution"
Andreas Geissler [Wed, 2 Dec 2020 11:55:13 +0000 (11:55 +0000)]
Merge "changes needed in Service Distribution"

3 years agoMerge "Remove all warnings during Documentation buildings"
Sofia Wallin [Wed, 2 Dec 2020 09:55:18 +0000 (09:55 +0000)]
Merge "Remove all warnings during Documentation buildings"

3 years agoRemove MSB from global Release Note 80/115980/1
Eric Debeau [Tue, 1 Dec 2020 21:17:05 +0000 (22:17 +0100)]
Remove MSB from global Release Note

As decided in PTL meeting (30 november 2020), remove MSB from release note
beaause MSB is uing the Frankfurt Release container

Issue-ID: DOC-687

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Ie14a2d1a01feb12a32822b3531f07150dd79fe98

3 years agoRemove all warnings during Documentation buildings 39/115539/1
Eric Debeau [Mon, 30 Nov 2020 14:32:31 +0000 (15:32 +0100)]
Remove all warnings during Documentation buildings

Remove files with not links:
- guides/onap-developer/architecture/blueprint-enr.rst old file based on Beijing
- smsummary.rst: no more relevant as no more submodules used
- templates/sections/vnf-reference.rst : not referenced
- guides/onap-user/onapportal.rst: redundant
- guides/onap-developer/tutorials/index.rst: no tutorial

Add new files to inlude templates
Move templates directory under how-to-use-docs

Modify global release not label with onap_release_notes to avoid confusion

Issue-ID: DOC-692

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I709765beb02403c4ad058863c2b5136f42968cff

3 years agoMerge "Correct CII badge %"
Sofia Wallin [Mon, 30 Nov 2020 12:09:11 +0000 (12:09 +0000)]
Merge "Correct CII badge %"

3 years agoMerge "Correct broken links"
Sofia Wallin [Mon, 30 Nov 2020 12:08:15 +0000 (12:08 +0000)]
Merge "Correct broken links"

3 years agoMoving style-guide after setting up 82/112882/5
Andrea Visnyei [Fri, 18 Sep 2020 10:51:39 +0000 (12:51 +0200)]
Moving style-guide after setting up

Changed order of Style-guide chapter and setting up chapter.
Editorial change in style-guide: ONAP terms changed to ONAP terminology.

Issue-ID: DOC-669

Change-Id: I12203b8e7736d70d503d32c8e1562ae89aaf336a
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
3 years agoCorrect CII badge % 76/115476/1
Eric Debeau [Fri, 27 Nov 2020 07:59:42 +0000 (08:59 +0100)]
Correct CII badge %

Correct CII badge % with last results from BadgeApp
Corret Doc8 warnings

Issue-ID: DOC-687

Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I465055248b357f1ec5b22e9283f3a46a77df745a