From 5b17d1b2caaba580496c989b7a06a4131c1eb00c Mon Sep 17 00:00:00 2001 From: Zaid Abdulla Date: Tue, 23 Feb 2021 13:12:56 -0800 Subject: [PATCH] Shell script to spell check docs --- CHANGELOG.md | 2 +- build/spellcheck-dict.pws | 163 +++++++++++++++++++++++++++++++++ build/spellcheck.sh | 12 +++ docs/api-reference.rst | 10 +- docs/cpe-authentication.rst | 2 +- docs/environment-variables.rst | 4 +- docs/ext-sample.js | 2 +- docs/installation-guide.rst | 2 +- 8 files changed, 186 insertions(+), 11 deletions(-) create mode 100644 build/spellcheck-dict.pws create mode 100755 build/spellcheck.sh diff --git a/CHANGELOG.md b/CHANGELOG.md index ef0cd7f..cc191c4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -86,7 +86,7 @@ as to not require service restart for changes to take effect. - Optional redis dependency has been removed completely. - Tags now allow only alphanumeric characters and underscore. -- Supported versions of NodeJs and MongoDB are 10.x and up and 2.6 and up +- Supported versions of Node.js and MongoDB are 10.x and up and 2.6 and up respectively. ## 1.1.3 (2018-10-23) diff --git a/build/spellcheck-dict.pws b/build/spellcheck-dict.pws new file mode 100644 index 0000000..e9b306b --- /dev/null +++ b/build/spellcheck-dict.pws @@ -0,0 +1,163 @@ +personal_ws-1.1 en 0 +genieacs +GenieACS +javascript +sudo +config +cwmp +CPE +systemctl +nbi +CWMP +NBI +ACS +SSL +xsd +args +DeviceID +GENIEACS +env +param +arg +AUTH +igd +TCP +toctree +auth +EnvironmentFile +JSON +json +parameterValues +setParameterValues +stderr +stdout +attr +cfg +CPEs +ExecStart +faq +FileType +GenieACS's +JWT +maxdepth +npm +objectName +refreshObject +SerialNumber +systemd +usr +WantedBy +yaml +chown +Config +getParameterValues +https +InternetGatewayDevice +mkdir +OUI +sql +TODO +UDP +addObject +AGPLv +const +cpe +cron +deleteObject +FactoryReset +factoryReset +FileName +fileType +Github +hostname +HTTPS +jwt +latlong +NPM +oui +parameterNames +ProductClass +productClass +repo +SSID +sublicense +TLS +WANIPConnection +WPA +YourProvisionName +abc +Abdulla +accessors +AddObject +AddressingType +api +APIs +chmod +cwmp's +dateext +DATETIME +dateTime +datetime +declaratively +delaycompress +DeleteObject +deviceId +DHCP +dir +distro +equisatisfiable +ExternalIPAddress +failover +favor +func +GetParameterAttributes +getPassword +gte +gui +hexBinary +Hils +HOSTNAME +init +journalctl +journald +LastFileName +LastFileType +lastInform +LIBXMLJS +libxmljs +literalinclude +lockfile +logrotate +lte +mipsbe +normalizers +pre +quickstart +README +redis +reimplemented +RequestDownload +RESTful +rollout +sandboxed +scalable +SetParameterAttributes +SetParamteerValues +SIGINT +SIGTERM +skipWritableCheck +stringify +subdirectory +TargetFileName +useradd +VirtualParameters +vparam +xml +YAML +Zaid +cacheExpire +iss +http +statusCode +rawData +pos diff --git a/build/spellcheck.sh b/build/spellcheck.sh new file mode 100755 index 0000000..a4d5bf1 --- /dev/null +++ b/build/spellcheck.sh @@ -0,0 +1,12 @@ +#! /bin/sh + +cd "$(dirname "$0")" + +FILES=`ls ../docs/*.rst ../docs/*.js ../*.md` + +for FILE in $FILES +do + echo $FILE + cat $FILE | aspell list --lang=en --add-extra-dicts=./spellcheck-dict.pws --ignore 2 + echo +done diff --git a/docs/api-reference.rst b/docs/api-reference.rst index 6acbebb..01a68bf 100644 --- a/docs/api-reference.rst +++ b/docs/api-reference.rst @@ -1,7 +1,7 @@ API Reference ============= -GenieACS expoeses a rich RESTful API through its NBI component. This document +GenieACS exposes a rich RESTful API through its NBI component. This document serves as a reference for the available APIs. This API makes use of MongoDB's query language in some of its endpoints. Refer @@ -16,7 +16,7 @@ to MongoDB's documentation for details. .. warning:: - A common pitfll is not properly percent-encoding special characters in the + A common pitfall is not properly percent-encoding special characters in the device ID or query in the URL. Endpoints @@ -106,7 +106,7 @@ if the tasks have been queued to be executed at the next inform. *device_id*: The ID of the device. *connection_request*: Indicates that a connection request will be triggered to -execute the tasks immediatly. Otherwise, the tasks will be queued and be +execute the tasks immediately. Otherwise, the tasks will be queued and be processed at the next inform. The response body is the task object as it is inserted in the database. The @@ -299,7 +299,7 @@ The following file metadata may be sent as request headers: - ``fileType``: For firmware images it should be "1 Firmware Upgrade Image". Other common types are "2 Web Content" and "3 Vendor Configuration File". -- ``oui``: The OUI of the device model that this file belogs to. +- ``oui``: The OUI of the device model that this file belongs to. - ``productClass``: The product class of the device. @@ -344,7 +344,7 @@ Find files using a query. Tasks ----- -Find the different availabe tasks and their object structure. +Find the different available tasks and their object structure. ``getParameterValues`` ~~~~~~~~~~~~~~~~~~~~~~ diff --git a/docs/cpe-authentication.rst b/docs/cpe-authentication.rst index be32dfd..19c12a1 100644 --- a/docs/cpe-authentication.rst +++ b/docs/cpe-authentication.rst @@ -11,7 +11,7 @@ CPE to ACS By default GenieACS will accept any incoming connection via HTTP/HTTPS and respond to it. -The following paramters are used to set and get (password is redacted but +The following parameters are used to set and get (password is redacted but can be set) the username/password used to authenticate against the ACS: Username: ``Device.ManagementServer.Username`` or ``InternetGatewayDevice.ManagementServer.Username`` diff --git a/docs/environment-variables.rst b/docs/environment-variables.rst index 4c606e7..70cbec3 100644 --- a/docs/environment-variables.rst +++ b/docs/environment-variables.rst @@ -86,7 +86,7 @@ CWMP_ACCESS_LOG_FILE File to log incoming requests for genieacs-cwmp. If omitted, logs will go to stdout. - Default: unest + Default: unset NBI_WORKER_PROCESSES The number of worker processes to spawn for genieacs-nbi. A value of 0 means @@ -107,7 +107,7 @@ NBI_INTERFACE NBI_SSL_CERT Path to certificate file. If omitted, non-secure HTTP will be used. - Default: unest + Default: unset NBI_SSL_KEY Path to certificate key file. If omitted, non-secure HTTP will be used. diff --git a/docs/ext-sample.js b/docs/ext-sample.js index a4b0885..43dedb1 100644 --- a/docs/ext-sample.js +++ b/docs/ext-sample.js @@ -1,4 +1,4 @@ -// This is an exmaple GenieACS extension to get the current latitude/longitude +// This is an example GenieACS extension to get the current latitude/longitude // of the International Space Station. Why, you ask? Because why not. // To install, copy this file to config/ext/iss.js. diff --git a/docs/installation-guide.rst b/docs/installation-guide.rst index 88fe67b..5700d33 100644 --- a/docs/installation-guide.rst +++ b/docs/installation-guide.rst @@ -4,7 +4,7 @@ Installation Guide This guide is for installing GenieACS on a single server on any Linux distro that uses *systemd* as its init system. -The various GenieACS services are independant of each other and may be +The various GenieACS services are independent of each other and may be installed on different servers. You may also run multiple instances of each in a load-balancing/failover setup.