diff options
| -rw-r--r-- | docs/conf.py | 15 | ||||
| -rw-r--r-- | docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt | 10 | ||||
| -rwxr-xr-x | tools/checkdocs.sh | 106 |
3 files changed, 106 insertions, 25 deletions
diff --git a/docs/conf.py b/docs/conf.py index 01509ca16..75871c491 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -14,9 +14,10 @@ intersphinx_mapping = {} # branch for the 'doc' project. # -# Latest | <Name_of_the_new_ONAP_Release> +# Istanbul intersphinx_mapping['onap-aai-aai-common'] = ('{}/onap-aai-aai-common/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-aai-sparky-be'] = ('{}/onap-aai-sparky-be/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-cds'] = ('{}/onap-ccsdk-cds/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-features'] = ('{}/onap-ccsdk-features/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-distribution'] = ('{}/onap-ccsdk-distribution/en/%s'.format(doc_url) % branch, None) @@ -30,7 +31,6 @@ intersphinx_mapping['onap-dmaap-messagerouter-messageservice'] = ( '{}/onap-dmaap-messagerouter-messageservice/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-buscontroller'] = ('{}/onap-dmaap-buscontroller/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-dmaap-datarouter'] = ('{}/onap-dmaap-datarouter/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-holmes-engine-management'] = ( '{}/onap-holmes-engine-management/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-holmes-rule-management'] = ( @@ -39,7 +39,9 @@ intersphinx_mapping['onap-integration'] = ('{}/onap-integration/en/%s'.format(do intersphinx_mapping['onap-modeling-etsicatalog'] = ('{}/onap-modeling-etsicatalog/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-modeling-modelspec'] = ('{}/onap-modeling-modelspec/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-multicloud-framework'] = ('{}/onap-multicloud-framework/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-apigateway'] = ('{}/onap-msb-apigateway/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom'] = ('{}/onap-oom/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom-offline-installer'] = ('{}/onap-oom-offline-installer/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oom-platform-cert-service'] = ( @@ -58,7 +60,7 @@ intersphinx_mapping['onap-vnfrqts-guidelines'] = ('{}/onap-vnfrqts-guidelines/en intersphinx_mapping['onap-vnfrqts-requirements'] = ('{}/onap-vnfrqts-requirements/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-testcases'] = ('{}/onap-vnfrqts-testcases/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vnfrqts-usecases'] = ('{}/onap-vnfrqts-usecases/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) +# enable later and remove duplicated entry at 'honolulu' # intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/%s'.format(doc_url) % branch, None) # @@ -69,8 +71,10 @@ intersphinx_mapping['onap-vvp-documentation'] = ('{}/onap-vvp-documentation/en/% # Honolulu branch = 'honolulu' -intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-dmaap-dbcapi'] = ('{}/onap-dmaap-dbcapi/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-externalapi-nbi'] = ('{}/onap-externalapi-nbi/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vid'] = ('{}/onap-vid/en/%s'.format(doc_url) % branch, None) +intersphinx_mapping['onap-vnfsdk-model'] = ('{}/onap-vnfsdk-model/en/%s'.format(doc_url) % branch, None) # Guilin branch = 'guilin' @@ -94,7 +98,6 @@ intersphinx_mapping['onap-aaf-sms'] = ('{}/onap-aaf-sms/en/%s'.format(doc_url) % intersphinx_mapping['onap-aai-event-client'] = ('{}/onap-aai-event-client/en/%s'.format(doc_url) % branch, None) #intersphinx_mapping['onap-aai-esr-gui'] = ('{}/onap-aai-esr-gui/en/%s'.format(doc_url) % branch, None) #intersphinx_mapping['onap-aai-esr-server'] = ('{}/onap-aai-esr-server/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-ccsdk-apps'] = ('{}/onap-ccsdk-apps/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-dashboard'] = ('{}/onap-ccsdk-dashboard/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-ccsdk-platform-plugins'] = ( '{}/onap-ccsdk-platform-plugins/en/%s'.format(doc_url) % branch, None) @@ -105,9 +108,7 @@ intersphinx_mapping['onap-modeling-toscaparsers'] = ( '{}/onap-modeling-toscaparsers/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-discovery'] = ('{}/onap-msb-discovery/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-msb-java-sdk'] = ('{}/onap-msb-java-sdk/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-msb-swagger-sdk'] = ('{}/onap-msb-swagger-sdk/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-multicloud-azure'] = ('{}/onap-multicloud-azure/en/%s'.format(doc_url) % branch, None) -intersphinx_mapping['onap-multicloud-k8s'] = ('{}/onap-multicloud-k8s/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-music-distributed-kv-store'] = ( '{}/onap-music-distributed-kv-store/en/%s'.format(doc_url) % branch, None) intersphinx_mapping['onap-oparent-cia'] = ('{}/onap-oparent-cia/en/%s'.format(doc_url) % branch, None) diff --git a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt index a64c658f1..a6df71bde 100644 --- a/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt +++ b/docs/guides/onap-developer/architecture/media/onap-architecture-overview-notes.txt @@ -1,6 +1,6 @@ ONAP ARCHITECTURE OVERVIEW NOTES -Version 1.0, 2021-08-10 +Version 1.1, 2021-11-10 This file contains information about how the map and its interactive functions were realized and how it can be maintained. @@ -25,11 +25,9 @@ Open the "Objects" window (Objects - Objects) and use it as your central point t Open the "Objects Properties" window (Objects - Objects Properties) to see and change properties of the object. -Naming conventions (example for r9 istanbul release): -onap-architecture-overview-r9-latest-interactive.svg (editable version for 'master' branch; release info hidden on map) -onap-architecture-overview-r9-latest-interactive-path.svg ('pathed' version for 'master' branch; release info hidden on map; referenced in r9 'latest' documentation files) -onap-architecture-overview-r9-istanbul-interactive.svg (editable version for 'istanbul' release'; release info visible on map) -onap-architecture-overview-r9-istanbul-interactive-path.svg ('pathed' version for 'istanbul' release'; release info visible on map; referenced in r9 'istanbul' documentation files) +Naming conventions: +onap-architecture-overview-interactive.svg (editable version) +onap-architecture-overview-interactive-path.svg (all text converted to pathes; to be used in rst documentation files) Text to Path: To avoid display problems caused of missing fonts you should release the map only when all characters are rendered as pathes. To do so, open the "master file" of this map and save it with a new name (please note the naming conventions). Then select all elemets (STRG-A) and choose "Path - Objects to Path" and save it again using the new name. All character are now converted to pathes - and are not editable via the text edit tool anymore! But the map is expected to be rendered on every target system in the same way. Path conversion can not be undone - so store the "master file" carefully. Unfortunately the label-text in the map can not be searched anymore. diff --git a/tools/checkdocs.sh b/tools/checkdocs.sh index 91745bd49..641553fb8 100755 --- a/tools/checkdocs.sh +++ b/tools/checkdocs.sh @@ -23,7 +23,7 @@ ### ### DESCRIPTION: ### Retrieves a full list of ONAP repos from gerrit inluding their state. -### Clones all active repos of the ONAP master branch plus other requested ONAP +### Clones all repos of the ONAP master branch plus other requested ONAP ### branches. Then the script does some docs related analyses depending on the ### clone results. It creates logfiles containing filtered results. In addition ### a table.csv is created which can be used to import it in a spreadsheed. @@ -58,7 +58,7 @@ ### SHORT: curl -s 'https://gerrit.onap.org/r/projects/?d' | awk '{if(NR>1)print}' | jq -c '.[] | {id, state}' | sed -r 's:%2F:/:g; s:["{}]::g; s:id\:::; s:,state\::|:; /All-Projects/d; /All-Users/d' ### -script_version="1.11 (2021-10-18)" +script_version="1.12 (2021-11-12)" # save command for the restart with logging enabled command=$0 @@ -219,6 +219,57 @@ function getrpinfo { return_from_getrpinfo="" } +function find_repo_in_confpy { + + local search_term=$1 + local search_term_line_number="" + local confpy_branch_entries="" + local confpy_line_number="" + local confpy_branch_name="" + local idx="" + + return_from_find_repo_in_confpy="" + search_term="'${search_term}'" + + search_term_line_number=$(cat ./doc/docs/conf.py | grep -n '^intersphinx_mapping\[' | grep -m 1 ${search_term} | sed 's/:.*//') + #echo "DBUG: search_term is ............... ${search_term}" + #echo "DBUG: search_term_line_number is ... ${search_term_line_number}" + + # nothing (or multiple entries) found - return + if [[ ${search_term_line_number} == "" ]]; then + #echo "DBUG: search_term_line_number is empty - returning" + return_from_find_repo_in_confpy="" + return 0; + fi + + readarray -t confpy_branch_entries <<< "$(cat ./doc/docs/conf.py | grep -n '^branch = ' | sed 's/branch = //' | sed s/\'//g)" + + #echo "DBUG: confpy_branch_entries" + #printf -- "%s\n" "${confpy_branch_entries[@]}" + #for confpy_branch_entry in ${confpy_branch_entries[@]} + #do + # confpy_line_number=$(echo $confpy_branch_entry | awk -F ":" '{print $1}'); + # confpy_branch_name=$(echo $confpy_branch_entry | awk -F ":" '{print $2}'); + # echo "DBUG: ${confpy_branch_name} entries are below line ${confpy_line_number}" + #done + + # search in the list of branches in reverse order + for (( idx=${#confpy_branch_entries[@]}-1 ; idx>=0 ; idx-- )) + do + #echo "DBUG: working entry is ${confpy_branch_entries[idx]}" + confpy_line_number=$(echo ${confpy_branch_entries[idx]} | awk -F ":" '{print $1}'); + confpy_branch_name=$(echo ${confpy_branch_entries[idx]} | awk -F ":" '{print $2}'); + #echo "DBUG: ${confpy_branch_name} entries are below line ${confpy_line_number}" + + if (( ${search_term_line_number} > ${confpy_line_number} )); then + #echo "DBUG: search_term_line_number is greater than confpy_line_number" + #echo "DBUG: ${search_term} found in ${confpy_branch_name} section" + return_from_find_repo_in_confpy=${confpy_branch_name} + return 0; + fi + done +} + ### ### arguments handling ### @@ -676,10 +727,41 @@ do unset lcstatesmatch # - # csv column #9: RELEASE component (yes|maybe|unknown) + # csv column #9: intersphinx + # intersphinx mappings in conf.py + # provided is the branch used for linking the repository + # + + readarray -t array < ./${repolist}; + i=0 + csv[i]="${csv[i]},intersphinx" + ((i++)) + for line in "${array[@]}" + do + reponame=$(echo $line | awk -F "|" '{print $1}'); + project=$(echo $reponame | sed 's:/.*$::') + #echo "DBUG: reponame=${reponame}" + #echo "DBUG: project=${project}" + #echo "DBUG: i=${i}" + reponame=$(echo ${reponame} | sed -r 's/\//-/g') + search_repo="onap-${reponame}" + #echo "DBUG: search_repo=${search_repo}" + find_repo_in_confpy ${search_repo} + csv[i]="${csv[i]},${return_from_find_repo_in_confpy}" + ((i++)) + done + unset array + unset i + unset reponame + unset project + unset return_from_find_repo_in_confpy + + # + # csv column #10: RELEASE component (yes|maybe|unknown) # to be filled with values of the planned release config file maintained by # the onap release manager # NOT FUNCTIONAL YET + # # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg readarray -t array < ./${branch}_repoclone.log; @@ -723,7 +805,7 @@ do unset releasecomponent # - # csv column #10: RELEASE partizipation + # csv column #11: RELEASE partizipation # # repoclone.log format: $1=gitexitcode|$2=reponame|$3=repostate|$4=errormsg @@ -764,11 +846,11 @@ do unset return_from_getrpinfo # - # csv column #11: docs (at repo root directory only; no recursive search!) - # csv column #12: conf.py - # csv column #13: tox.ini - # csv column #14: index.rst - # csv column #15: first title in index.rst + # csv column #12: docs (at repo root directory only; no recursive search!) + # csv column #13: conf.py + # csv column #14: tox.ini + # csv column #15: index.rst + # csv column #16: first title in index.rst # # columns are filled with values from requested branch. # if data is not available values from master branch are used. @@ -853,8 +935,8 @@ do unset docs # - # csv column #16: index.html@RTD accessibility check - # csv column #17: index.html url + # csv column #17: index.html@RTD accessibility check + # csv column #18: index.html url # readarray -t array < ./${branch}_repoclone.log; @@ -967,7 +1049,7 @@ do done # - # csv column #18: release notes + # csv column #19: release notes # readarray -t array < ../${repolist}; |