Skip to content

Commit 23993ea

Browse files
dcgoodwin2112dafeder
authored andcommitted
fix typos in DKAN docs
1 parent b51fe32 commit 23993ea

9 files changed

+13
-13
lines changed

README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ DKAN and related modules are freely-available under the ["GNU General Public Lic
4444

4545
## Security
4646

47-
If you have found a vunerability in DKAN, please report this by e-mailing dkan-security@civicactions.com.
47+
If you have found a vulnerability in DKAN, please report this by e-mailing dkan-security@civicactions.com.
4848

4949
---
5050

docs/source/contributing/documentation.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ Contributing to DKAN documentation
22
==================================
33

44
What follows is a style guide for the DKAN documentation. Use it both to follow the conventions used throughout the site,
5-
and for your own contributions. DKAN's documentaion is written in a combination of `Markdown <https://daringfireball.net/projects/markdown>`_
6-
and `ReStructuredText (RST) <http://www.sphinx-doc.org/en/stable/rest.html>`_, and built with `Sphynx <http://www.sphinx-doc.org/en/stable/index.html>`_.
5+
and for your own contributions. DKAN's documentation is written in a combination of `Markdown <https://daringfireball.net/projects/markdown>`_
6+
and `ReStructuredText (RST) <http://www.sphinx-doc.org/en/stable/rest.html>`_, and built with `Sphinx <http://www.sphinx-doc.org/en/stable/index.html>`_.
77
The docs live in the `/docs/source` folder of the `DKAN Project <https://github.com/GetDKAN/dkan>`_; to suggest modifications,
88
submit a pull request as you would for any suggested code change.
99

docs/source/drush_commands.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -198,7 +198,7 @@ dkan:harvest:register
198198
dkan:harvest:revert
199199
--------------------
200200

201-
Revert a harvest. Removes harvested entities and unpublishes orhpaned
201+
Revert a harvest. Removes harvested entities and unpublishes orphaned
202202
keywords, themes, and distributions. The harvest plan will remain and can
203203
be run again to generate the datasets after any issues have been resolved.
204204

docs/source/installation/index.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This will ensure you have the same setup as DKAN's core developers, and that you
1818
Requirements
1919
------------
2020

21-
DKAN is based on `Drupal software <https://www.drupal.org/docs/getting-started/system-requirements>`_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend:
21+
DKAN is based on `Drupal software <https://www.drupal.org/docs/getting-started/system-requirements>`_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we recommend:
2222

2323
- Drupal 10+
2424
- MySQL: minimum version 5.7.8+ with PDO

docs/source/introduction/glossary.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Glossary
1717
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.
1818

1919
Dataset
20-
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**.
20+
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**.
2121

2222
Datastore
2323
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.

docs/source/user-guide/guide_data_dictionaries.rst

+3-3
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ This property is important for fields where you need to specify the format of th
9696
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 <http://strftime.org/>`_ 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".
9797

9898
.. Note::
99-
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.
99+
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.
100100

101101
How to create a data dictionary
102102
-------------------------------
@@ -230,7 +230,7 @@ To set the data dictionary mode to **sitewide**:
230230
4. Click "Save configuration".
231231

232232
.. image:: images/dictionary-settings.png
233-
:alt: Data dictionay settings admin page, with select input for "Dictionary Mode" set to "Sitewide" and text
233+
:alt: Data dictionary settings admin page, with select input for "Dictionary Mode" set to "Sitewide" and text
234234
input for Sitewide Dictionary ID containing the identifier 7fd6bb1f-2752-54de-9a33-81ce2ea0feb2.
235235

236236

@@ -249,7 +249,7 @@ To set the data dictionary mode to **distribution reference**:
249249
.. NOTE::
250250
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*.
251251

252-
Or, use the API to link a new dataset to the data dictionay.
252+
Or, use the API to link a new dataset to the data dictionary.
253253
Look closely at the distribution property in the example below, this is using the data dictionary uuid from the example above.
254254

255255
.. http:post:: /api/1/metastore/schemas/dataset/items

docs/source/user-guide/guide_harvest.rst

+2-2
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@ If you plan to maintain the datasets with the harvest process then do not edit t
5050
Edit the metadata in the data.json file and re-run the harvest to update the datasets.
5151

5252
If you are using the harvest to simply bulk generate datasets, and want to allow data publishers to update the datasets as needed
53-
via the UI or API, delete the data.json file to prevent overwritting any changes. After the 2.16.13 release, you could also
53+
via the UI or API, delete the data.json file to prevent overwriting any changes. After the 2.16.13 release, you could also
5454
deregister the harvest.
5555

5656
Register a harvest
@@ -73,7 +73,7 @@ Register a harvest
7373
Run the harvest
7474
---------------
7575
Once you have registered a harvest source, run the import, passing in
76-
the identifier as an arguement
76+
the identifier as an argument
7777

7878
.. prompt:: bash $
7979

docs/source/user-guide/guide_local_files.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Importing very large files
33

44
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.
55

6-
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.
6+
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.
77

88
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.
99

docs/source/user-guide/guide_metastore_properties.rst

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ How to add or remove entity generation for schema sub properties
44
When you create a dataset, additional data nodes will be created for specific sub-elements
55
of the dataset as well, the default properties are: publisher, theme, keywords, and
66
distribution. These data nodes will provide unique reference ids for the sub-elements and
7-
can be accesssed via an API endpoint. Learn about the `API <https://demo.getdkan.org/api>`_.
7+
can be accessed via an API endpoint. Learn about the `API <https://demo.getdkan.org/api>`_.
88

99
You can customize which sub-elements generate additional data nodes here ``admin/dkan/properties``.
1010

0 commit comments

Comments
 (0)