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
Eric Debeau [Thu, 23 Sep 2021 18:58:26 +0000 (20:58 +0200)]
Correct configuration for Sphinx generation
- remove useless code in docs/conf.py
- force lfdocs-confr~=0.7.5 in etc/requirements.txt
- add funcparserlib==1.0.0a0 in etc/requirements.txt
- enforce compatible versions in others packages
Issue-ID: DOC-765
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: I3e963dd2bdaaf5e484e1c3270674373eef3fce24
thmsdt [Mon, 23 Aug 2021 12:21:33 +0000 (14:21 +0200)]
Revert "123296 Lastest released doc as a default in RTD" manually
Issue-ID: DOC-758
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ie0ea16b63c42de1ca1fa0875f455e59c796851bd
thmsdt [Tue, 17 Aug 2021 09:35:27 +0000 (11:35 +0200)]
Lastest released doc as a default in RTD
Issue-ID: DOC-758
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I78c406dfe023de6c300cce121fe21b33e8fe13ae
thmsdt [Tue, 10 Aug 2021 13:33:34 +0000 (15:33 +0200)]
Color update, notes update, repo cleanup
Issue-ID: DOC-757
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ifbb976fa6c7982a59855169a26ef33c2e570cd79
thmsdt [Mon, 9 Aug 2021 14:30:57 +0000 (16:30 +0200)]
Color update for Interactive ONAP Architecture Overview
Issue-ID: DOC-757
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ibf5c7bff8ea347c60a23ac6c2aa031974b77e704
thmsdt [Tue, 3 Aug 2021 13:15:14 +0000 (15:15 +0200)]
Spellchecking visible in Design-Overview.png
Issue-ID: DOC-707
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I006a1678f74ec513b92f711e97c5f6b6df7d03e6
thmsdt [Mon, 2 Aug 2021 12:33:13 +0000 (14:33 +0200)]
Interactive ONAP Architecture Overview added
Issue-ID: DOC-757
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I7946e9db32d899ab97039a7fb62a9c1b213de8f1
Gergely Csatari [Fri, 30 Jul 2021 13:52:03 +0000 (16:52 +0300)]
[c2m]: Minor corrections
- Use env variables to define username and password instead of code modification
- Proxy setting corrected
Issue-ID: DOC-756
Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Change-Id: I76a72fec8550ede3935081ecc4917a277d3ec919
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
thmsdt [Thu, 17 Jun 2021 06:06:45 +0000 (23:06 -0700)]
Update "Setup of a Documentation Development System"
Issue-ID: DOC-746
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ibe5e922a1da0dc4744296ae5bad1f693dffcd1cf
thmsdt [Wed, 16 Jun 2021 09:35:32 +0000 (02:35 -0700)]
Update developer guide index
Issue-ID: DOC-751
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I1b6b8d79f3bd8af3c2ea50c356886e53c2d31e61
thmsdt [Tue, 15 Jun 2021 09:18:36 +0000 (02:18 -0700)]
Correct guides/onap-user/index.rst
Issue-ID: DOC-749
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Idc2bc766610b641fdf164d1740fdb8ea09995788
Thomas Kulik [Tue, 15 Jun 2021 09:13:33 +0000 (09:13 +0000)]
Merge "Update project release note index"
thmsdt [Mon, 14 Jun 2021 11:54:11 +0000 (04:54 -0700)]
Update project release note index
Issue-ID: DOC-748
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I78effb0a446867701c85a76feb517fa7af44c79c
Thomas Kulik [Tue, 15 Jun 2021 06:30:53 +0000 (06:30 +0000)]
Merge "Updated updates and reviews chapter"
Andrea Visnyei [Fri, 28 May 2021 11:51:35 +0000 (13:51 +0200)]
Updated updates and reviews chapter
Removed outdated information about submodules, added new content
Change-Id: Ie96da4f3f430a2eee940e8df6cac7681a22f6fb6
Issue-ID: DOC-743
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
thmsdt [Thu, 10 Jun 2021 15:53:28 +0000 (08:53 -0700)]
Update doc/tools: Project Release Partizipation / Whitespaces
Issue-ID: DOC-745
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I36022304b3c9e6eaf5c7d150a3849551e07c36c4
Thomas Kulik [Tue, 8 Jun 2021 13:06:23 +0000 (13:06 +0000)]
Merge "Update doc/tools"
thmsdt [Wed, 2 Jun 2021 09:25:04 +0000 (02:25 -0700)]
Update "Setup of a Documentation Development System" (table space)
Issue-ID: DOC-746
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I82c7cd51f81b57c4863fa53d386d83d478ecaccb
thmsdt [Tue, 1 Jun 2021 11:42:34 +0000 (04:42 -0700)]
Update doc/tools
Issue-ID: DOC-745
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: I5ede64f51d5beb82d146c412a0915e1e59cd9779
Eric Debeau [Mon, 31 May 2021 06:53:08 +0000 (06:53 +0000)]
Merge "Add guide for a doc dev system"
Joanna Jeremicz [Tue, 18 May 2021 14:38:03 +0000 (16:38 +0200)]
Update documentation with SDC Helm Validator information
Issue-ID: SDC-3185
Signed-off-by: Joanna Jeremicz <joanna.jeremicz@nokia.com>
Change-Id: Icea183c12d8983b69387fa0e5eb07cd4d5374204
thmsdt [Mon, 10 May 2021 14:54:33 +0000 (07:54 -0700)]
Add guide for a doc dev system
Issue-ID: DOC-742
Signed-off-by: thmsdt <thomas.kulik@telekom.de>
Change-Id: Ie6071576bce613edaf50433b7b84b69b16e0e88c
Andreas Geissler [Thu, 6 May 2021 13:47:49 +0000 (13:47 +0000)]
Merge "Template updates - sections"
Andrea Visnyei [Wed, 9 Dec 2020 11:26:35 +0000 (12:26 +0100)]
Template updates - sections
Instructions and examples added, notes commented out, review comments implemented
Add example.com in the linkcheck_ignore
Issue-ID: DOC-696
Change-Id: I8221ba6f2adce534ced7d8c06fbc7f23eef39efe
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
Andreas Geissler [Thu, 6 May 2021 13:20:41 +0000 (13:20 +0000)]
Merge "[DOC] updated vFWCL deployment tutorial"
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
Eric Debeau [Mon, 3 May 2021 14:09:01 +0000 (14:09 +0000)]
Merge "Move examples from Addendum to Setting Up chapter"
Thomas Kulik [Mon, 3 May 2021 06:57:12 +0000 (06:57 +0000)]
Merge "Add reference to OSA repo from main documentation page"
ramagp [Tue, 27 Apr 2021 04:40:23 +0000 (04:40 +0000)]
[DOC] updated vFWCL deployment tutorial
Change-Id: I0b24a7d8f809d33eee63e5ba77a71d89154e0a6e
Issue-ID: DOC-720
Signed-off-by: ramagp <ramakrishnagp@aarnanetworks.com>
Andrea Visnyei [Fri, 23 Apr 2021 10:42:55 +0000 (12:42 +0200)]
Move examples from Addendum to Setting Up chapter
Moved RST file examples and Jenkins info to Setting up chapter and RTD URLs to Introduction.
Issue-ID: DOC-719
Change-Id: I3e8ac614985858f2e3999a325e7575d66c8a7f84
Signed-off-by: Andrea Visnyei <andrea.visnyei@nokia.com>
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
Eric Debeau [Tue, 27 Apr 2021 11:50:11 +0000 (13:50 +0200)]
Correct default branch for conf.yaml
Default branch in conf.yaml is set to frankfurt
Fix to latest
Issue-ID: DOC-739
Signed-off-by: Eric Debeau <eric.debeau@orange.com>
Change-Id: Icd3faa6c841e57822f076c0535f1be7980edc4fa
Thomas Kulik [Mon, 26 Apr 2021 09:56:14 +0000 (11:56 +0200)]
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: I7ccc60b475e129cdfc0487ed8310df36b874c39d
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
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
Thomas Kulik [Thu, 22 Apr 2021 10:24:08 +0000 (10:24 +0000)]
Merge "Create composite note for Honolulu Release"
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
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
Andreas Geissler [Thu, 22 Apr 2021 07:19:31 +0000 (07:19 +0000)]
Merge "Update architecture description for Honolulu"
Thomas Kulik [Tue, 20 Apr 2021 13:58:03 +0000 (15:58 +0200)]
wiki lifecycle state corrected (oof/optf)
Issue-ID: DOC-735
Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>
Change-Id: I42cabd873128792684f9e5e7505f831f005121d7
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
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
Andreas Geissler [Tue, 13 Apr 2021 11:15:19 +0000 (11:15 +0000)]
Merge "[DOC] Installation guidelines for PaaS components"
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
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
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
Eric Debeau [Thu, 1 Apr 2021 13:47:02 +0000 (13:47 +0000)]
Merge "Update conf.py and Documentation Release Notes for Honolulu"
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
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
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
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
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>
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
Andreas Geissler [Fri, 26 Mar 2021 08:09:49 +0000 (08:09 +0000)]
Merge "Signed-off-by: Thomas Kulik <thomas.kulik@telekom.de>"
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"
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>
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
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"
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
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
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
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>
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"
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
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
Andreas Geissler [Mon, 22 Feb 2021 09:23:32 +0000 (09:23 +0000)]
Merge "[DOC] Resource Onboarding - licenses"
Andreas Geissler [Thu, 18 Feb 2021 16:01:30 +0000 (16:01 +0000)]
Merge "[DOC] Run autopep8 on conf.py"
Andreas Geissler [Thu, 18 Feb 2021 15:55:30 +0000 (15:55 +0000)]
Merge "[DOC] Add python linters for conf.py in tox.ini"
Andreas Geissler [Thu, 18 Feb 2021 15:51:34 +0000 (15:51 +0000)]
Merge "[DOC] Remove useless entries in requirements.txt"
Andreas Geissler [Thu, 18 Feb 2021 15:49:42 +0000 (15:49 +0000)]
Merge "[DOC] Improve words whitelist"
Andreas Geissler [Thu, 18 Feb 2021 15:49:17 +0000 (15:49 +0000)]
Merge "[DOC] Use words whitelist default filename"
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
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
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
Sofia Wallin [Tue, 16 Feb 2021 07:45:41 +0000 (07:45 +0000)]
Merge "Added composite release note for Guilin 7.0.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
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
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
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
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
Eric Debeau [Tue, 9 Feb 2021 13:23:41 +0000 (13:23 +0000)]
Merge "[DOC] Fix sphinx add_stylesheet deprecated method"
Eric Debeau [Tue, 9 Feb 2021 13:23:18 +0000 (13:23 +0000)]
Merge "[DOC] Fix tox docs-linkcheck profile issues"
Eric Debeau [Tue, 9 Feb 2021 13:22:26 +0000 (13:22 +0000)]
Merge "[DOC] Reactivate docs-linkcheck profile"
Eric Debeau [Tue, 9 Feb 2021 13:22:12 +0000 (13:22 +0000)]
Merge "[DOC] Enforce warnings at docs buildtime"
Eric Debeau [Tue, 9 Feb 2021 13:21:56 +0000 (13:21 +0000)]
Merge "[DOC] Remove tox.ini doppelganger"
Eric Debeau [Tue, 9 Feb 2021 13:21:40 +0000 (13:21 +0000)]
Merge "[DOC] Fix docs buildtime warnings"
Eric Debeau [Tue, 9 Feb 2021 13:21:26 +0000 (13:21 +0000)]
Merge "[DOC] Use sphinxcontrib-needs versions < 0.6.0"
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>
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>
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
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
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
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
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
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
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
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>
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
Code Review / doc.git / log