Skip to content

Commit

Permalink
fix typos in DKAN docs
Browse files Browse the repository at this point in the history
  • Loading branch information
dcgoodwin2112 committed Dec 14, 2024
1 parent 31f5342 commit ce55829
Show file tree
Hide file tree
Showing 9 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 [email protected].
If you have found a vulnerability in DKAN, please report this by e-mailing [email protected].

---

Expand Down
4 changes: 2 additions & 2 deletions docs/source/contributing/documentation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://daringfireball.net/projects/markdown>`_
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>`_.
and for your own contributions. DKAN's documentation is written in a combination of `Markdown <https://daringfireball.net/projects/markdown>`_
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>`_.
The docs live in the `/docs/source` folder of the `DKAN Project <https://github.com/GetDKAN/dkan>`_; to suggest modifications,
submit a pull request as you would for any suggested code change.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/drush_commands.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/installation/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://www.drupal.org/docs/getting-started/system-requirements>`_ and -- generally -- runs anywhere Drupal is supported. For the most common setup, we reccomend:
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:

- Drupal 10+
- MySQL: minimum version 5.7.8+ with PDO
Expand Down
2 changes: 1 addition & 1 deletion docs/source/introduction/glossary.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
6 changes: 3 additions & 3 deletions docs/source/user-guide/guide_data_dictionaries.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <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".

.. 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
-------------------------------
Expand Down Expand Up @@ -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.


Expand All @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/source/user-guide/guide_harvest.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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 $

Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/guide_local_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/user-guide/guide_metastore_properties.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://demo.getdkan.org/api>`_.
can be accessed via an API endpoint. Learn about the `API <https://demo.getdkan.org/api>`_.

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

Expand Down

0 comments on commit ce55829

Please sign in to comment.