summaryrefslogtreecommitdiffstats
path: root/docs
AgeCommit message (Collapse)AuthorFilesLines
2020-08-02Issue-ID: OPTFRA-772 optimization in git clone using --depthPratik Raj1-1/+1
optimize the git clone using --depth flag in term of size of clone and also in term's of time taken to fetch the files and commit history of whole repository . Respective issue with Issue-ID: OPTFRA-772 is created at https://jira.onap.org/browse/OPTFRA-772 More detail can be found at blog https://www.atlassian.com/git/tutorials/big-repositories Signed-off-by: Pratik Raj <rajpratik71@gmail.com> Change-Id: I6a2f842886fea1e5626e528c93e90eb7e924f7a2
2020-08-01optimize size and time using "--no-cache-dir"Pratik Raj1-4/+4
Using "--no-cache-dir" flag in pip install ,make sure dowloaded packages by pip don't cached on system . This is a best practise which make sure to fetch ftom repo instead of using local cached one . Further , in case of Docker Containers , by restricing caching , we can reduce image size. In term of stats , it depends upon the number of python packages multiplied by their respective size . e.g for heavy packages with a lot of dependencies it reduce a lot by don't caching pip packages. Further , more detail information can be found at https://medium.com/sciforce/strategies-of-docker-images-optimization-2ca9cc5719b6 Issue-ID: OPTFRA-774 Signed-off-by: Pratik Raj <rajpratik71@gmail.com> Change-Id: I40d9eb94ecea623a9ed54b50b1786b154788a17b
2020-05-28Update css file name in conf.pylf-jobbuilder1-1/+1
ribbon.css is the correct name of the css file. Issue-ID: CIMAN-376 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: Ie31e5dc99dce2634692520fc4dd369b77fb1d88a
2020-05-26Update index.rstkrishnaa961-1/+1
Issue-ID: OPTFRA-669 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: Icca1689f440ae09890bbe65a3a9ee0601a787e45
2020-05-26Add upgrade strategykrishnaa961-0/+20
Issue-ID: OPTFRA-669 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: I1de2e5e94c0f9e0d58476c2a984e1baae5085fd1
2020-05-23Update release noteskrishnaa961-2/+23
Issue-ID: OPTFRA-761 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: If1b4cad448bb9d2457d3fa814ebfbee5c0687fd5
2020-05-23Add passthrough attribute to docskrishnaa961-4/+12
Issue-ID: OPTFRA-762 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: Ib47097f15ed558d4ff0b6f4b8da0edbc6c21a2ed
2020-05-22Add documentation related to slicingkrishnaa963-19/+156
Issue-ID: OPTFRA-759 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: I56d32a585c702b1a88e8f91e691ece44c7162d6b
2020-05-21Merge "remove date"Shankaranarayanan Puzhavakath Narayanan1-1/+0
2020-05-20Update documentationkrishnaa962-277/+500
Issue-ID: OPTFRA-566 Issue-ID: OPTFRA-495 Issue-ID: OPTFRA-543 Issue-ID: OPTFRA-409 Signed-off-by: krishnaa96 <krishna.moorthy6@wipro.com> Change-Id: If48ec9e054c1bb7e323e23de04930759beb5fcef
2020-05-19remove datedhebeha1-1/+0
Issue-ID: OPTFRA-563 Signed-off-by: dhebeha <dhebeha.mj71@wipro.com> Change-Id: I705a257add14cf899397580ccb7e799a206eded5
2020-04-08Automation adds optf-has-architecture.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: I2eccd0a285f11b6491f3247e8d430caed04809c7 Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-08Automation adds optf-has-offeredapis.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: Ie9c095cbb66e4d44735e5aa2e31b8bb9647f574e Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-07Automation adds index.rstLF Jenkins CI1-0/+1
Issue-ID: CIMAN-376 Change-Id: I4ff4bc11b5612237bdc81b5d83bb7fafabca006f Signed-off-by: lf-jobbuilder <releng+lf-jobbuilder@linuxfoundation.org>
2020-04-01Release notes structurevrvarma1-0/+76
Change-Id: If371acee4b4cb290dd397800a4ed569201684b16 Signed-off-by: vrvarma <vikas.varma@att.com> Issue-ID: OPTFRA-703 Signed-off-by: vrvarma <vikas.varma@att.com>
2020-02-10Migrate optf-has docsJessica Wagantall8-0/+125
Merging this will create https://onap-optf-has.readthedocs.io This build will run in parallel to the current docs generation method until we are ready to cut over. Issue-ID: CIMAN-364 Signed-off-by: Jessica Wagantall <jwagantall@linuxfoundation.org> Change-Id: I79e2815cc6ae4c2ae5f4d33f826c0347709b70a0
2019-10-05Use OJSI identifier to document fixed vulnerability5.0.2-ONAPelaltoKrzysztof Opasiak1-1/+2
It's better to stick to the convention that OJSI ticket should be mentioned in Fixed Security Issues section to ensure full traceability. Issue-ID: OJSI-137 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I3549e3853b5acd69df00500106ca35dc4002fe10
2019-10-02[OPTFRA-585] Update release notesShankar Narayanan1-0/+52
Change-Id: I7c284c816bfec1a06cbd995e161bd7a617d3e294 Signed-off-by: Shankar Narayanan <snarayanan@research.att.com> Issue-ID: OPTFRA-585
2019-06-05Document OJSI-137 vulnerabilityKrzysztof Opasiak1-0/+2
Issue-ID: OJSI-137 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I2b27d485e98d5e58f737fe19d4c4d95433dbea28
2019-06-05Improve security release notesKrzysztof Opasiak1-17/+23
In order to provide users with more details of project's state in terms of security let's divide the security release notes into three sections: - Fixed Security Issues Contains a list of security fixes merged during this release (especially those reported via OJSI tickets). - Known Security Issues Contains a list of vulnerabilities detected in project during release which have not been fixed yet and thus should be mitigated by the user. - Known Vulnerabilities in Used Modules Contains information about NexusIQ scan results Issue-ID: SECCOM-238 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com> Change-Id: I1b5a6c15b9397d3d6e192eabf2ba2a75ab54208d
2019-06-04Add release notes for Dublin release4.0.0-ONAPVarma, Vikas1-0/+63
Change-Id: Ia692b30ddfa11e82f80c502bc20eba55a41ff1a0 Signed-off-by: Varma, Vikas <vv8305@att.com> Issue-ID: OPTFRA-518
2019-02-06Update Casablanca maintenance release notesShankar Narayanan1-2/+20
Issue-ID: OPTFRA-401 Change-Id: I0bd03366e3833fa65a206ef7f2a98efb50b3fd8f Signed-off-by: Shankar Narayanan <snarayanan@research.att.com>
2018-11-30Merge "R3 RTD"Dileep Ranganathan11-906/+898
2018-11-29R3 RTDsandovalfr11-906/+898
Issue-ID: OPTFRA-262 Change-Id: Ida4d07f43167ed3f71b8d833b9bba237d3b19312 Signed-off-by: sandovalfrOAM <frank.sandoval@oamtechnologies.com>
2018-11-22Fix broken link to 5G RAN use caseKrzysztof Opasiak1-1/+1
Issue-ID: OPTFRA-402 Change-Id: If679e38cac8cea1e882f84ec4c09ece7168dff63 Signed-off-by: Krzysztof Opasiak <k.opasiak@samsung.com>
2018-09-19Merge "Update Homing Specification Guide for readthedocs"Shankaranarayanan Puzhavakath Narayanan1-11/+349
2018-09-20Update Homing Specification Guide for readthedocsRuoyu Ying1-11/+349
Update Homing Specification Guide to add 'directives' structure inside HPA constraints and add note for cloud agnostic constraints. Change-Id: I1268a0458e6c54a07382a386dbc683efe8772836 Issue-ID: OPTFRA-324 Signed-off-by: Ruoyu Ying <ruoyu.ying@intel.com>
2018-09-06add has swagger docFrank Sandoval2-465/+346
Issue-ID: OPTFRA-283 Change-Id: I078f3a4d89c248c0d3c306431065e27ec5422350 Signed-off-by: Frank Sandoval <frank.sandoval@oamtechnologies.com>
2018-05-30add security issuesfsandoval1-14/+14
Issue-ID: OPTFRA-242 Change-Id: I99441f4d41388f3a0e1837f5a8bd019e2ff2d260 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
2018-05-30update has docsfsandoval4-1/+976
Issue-ID: OPTFRA-242 Change-Id: I9d89ef313018c3a0c25c48a4e0cecabba75db2fd Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
2018-05-27consolidated docsfsandoval3-51/+598
Issue-ID: OPTFRA-242 Change-Id: I1440436559496cf688c66a13accdaeb0df0160c9 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
2018-05-26address comments OPTFRA-242 and edit release notesfsandoval4-71/+109
Issue-ID: OPTFRA-242 Change-Id: I41a089f8c22936eb66d75fa8a5acdf21fa173700 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
2018-05-01fixed typos in index.rstfsandoval1-2/+2
Issue-ID: OPTFRA-41 Change-Id: I688e23b1d98d20c90bc161066c8b5ed550df7f73 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com>
2018-05-01Beijing RC2 documentationfsandoval22-52/+242
Change-Id: Ic8b75e4cb33d6c4562cef2f2b9342974bfae03a3 Signed-off-by: fsandoval <frank.sandoval@oamtechnologies.com> Issue-ID: OPTFRA-41
2018-04-06Update the HAS specification guideDileep Ranganathan1-1/+419
Added HPA and VIM Fit constraints Change-Id: I0421e441331c8dedd5f6d6be72e027089425f154 Issue-ID: OPTFRA-194 Signed-off-by: Dileep Ranganathan <dileep.ranganathan@intel.com>
2018-03-12Add homing specification guideShankar Narayanan1-0/+1316
Add the homing specification guide in rst format. This should be in sync with doc/template/README.md Issue-ID: OPTFRA-174 Change-Id: I972aa837fe520ade884b8254216bcf5f306e2ff8 Signed-off-by: Shankar Narayanan <snarayanan@research.att.com>
2018-03-12Add homing specification guideShankar Narayanan2-1/+3
Add the homing specification guide in the rst format. Need to keep this in sync with doc/template/README.md. Issue-ID: OPTFRA-174 Change-Id: I8b16f21d9657838577a8dc5788b522d4577bf190 Signed-off-by: Shankar Narayanan <snarayanan@research.att.com>
2018-02-28Add API documentation for optf-hasShankar Narayanan2-0/+134
Add the API documentation exposed by HAS, used by OSDF in R2. Issue-ID: OPTFRA-155 Change-Id: I78fa78f26720ee4670fc62c250c2c4720aca2a77 Signed-off-by: Shankar Narayanan <snarayanan@research.att.com>
2017-09-18Updated headers to display correct pagesjsseidel2-3/+6
Updated headers so that when the release notes docs were referenced in main documentation, they would be displayed properly. Change-Id: I27bfebe3cc4ba28272a367a4696037cdc94707e5 Issue-Id: DOC-47 Signed-off-by: jsseidel <spence@research.att.com>
2017-09-14Added docs directory and release notes templatejsseidel9-0/+56
Added docs directory and a template for release notes. The template is simply a suggestion. Feel free to remove or add files as needed for whatever makes sense for your project. Change-Id: I2d52479ad210ca57b5a70c0756f90eea3f8e3432 Issue-Id: DOC-47 Signed-off-by: jsseidel <jsseidel@fastmail.com>