diff --git a/docs/configuration.md b/docs/configuration.md index 87eaedb..58bdf29 100644 --- a/docs/configuration.md +++ b/docs/configuration.md @@ -1196,7 +1196,7 @@ easily detect and use Moonraker instances. ### `[secrets]` -Retreives credentials and other information from a "secrets" file +Retrieves credentials and other information from a "secrets" file separate from `moonraker.conf`. This allows users to safely distribute their configuration and log files without revealing credentials and other sensitive information. diff --git a/docs/dev_changelog.md b/docs/dev_changelog.md index b4d56ed..cbd1a26 100644 --- a/docs/dev_changelog.md +++ b/docs/dev_changelog.md @@ -277,7 +277,7 @@ /printer/extras/endstops` to `GET /printer/endstops` - Serveral API changes have been made to accomodate the addition of webhooks: - `GET /printer/klippy_info` is now `GET /printer/info`. This endpoint no - longer returns host information, as that can be retreived direct via the + longer returns host information, as that can be retrieved direct via the `location` object in javascript. Instead it returns CPU information. - `GET /printer/objects` is no longer used to accomodate multiple request types by modifying the "Accept" headers. Each request has been broken diff --git a/docs/installation.md b/docs/installation.md index 0bb54f9..cf1ff2b 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -185,20 +185,20 @@ These options may be changed by editing `/etc/systemd/system/moonraker.service`. The `install-moonraker.sh` script may also be used to modify the config file location. -### Retreiving the API Key +### Retrieving the API Key Some clients may require an API Key to connect to Moonraker. After the `[authorization]` component is first configured Moonraker will automatically -generate an API Key. There are two ways in which the key may be retreived +generate an API Key. There are two ways in which the key may be retrieved by the user: -Retreive the API Key via the command line (SSH): +Retrieve the API Key via the command line (SSH): ``` cd ~/moonraker/scripts ./fetch-apikey.sh ``` -Retreive the API Key via the browser from a trusted client: +Retrieve the API Key via the browser from a trusted client: - Navigate to `http://{moonraker-host}/access/api_key`, where `{moonraker-host}` is the host name or ip address of the desired diff --git a/docs/printer_objects.md b/docs/printer_objects.md index 67239f2..5b00338 100644 --- a/docs/printer_objects.md +++ b/docs/printer_objects.md @@ -4,13 +4,13 @@ As mentioned in the API documentation, it is possible to [subscribe](web_api.md#subscribe-to-printer-object-status) to "Klipper Printer Objects." There are numerous printer objects in Klipper, many of which are optional and only report status if they are -enabled by Klipper's configuration. Client's may retreive a list of +enabled by Klipper's configuration. Client's may retrieve a list of available printer objects via the [list objects endpoint](web_api.md#list-available-printer-objects). This should be done after Klipper reports its state as "ready". This section will provide an overview of the most useful printer objects. -If a developer is interested in retreiving state for an object not listed here, +If a developer is interested in retrieving state for an object not listed here, look in Klipper's source code for module you wish to query. If the module contains a "get_status()" method, its return value will contain a dictionary that reports state which can be queried. diff --git a/docs/user_changes.md b/docs/user_changes.md index b9915d5..95fbc54 100644 --- a/docs/user_changes.md +++ b/docs/user_changes.md @@ -26,11 +26,11 @@ such as a configuration change or a reinstallation. if configured and disabled otherwise. - The API Key is now stored in the database. This deprecates the `api_key_file` option in the `[authorization]` module. Users can - no longer read the contents of the API Key file to retreive the + no longer read the contents of the API Key file to retrieve the API Key. Instead, users can run `scripts/fetch-apikey.sh` to print the API Key. Alternative a user can navigate to `http://{moonraker-host}/access/api_key` from a trusted client - to retreive the API Key. + to retrieve the API Key. ### March 10th 2021 - The `cors_domain` option in the `[authoriztion]` section is now diff --git a/docs/web_api.md b/docs/web_api.md index e48d91c..e4dd864 100644 --- a/docs/web_api.md +++ b/docs/web_api.md @@ -1509,7 +1509,7 @@ Returns: Information about the copied file or directory ``` #### File download -Retreives file `filename` at root `root`. The `filename` must include +Retrieves file `filename` at root `root`. The `filename` must include the relative path if it is not in the root folder. HTTP request: @@ -1963,7 +1963,7 @@ An object containing an array of namespaces in the following format: ``` #### Get Database Item -Retreives an item from a specified namespace. The `key` argument may be +Retrieves an item from a specified namespace. The `key` argument may be omitted, in which case an object representing the entire namespace will be returned in the `value` field. If the `key` is provided and does not exist in the database an error will be returned. @@ -2089,7 +2089,7 @@ contain multiple references to the same job. #### Retrieve the job queue status -Retreives the current state of the job queue +Retrieves the current state of the job queue HTTP request: ```http @@ -2396,7 +2396,7 @@ The following endpoints are available when the `[update_manager]` component has been configured: #### Get update status -Retreives the current state of each "package" available for update. Typically +Retrieves the current state of each "package" available for update. Typically this will consist of information regarding `moonraker`, `klipper`, `system` packages, along with configured clients. If moonraker has not yet received information from Klipper then its status will be omitted. One may request that @@ -3684,7 +3684,7 @@ process statistics: ``` As with the [proc_stats request](#get-moonraker-process-stats) the `cpu_temp` -field will be set to `null` if the host machine does not support retreiving CPU +field will be set to `null` if the host machine does not support retrieving CPU temperatures at `/sys/class/thermal/thermal_zone0`. #### History Changed