diff --git a/README.md b/README.md index 74c1b1c4c8..27b7a53736 100644 --- a/README.md +++ b/README.md @@ -44,7 +44,7 @@ DKAN and related modules are freely-available under the ["GNU General Public Lic ## Security -If you have found a vunerability in DKAN, please report this by e-mailing dkan-security@civicactions.com. +If you have found a vulnerability in DKAN, please report this by e-mailing dkan-security@civicactions.com. --- diff --git a/docs/source/contributing/documentation.rst b/docs/source/contributing/documentation.rst index 7be34ae2ad..fb649259a5 100644 --- a/docs/source/contributing/documentation.rst +++ b/docs/source/contributing/documentation.rst @@ -2,8 +2,8 @@ Contributing to DKAN documentation ================================== What follows is a style guide for the DKAN documentation. Use it both to follow the conventions used throughout the site, -and for your own contributions. DKAN's documentaion is written in a combination of `Markdown `_ -and `ReStructuredText (RST) `_, and built with `Sphynx `_. +and for your own contributions. DKAN's documentation is written in a combination of `Markdown `_ +and `ReStructuredText (RST) `_, and built with `Sphinx `_. The docs live in the `/docs/source` folder of the `DKAN Project `_; to suggest modifications, submit a pull request as you would for any suggested code change. diff --git a/docs/source/drush_commands.rst b/docs/source/drush_commands.rst index 0726dda420..bf5f9f66ea 100644 --- a/docs/source/drush_commands.rst +++ b/docs/source/drush_commands.rst @@ -198,7 +198,7 @@ dkan:harvest:register dkan:harvest:revert -------------------- - Revert a harvest. Removes harvested entities and unpublishes orhpaned + Revert a harvest. Removes harvested entities and unpublishes orphaned keywords, themes, and distributions. The harvest plan will remain and can be run again to generate the datasets after any issues have been resolved. diff --git a/docs/source/installation/index.rst b/docs/source/installation/index.rst index 3921ef1687..e5d163ed50 100644 --- a/docs/source/installation/index.rst +++ b/docs/source/installation/index.rst @@ -18,7 +18,7 @@ This will ensure you have the same setup as DKAN's core developers, and that you Requirements ------------ -DKAN is based on `Drupal software `_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend: +DKAN is based on `Drupal software `_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we recommend: - Drupal 10+ - MySQL: minimum version 5.7.8+ with PDO diff --git a/docs/source/introduction/glossary.rst b/docs/source/introduction/glossary.rst index 3ed5acef52..f4066258c3 100644 --- a/docs/source/introduction/glossary.rst +++ b/docs/source/introduction/glossary.rst @@ -17,7 +17,7 @@ Glossary This refers to the actual data, usually provided as a file (csv, xls, xlsx, dat, zip, tar, pdf, etc.) but may also be a URL that provides access to the data. CSV is one of the most widely used data file formats and can be opened and edited by almost any simple text editor as well as Microsoft Excel, Apple Numbers, or Google Spreadsheets. Dataset - A dataset is an identifiable collection of structured data objects unified by some criteria (authorship, subject, scope, spatial or temporal extent…) this unifiying criteria is called metadata. In DKAN, the term **dataset** refers to the metadata plus the data resource(s). A dataset can have multiple data resources and these are listed under the metadata property called **distribution**. + A dataset is an identifiable collection of structured data objects unified by some criteria (authorship, subject, scope, spatial or temporal extent…) this unifying criteria is called metadata. In DKAN, the term **dataset** refers to the metadata plus the data resource(s). A dataset can have multiple data resources and these are listed under the metadata property called **distribution**. Datastore A datastore is the data resource stored in a database. DKAN will import data from a UTF-8 encoded csv file into a database table and provide an API endpoint from which other applications can run queries on that data. diff --git a/docs/source/user-guide/guide_data_dictionaries.rst b/docs/source/user-guide/guide_data_dictionaries.rst index a2f96903f9..975fe6a018 100644 --- a/docs/source/user-guide/guide_data_dictionaries.rst +++ b/docs/source/user-guide/guide_data_dictionaries.rst @@ -96,7 +96,7 @@ This property is important for fields where you need to specify the format of th If your date values are not in ISO8601 format, use this property to define the format being used so that the data will import into the datastore correctly. Month and day values must be zero-padded. Follow the date formatting syntax of C / Python `strftime `_ to determine the pattern to use in your format property. For example, if your dates are in mm/dd/YYYY format, use "format": "%m/%d/%Y". .. Note:: - The "Download full dataset (CSV)" button will download the original source file. The "Download filtered data (CSV)" button will generate a new file, using the data dictioinary title values (if present) for the column headings, otherwise the column headings from the source file will be used. + The "Download full dataset (CSV)" button will download the original source file. The "Download filtered data (CSV)" button will generate a new file, using the data dictionary title values (if present) for the column headings, otherwise the column headings from the source file will be used. How to create a data dictionary ------------------------------- @@ -230,7 +230,7 @@ To set the data dictionary mode to **sitewide**: 4. Click "Save configuration". .. image:: images/dictionary-settings.png - :alt: Data dictionay settings admin page, with select input for "Dictionary Mode" set to "Sitewide" and text + :alt: Data dictionary settings admin page, with select input for "Dictionary Mode" set to "Sitewide" and text input for Sitewide Dictionary ID containing the identifier 7fd6bb1f-2752-54de-9a33-81ce2ea0feb2. @@ -249,7 +249,7 @@ To set the data dictionary mode to **distribution reference**: .. NOTE:: Assigning data dictionaries to datasets can be done on the dataset form. Enter the API endpoint of the data dictionary into the "Data Dictionary" field of the distribution section. Set the "Data Dictionary Type" field to *application/vnd.tableschema+json*. -Or, use the API to link a new dataset to the data dictionay. +Or, use the API to link a new dataset to the data dictionary. Look closely at the distribution property in the example below, this is using the data dictionary uuid from the example above. .. http:post:: /api/1/metastore/schemas/dataset/items diff --git a/docs/source/user-guide/guide_harvest.rst b/docs/source/user-guide/guide_harvest.rst index c3f6bcd8a9..553b8e6724 100644 --- a/docs/source/user-guide/guide_harvest.rst +++ b/docs/source/user-guide/guide_harvest.rst @@ -50,7 +50,7 @@ If you plan to maintain the datasets with the harvest process then do not edit t Edit the metadata in the data.json file and re-run the harvest to update the datasets. If you are using the harvest to simply bulk generate datasets, and want to allow data publishers to update the datasets as needed -via the UI or API, delete the data.json file to prevent overwritting any changes. After the 2.16.13 release, you could also +via the UI or API, delete the data.json file to prevent overwriting any changes. After the 2.16.13 release, you could also deregister the harvest. Register a harvest @@ -73,7 +73,7 @@ Register a harvest Run the harvest --------------- Once you have registered a harvest source, run the import, passing in - the identifier as an arguement + the identifier as an argument .. prompt:: bash $ diff --git a/docs/source/user-guide/guide_local_files.rst b/docs/source/user-guide/guide_local_files.rst index 6417f037ad..85dbc12c67 100644 --- a/docs/source/user-guide/guide_local_files.rst +++ b/docs/source/user-guide/guide_local_files.rst @@ -3,7 +3,7 @@ Importing very large files Very large datasets can present challenges for the datastore import process. What "very large" means will depend on your server infrastructure, but it's safe to say that when dealing with multi-gigabyte CSV files you may start to encounter broken file transfers or timeouts. -Because DKAN will make a local copy of a remote file in order to import it, it can help to prepare the import by transfering the files to the web server manually (or with shell scripts). Then you can instruct DKAN to use that already-existing local copy for processing into the database. +Because DKAN will make a local copy of a remote file in order to import it, it can help to prepare the import by transferring the files to the web server manually (or with shell scripts). Then you can instruct DKAN to use that already-existing local copy for processing into the database. These instructions assume you've already created a dataset (through the the UI, a harvest or the API) that contains a distribution pointing to a remote CSV file, and that this CSV file has not yet been imported to the datastore. We'll need the ID of the existing dataset. diff --git a/docs/source/user-guide/guide_metastore_properties.rst b/docs/source/user-guide/guide_metastore_properties.rst index 524b0cb056..89a0aece4b 100644 --- a/docs/source/user-guide/guide_metastore_properties.rst +++ b/docs/source/user-guide/guide_metastore_properties.rst @@ -4,7 +4,7 @@ How to add or remove entity generation for schema sub properties When you create a dataset, additional data nodes will be created for specific sub-elements of the dataset as well, the default properties are: publisher, theme, keywords, and distribution. These data nodes will provide unique reference ids for the sub-elements and -can be accesssed via an API endpoint. Learn about the `API `_. +can be accessed via an API endpoint. Learn about the `API `_. You can customize which sub-elements generate additional data nodes here ``admin/dkan/properties``.