diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/oom_quickstart_guide_helm3.rst | 2 | ||||
| -rw-r--r-- | docs/oom_user_guide_helm3.rst | 2 | ||||
| -rw-r--r-- | docs/requirements-docs.txt | 2 | ||||
| -rw-r--r-- | docs/spelling_wordlist.txt | 451 | ||||
| -rw-r--r-- | docs/tox.ini | 22 |
5 files changed, 454 insertions, 25 deletions
diff --git a/docs/oom_quickstart_guide_helm3.rst b/docs/oom_quickstart_guide_helm3.rst index 5a3076426e..e4d4736fef 100644 --- a/docs/oom_quickstart_guide_helm3.rst +++ b/docs/oom_quickstart_guide_helm3.rst @@ -203,7 +203,7 @@ single command To deploy all ONAP applications use this command:: > cd oom/kubernetes - > helm deploy dev local/onap --namespace onap --set global.masterPassword=myAwesomePasswordThatINeedToChange -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900s + > helm deploy dev local/onap --namespace onap --create-namespace --set global.masterPassword=myAwesomePasswordThatINeedToChange -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900s All override files may be customized (or replaced by other overrides) as per needs. diff --git a/docs/oom_user_guide_helm3.rst b/docs/oom_user_guide_helm3.rst index 08e9ec0d0b..2c1eeabe71 100644 --- a/docs/oom_user_guide_helm3.rst +++ b/docs/oom_user_guide_helm3.rst @@ -149,7 +149,7 @@ Then build your local Helm repository:: The Helm search command reads through all of the repositories configured on the system, and looks for matches:: - > helm search -l + > helm search repo local NAME VERSION DESCRIPTION local/appc 2.0.0 Application Controller local/clamp 2.0.0 ONAP Clamp diff --git a/docs/requirements-docs.txt b/docs/requirements-docs.txt index e14c784ee4..1c1895acf6 100644 --- a/docs/requirements-docs.txt +++ b/docs/requirements-docs.txt @@ -6,7 +6,7 @@ setuptools six sphinx_rtd_theme>=0.4.3 sphinxcontrib-blockdiag -sphinxcontrib-needs>=0.2.3 +sphinxcontrib-needs<0.6.0 sphinxcontrib-nwdiag sphinxcontrib-redoc sphinxcontrib-seqdiag diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt new file mode 100644 index 0000000000..c860d4aa00 --- /dev/null +++ b/docs/spelling_wordlist.txt @@ -0,0 +1,451 @@ +AAF +AAI +adaptor +Adaptor +adaptors +Adaptors +Alcatel +Ansible +API +APIs +APPC +ASCII +Avro +BPMN +Camunda +Cask +Cassandra +CCSDK +CD +CDAP +Ceilometer +CentOS +CI +CLI +Cloudify +Codec +committer +committers +CommonMark +Contrail +CPU +CRM +CSCF +CSIT +cyber +DBaaS +DCAE +DevOps +DHCP +Django +DMaaP +DNS +DNSaaS +DPDK +Ebook +elasticsearch +Elasticsearch +Enablement +enum +Enum +env +Env +ENV +ethernet +Facebook +failover +fallback +Fcaps +Financials +geocoder +Gerrit +Github +graphSON +guestOS +gui +Hadoop +hardcoded +hashtag +healthcheck +healthCheck +Healthcheck +HealthCheck +healthchecks +heatbridge +heatclient +HeatStack +hostname +hostName +Hostname +hostnames +hostOS +htm +html +http +Http +httpclient +httpcomponents +httpdomain +httpHeader +httpPort +httpreturncode +https +httpStatusCode +Huawei +hyperlink +Hyperlink +hypervisor +Hypervisor +hypervisors +Hypervisors +IaaS +indices +Indices +inline +internet +interoperable +interoperate +Interoperate +interoperation +interwork +Interworking +IoT +ip +Ip +IP +ipAddress +iPAddress +IPAddress +ipam +Ipam +ipVersion +Jacoco +java +javalib +javascript +Javascript +jboss +JBoss +Jenkins +Jira +jpath +json +Json +jsonObject +jsonObjectInstance +jsonObjects +jsonschema +jtosca +junit +Junit +JUnit +Junits +JUnits +keypair +Keypair +keypairs +keyserver +keyservers +keyspace +Keyspace +keyspaceName +keyspaces +keystore +keytool +keyValue +Kibana +Kibibytes +Kubernetes +LF +lifecycle +Lifecycle +lifecycles +locator +logback +Logback +logfiles +Logfiles +logoffs +Logoffs +logon +Logstash +macAddress +MacAddress +macOS +Malware +metadata +Metadata +microservice +Microservice +microservices +Microservices +middleware +msb +MSB +multicast +multicloud +Multicloud +MultiCloud +multipart +Mysql +NaaS +nameserver +nameservers +namespace +Namespace +namespaced +namespaces +Namespaces +Netconf +nfv +NFV +nfvi +nfvo +nfvparser +Nokia +NSD +OAM +Ocata +ODL +Onap +ONAP +onboard +Onboard +onboarded +Onboarded +onboarding +Onboarding +online +OOF +OOM +OpenDaylight +openo +OpenO +Opensource +Openstack +OpenStack +OSS +Pandoc +partitionKey +Partitionkey +passphrase +PCRF +pdf +PGaaS +Phishing +PKI +placemark +Placemark +placemarks +plantUML +playbook +Playbook +playbooks +Playbooks +plugin +Plugin +plugins +Plugins +PNF +PoC +Postgre +Postgres +Postgresql +preload +Preload +proactively +programmatically +proxyhost +pserver +pServer +pservers +QoS +quickstart +Quickstart +Rackspace +readme +readthedocs +Readthedocs +Redhat +Redis +refactored +Refactored +registrator +Registrator +repo +Repo +repos +Restconf +reStructuredText +reusability +Reusability +RMM +roadmap +roadmaps +RPT +rst +RST +RVMI +schemas +screensaver +sdc +Sdc +SDC +sdk +SDK +SDN +sdnc +Sdnc +SDNC +Selenium +servlet +Servlet +Skynet +SLI +SMP +SNMP +SPI +SQL +stateful +subclassed +subclassing +subdomain +subflows +suboperation +suboperations +Suboperations +subtending +syslog +sysLog +Syslog +syslogs +Syslogs +tablename +taxonomical +TBD +Telco +telecom +Telecom +templated +templating +timeframe +timeslots +timestamp +Timestamp +transcoding +UDP +UI +uncheck +undeploy +Undeploy +undeployed +undeploying +Undeployment +uninstall +uninstallation +uninstalled +unitless +Unregistration +updatable +uploadable +url +Url +urls +usecase +Usecase +userid +username +Username +usernames +validator +Validator +vcpu +vcpus +vdns +versioned +Versioned +versioning +Versioning +vertices +Vertices +vf +vF +vfc +vFC +VFC +vfcadaptor +vfirewall +vFirewall +vfmodule +vfModule +VfModule +vfModules +vfstatus +vfStatus +virtualization +Virtualization +virtualize +virtualized +Virtualized +virtualizes +virtualizing +vlan +Vld +vm +Vm +VM +vms +VMs +VMware +vnf +vNF +Vnf +VNF +vnfapi +vnfc +VNFFG +vnfm +Vnfm +VNFM +VNFMs +vnfs +vNFs +vnfsdk +VPN +vrouter +vserver +vServer +Vserver +vservers +Vservers +vswitch +VVP +Vyatta +webapp +webapps +Webpage +webserver +WebServer +Websocket +Websockets +whitebox +whiteboxes +whitepaper +wiki +Wiki +Wikis +Wildfly +Windriver +Wireline +workflow +Workflow +workflows +www +xml +Xmx +Yaml +yamls +zabbix +Zachman +Zookeeper +ZTE diff --git a/docs/tox.ini b/docs/tox.ini deleted file mode 100644 index edac8c35fc..0000000000 --- a/docs/tox.ini +++ /dev/null @@ -1,22 +0,0 @@ -[tox] -minversion = 1.6 -envlist = docs, -skipsdist = true - -[testenv:docs] -basepython = python3 -deps = -r{toxinidir}/requirements-docs.txt -commands = - sphinx-build -b html -n -d {envtmpdir}/doctrees ./ {toxinidir}/_build/html - echo "Generated docs available in {toxinidir}/_build/html" -whitelist_externals = - echo - git - sh - -[testenv:docs-linkcheck] -basepython = python3 -#deps = -r{toxinidir}/requirements-docs.txt -commands = echo "Link Checking not enforced" -#commands = sphinx-build -b linkcheck -d {envtmpdir}/doctrees ./ {toxinidir}/_build/linkcheck -whitelist_externals = echo |