summaryrefslogtreecommitdiffstats
AgeCommit message (Collapse)AuthorFilesLines
2022-09-05Add upper-constraints needed by oomCédric Ollivier1-0/+4
See comment in https://gerrit.onap.org/r/c/oom/+/130716 Issue-ID: DOC-798 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I21a035b8c9d7503dc6e82606da3c5dc5a0ccc477
2022-09-01fix sphinx-build path in doc setup guidethmsdt2-11/+15
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I27ced61b4d0b0abeaa4284d50cc7fffe85abee6e
2022-08-31Force py3.8 in tox.iniCédric Ollivier3-24/+24
It allows leveraging on OpenStack Yoga's upper-contraints without any exception. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I82a7d949d2efd672f476d5a6ad47b33328fb2703
2022-08-30Bump lfdocs-confLukasz Rajewski1-1/+1
lfdocs 0.7.0 requires sphinxcontrib-needs<=0.5.6 while ONAP upper constraints require 0.7.9. Version 0.8.0 removes this strict dependency on sphinxcontrib-needs Issue-ID: DOC-799 Signed-off-by: Lukasz Rajewski <lukasz.rajewski@t-mobile.pl> Change-Id: Iff9a62ce07758e47504933c7f4f9b21eba131bf1
2022-08-29Revert downgrade sphinxcontrib-needsCédric Ollivier1-1/+1
We can now use the latest version as lfdocs-conf is now fixed [1]. [1] https://gerrit.linuxfoundation.org/infra/c/releng/docs-conf/+/70536 Issue-ID: DOC-782 Change-Id: Iaffaf0e8dd32a7b7ec994fb88f2c035097d0cca2 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com>
2022-08-25Temporarily downgrade sphinxcontrib-needsCédric Ollivier1-1/+1
As lfdocs-conf falsy forces 0.5.6 [1], we must temporarily downgrade the version till lfdocs-conf is fixed. [1] https://gerrit.linuxfoundation.org/infra/c/releng/docs-conf/+/70536 Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Ie4ddd50c49290bbbf4bd8fa8a9a4f5e5878db93b
2022-08-24remove submodules content from doc dev guidethmsdt1-1/+7
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I18434881e4840066d3ea4fdd9aab1faa8c7b68be
2022-08-24Merge "Upgrade upper-constraints"Thomas Kulik5-366/+423
2022-08-24Upgrade upper-constraintsCédric Ollivier5-366/+423
It completes the upgrade to Yoga's upper-contraints.txt Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Ic103ac24047160d6868ab165c488f6a6f73acb18
2022-08-23Merge "add missing content to doc dev setup guide"Andreas Geissler1-16/+34
2022-08-23add missing content to doc dev setup guidethmsdt1-16/+34
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id9fdc901dddaedce5d4ba2d408830dcfbcd267cb
2022-08-23Use official OpenStack Yoga upper constraintsCédric Ollivier10-197/+131
As they remove sphinx from the list, we can switch to the official files. etc/upper-constraints.os.txt will be removed once all ONAP part of doc's conf.py are updated. It also fixes master's and releases's tox.ini and modifies conf.py to make spellcheck work. It syncs release/_static/css/ribbon.css which was obsolete. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I22757e2d6750e88ac7e83a0636fc0755976a2cbd
2022-08-22fix example ribbbon.css for masterthmsdt1-1/+1
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I06a6ab0a770c69397bc72595e819ca3ac274c4b5
2022-08-16update sphinx example config filesthmsdt10-69/+69
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I74a213993ada2b3697b58270c30c61326b151f7b
2022-08-15improve navigation and readabilitythmsdt36-191/+165
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ib4f8246d548a77885c5f6c5457ce2c3b20e275b6
2022-08-11remove obsolete notethmsdt1-3/+0
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I59db7cfa97f95437eb80d30fce403a847f99e0b2
2022-08-10Merge "limit text width in RTD to improve readability"Andreas Geissler1-1/+1
2022-08-10Merge "fix missing copyright in RTD footer"Andreas Geissler3-6/+6
2022-08-10limit text width in RTD to improve readabilitythmsdt1-1/+1
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id897eff49ce745bf422f4c205c1e1f712a3cac8c
2022-08-10fix missing copyright in RTD footerthmsdt3-6/+6
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I972d59a9a190690ecaf7fe240a6e05291efa7335
2022-08-10fix toc issue (navigation)thmsdt1-22/+22
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2cd9a2aeb48d32bb641cf417c2d478be3d490c06
2022-08-10improve doc navigation (project specific release notes)thmsdt3-45/+37
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Iad0b8cd373aaa70dc4ad56c6416fbeae4fb8ccc0
2022-08-04update and rearrange documentation related contentthmsdt35-462/+397
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Id454ec5f09903efb81123669e6eb024f21a08797
2022-07-28remove lfdocs from doc setup guidethmsdt1-7/+3
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I54878c50d0c1e0d0af7ed10806b6106f9c9ca398
2022-07-19correct Jakarta release datethmsdt2-22/+24
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I285cdfdef346ccea215a88036c069e3ae73093e3
2022-07-18update sphinx example configuratonthmsdt9-63/+199
Issue-ID: DOC-798 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie3032dbaf531e2de1ee144a946a3e4f51fc04f9a
2022-07-07format conf.py; fix link in setup guide; fix releasereposthmsdt3-3/+8
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I12ee49b841065a930b68f68e596f4778ba50c93f
2022-07-06Remove lf docs confCédric Ollivier3-12/+25
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I05be46029920367a2792c32da380dd19cdba06e3
2022-07-05Revert "add security related docs (osa)"Thomas Kulik3-6/+2
This reverts commit 6458ba752df13912f3497576949f85192a9ca8b5. Reason for revert: <build problems> Issue-ID: DOC-782 Change-Id: Ie07ea0d4b0d3bf1cb5d378d9b3b248e5d580fe5e Signed-off-by: thmsdt <thomas.kulik@telekom.de>
2022-07-05Fix all incorrect anchors detected by linkcheckCédric Ollivier6-23/+7
It leverages the doc directive which suits this cases. There is no longer link ignored by linkcheck. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I416e378f28789504eee5b44778c8c8edc1e7723f
2022-07-05Fix LFN EasyCLA dead linksCédric Ollivier1-4/+2
It replaces the EasyCLA links used in ONAP doc which were removed. Backports must be considered as linkcheck ignore has hidden this issues for a while. Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: Iaff4da0e555bfaaadc5d97ef1bad0024af8f6415
2022-06-27add security related docs (osa)thmsdt3-0/+9
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I8e4f6692c6249e16a1862ec533620c1a43a579d6
2022-06-27add missing sections to conf.pythmsdt3-2/+14
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I2fdc0ae919f8a14d650f2cd9a745dcdf805e5d6a
2022-06-02Add Jakarta Release NoteEric Debeau1-120/+142
Jakarta Release Note based on Key Updates Issue-ID: DOC-796 Signed-off-by: Eric Debeau <eric.debeau@orange.com> Change-Id: I86d06a9528f7d0aab420cfab9bd9429b9df7ed6b
2022-05-31remove repos without j branch from docsthmsdt10-96/+5
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie41998cefa08327be5eb3cedc659e69afb84bfbe
2022-05-19Merge "[DOC] Add instruction for ssh key generation"Eric Debeau1-3/+19
2022-05-18[DOC] Add instruction for ssh key generationqingshuting1-3/+19
OpenSSH 8.8+ disables the support for RSA/SHA1. For developers in this scenario uses "ssh-keygen -t rsa" command, the ssh key can be generated successfully. But it will come back" Permission Denied (Public Key)" when they try to pull/push code through ssh method. Few solutions in google will tell it could be the OpenSSH reason which may cause some time for trouble shooting. So instruction is added here. Change-Id: Iaababa9e25e87604b1bc6464f65156ec6e6b2d31 Signed-off-by: qingshuting <qingshuting1@huawei.com> Issue-ID: DOC-790
2022-05-12Add OOF HAS release notes to Project RN pageAndreas Geissler1-0/+1
Issue-ID: DOC-782 Signed-off-by: Andreas Geissler <andreas-geissler@telekom.de> Change-Id: I1f1e5b322049f39b74ea80f17efe06ec4987b8e8
2022-05-03provide also project specific release notes in navigationthmsdt2-5/+12
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I8d920b2b46ee57c9b8cdb0f1a25491a856b5b9df
2022-05-02remove unmaintained repos from jakarta docsthmsdt7-90/+9
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ice20b360b2a438ee74a60d51d73292e8714b2531
2022-05-02update project specific release notes page for jakartathmsdt1-31/+111
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I0006ec04987e23c57e4d96719d64d6dd04c463af
2022-04-14Merge "Garbage the doc history"Thomas Kulik1-1/+0
2022-04-14Garbage the doc historyCédric Ollivier1-1/+0
Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I6cbbbf2d2e76f8d5b7960c137be428224f0a7378
2022-04-13fix jakarta release notesthmsdt1-4/+4
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: If9f9c7eede7fe85d1be028d3cf4ca0fe9e4172a7
2022-04-12update doc release notesthmsdt2-23/+17
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I3ddc44770346c9c735c87bf4227899b204455893
2022-03-31update guide to create a doc development system (link collection, warning)thmsdt1-3/+10
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I792476b9b9fa292f719f56ec551c6189bfcfbfd2
2022-03-30update architecture overview svg (dcae analytics)thmsdt4-1329/+1499
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: I69f7bcb0edcf9ee01ff918a125233166f78c4aef
2022-03-28update both example requirements-docs.txtthmsdt2-0/+10
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ibc96a61baa22cc4b99a17097a8e97d85d14ad777
2022-03-21Add bounds to sphinx requirementCédric Ollivier1-0/+2
As ONAP was created before Oct 20 2020 in RTD, we must set bounds to enforce a compatible Sphinx version (see manual). Issue-ID: DOC-782 Signed-off-by: Cédric Ollivier <cedric.ollivier@orange.com> Change-Id: I481348ed97433c6cccc029890ff17d4b46b08254
2022-03-17updates for architecture diagram and descriptionthmsdt3-2120/+1878
Issue-ID: DOC-782 Signed-off-by: thmsdt <thomas.kulik@telekom.de> Change-Id: Ie3c1ce4e7ae4cdf355c1105b146dcc5a1bdd720c