diff --git a/doc/contributor/discussion/contributing.md b/doc/contributor/discussion/contributing.md index 34921c3a..6e190c3d 100644 --- a/doc/contributor/discussion/contributing.md +++ b/doc/contributor/discussion/contributing.md @@ -32,7 +32,7 @@ Currently, layer styles can be contributed without any programming knowledge by designing the style in QGIS, saving it as a `.qml`, and committing it to the `qgreenland/ancillary/styles` directory. -You can contribute to this project even if you don't have write access by +You can contribute to this project even if you do not have write access by forking, making your change, making all CI checks pass, then opening a Pull Request. Learn more: diff --git a/doc/contributor/discussion/pydantic-and-mypy.md b/doc/contributor/discussion/pydantic-and-mypy.md index 629842bf..3b3229b5 100644 --- a/doc/contributor/discussion/pydantic-and-mypy.md +++ b/doc/contributor/discussion/pydantic-and-mypy.md @@ -6,10 +6,10 @@ While Pydantic uses type annotations to determine runtime validation behavior, i effectively overrides your annotation with `Any` (try `reveal_type(MyModel)`!). This is because Pydantic needs to be able to convert compatible values. [Pydantic's mypy plugin](https://docs.pydantic.dev/1.10/mypy_plugin/#plugin-settings), which we use, -offers an `init_typed` setting, which we don't use, to "correctly" annotate the +offers an `init_typed` setting, which we do not use, to "correctly" annotate the `__init__` method of models, with the downside that Mypy throws errors when you take advantage of Pydantic's type conversion behavior. -For this reason, it's expected that QGreenland config files would **pass** type checking -when instantiating Pydantic models with incorrect field types. These would instead -**fail** runtime validation. +For this reason, it is expected that QGreenland config files would **pass** type +checking when instantiating Pydantic models with incorrect field types. These +would instead **fail** runtime validation. diff --git a/doc/contributor/how-to/contribute-layers.md b/doc/contributor/how-to/contribute-layers.md index 3cb20ab6..6a43abd9 100644 --- a/doc/contributor/how-to/contribute-layers.md +++ b/doc/contributor/how-to/contribute-layers.md @@ -1,7 +1,7 @@ # How to contribute new layers ```{note} -We can't promise that your layer will be added, so please [open an +We cannot promise that your layer will be added, so please [open an issue](https://github.com/nsidc/qgreenland/issues/new/choose) and start a discussion before developing a processing pipeline for a new layer. ``` diff --git a/doc/contributor/how-to/contribute-styles.md b/doc/contributor/how-to/contribute-styles.md index 6ff8d63f..14af27ab 100644 --- a/doc/contributor/how-to/contribute-styles.md +++ b/doc/contributor/how-to/contribute-styles.md @@ -12,7 +12,7 @@ following process: ![Save style](/_images/save_style.png) -* At this point, if you're uncomfortable with Git and GitHub, you can email us +* At this point, if you are uncomfortable with Git and GitHub, you can email us your style file at qgreenland.info@gmail.com. Otherwise, continue on... * Save the style to `qgreenland/assets/styles/.qml` directory of this repository or your fork. Keep in mind that styles can be shared between diff --git a/doc/contributor/how-to/release-new-version.md b/doc/contributor/how-to/release-new-version.md index 2b9b877a..4bade417 100644 --- a/doc/contributor/how-to/release-new-version.md +++ b/doc/contributor/how-to/release-new-version.md @@ -14,7 +14,7 @@ Versions should be in one of the following forms: * `vX.Y.Z`: A final release, e.g. `v1.2.3`. ```{caution} -When using `bumpversion build`, ensure you've already used `bumpversion +When using `bumpversion build`, ensure you have already used `bumpversion prerelease`. Running `bumpversion build` from a final release version number can result in an incorrect patch number, e.g. `v1.2.304`. ``` diff --git a/doc/contributor/how-to/write-documentation.md b/doc/contributor/how-to/write-documentation.md index 8a0eac69..6ea0bd6d 100644 --- a/doc/contributor/how-to/write-documentation.md +++ b/doc/contributor/how-to/write-documentation.md @@ -48,10 +48,11 @@ Our PDF doc is intended to be user-focused, but our HTML docs serve users and contributors (i.e. PDF docs are a subset of HTML docs). Most of the docs end up in both formats, so we want to use the same content to create both. -Sphinx offers the `.. only::` directive for conditional content, but it does not work as -one might intuitively expect. Specifically, it isn't capable of creating conditional or -filtered `toctrees`. Because of this insufficiency, we're employing two nonstandard -methods in `doc/index.rst` to deselect items from PDF docs: +Sphinx offers the `.. only::` directive for conditional content, but it does not +work as one might intuitively expect. Specifically, it isn't capable of creating +conditional or filtered `toctrees`. Because of this insufficiency, we are +employing two nonstandard methods in `doc/index.rst` to deselect items from PDF +docs: * The package [sphinx-selective-exclude](https://pypi.org/project/sphinx-selective-exclude/) @@ -99,7 +100,7 @@ the Docs. ## Contributing to documentation ```{attention} -You'll need to have TeX Live installed if you want to render PDF documentation. On +You will need to have TeX Live installed if you want to render PDF documentation. On Debian-based systems, you can install it with `sudo apt install texlive-latex-extra`. We attempted to include this dependency via the `conda` package `texlive-core`, but @@ -114,7 +115,7 @@ it. material](https://diataxis.fr/reference/), or a [Discussion topic](https://diataxis.fr/explanation/)? Ensure your document is in the correct directory and written for the correct audience. -* Write your documentation in Markdown, unless you're writing a page that must +* Write your documentation in Markdown, unless you are writing a page that must be majority reStructuredText, such as an `index.rst` for a new group of pages. * Ensure your documentation page starts with a top-level header. This is the title of the page. diff --git a/doc/contributor/reference/architecture/storage.md b/doc/contributor/reference/architecture/storage.md index 0ff0b8b2..678590bf 100644 --- a/doc/contributor/reference/architecture/storage.md +++ b/doc/contributor/reference/architecture/storage.md @@ -55,10 +55,10 @@ data/private-archive ``` While this project prefers to only include publicly-archived and -machine-accessible data, we do have some privately-archived data that we've +machine-accessible data, we do have some privately-archived data that we have sourced by e-mailing scientists or manually interacting with machine-unfriendly -systems. These datasets have an `access_instructions` attribute in -configuration that describes how the data was acquired. +systems. These datasets have an `access_instructions` attribute in configuration +that describes how the data was acquired. May be read-only. diff --git a/doc/user/how-to/adding-data.md b/doc/user/how-to/adding-data.md index e77f3a97..bdbb53f9 100644 --- a/doc/user/how-to/adding-data.md +++ b/doc/user/how-to/adding-data.md @@ -73,7 +73,7 @@ To edit a vector layer: Table**. 5. If you just want to edit a record in a vector layer’s **Attribute Table**, you can open the **Attribute Table** and click on the **Toggle Editing** icon in the table toolbar. Be - sure to save the layer edits after you’re done making edits. + sure to save the layer edits after you are done making edits. 6. When you’re finished, click on the **Toggle Editing** button again in the toolbar to disable editing. @@ -132,10 +132,11 @@ extract features from vector layers using the custom polygon boundary layer instead of the "Greenland coastlines 2017" layer. ## Importing GPS and other GNSS Data Using the GPS Plugin + Importing GPS (Global Positioning System) or other GNSS (Global Navigation Satellite System) data into QGIS requires an internal plugin. A plugin is just a new feature or function -that you can add to QGIS that does something one of the built-in tools doesn’t do. Many +that you can add to QGIS that does something one of the built-in tools does not do. Many plugins are ‘external’ meaning they are not developed and maintained by the QGIS development team. Some plugins, however, are ‘core’ meaning they are maintained by the QGIS team. The **GPS Plugin** is a core plugin and should already be installed in your version of @@ -144,7 +145,7 @@ QGIS. To turn on the **GPS Plugin**: 1. Go to **Plugins -> Manage and Install Plugins** in the **Menu Bar**. 2. Click on **Installed** in the left sidebar, then check the box next to **GPS Tools** in -the plugin list. If it is already checked, don’t change anything. +the plugin list. If it is already checked, do not change anything. 3. Click **Close**. You can import GPS data either directly from a GPS device that is connected to your diff --git a/doc/user/how-to/troubleshooting.md b/doc/user/how-to/troubleshooting.md index 978b4838..7a8b05e4 100644 --- a/doc/user/how-to/troubleshooting.md +++ b/doc/user/how-to/troubleshooting.md @@ -8,13 +8,13 @@ ## Difficulty opening the project -If you're having trouble opening the project, first ensure you're using QGIS +If you are having trouble opening the project, first ensure you are using QGIS 3.16 LTR or greater. If you want to move QGreenland to a different location on your filesystem, move the entire directory; do not attempt to move only the `.qgs`/`.qgz` project file. -### QGIS won't start on OSX Catalina +### QGIS will not start on OSX Catalina QGIS is currently not 'notarized' for Mac OSX. If you receive `The developer of this app needs to update it to work with this version of macOS. Contact the @@ -38,9 +38,9 @@ qgis qgreenland.qgs ### No layers are present in the Layers Panel -If you don't see layers in the **Layers Panel**, you have not correctly opened a -project. Click **Project** in the **Menu Bar**, then select **Add Project**, then -navigate to your QGreenland directory, wherever you saved it, and open the +If you do not see layers in the **Layers Panel**, you have not correctly opened +a project. Click **Project** in the **Menu Bar**, then select **Add Project**, +then navigate to your QGreenland directory, wherever you saved it, and open the `.qgs`/`.qgz` file inside. @@ -48,8 +48,8 @@ navigate to your QGreenland directory, wherever you saved it, and open the ### After opening QGreenland, I only see blue ocean -Right click on a layer in the **Layers Panel** that you'd like to view, and select -**Zoom to Layer**. +Right click on a layer in the **Layers Panel** that you would like to view, and +select **Zoom to Layer**. If you experience this issue, please [contact us](mailto:qgreenland.info@gmail.com) with information about your Operating @@ -88,9 +88,9 @@ affected. Reboot your computer to make the changes permanent. ### I see `ERROR: Too many connections: max 64` in my terminal -We don't think this is an issue. This started happening when we switched to -GeoPackages for vector data, but we've observed no negative impact of this -error message. +We do not think this is an issue. This started happening when we switched to +GeoPackages for vector data, but we have observed no negative impact of this error +message. ### The QGIS interface has no buttons or toolbars @@ -100,7 +100,7 @@ wish to turn on so that they are displayed. You can also go to **View -> Toolbars** in the **Menu Bar**. -### I can't see a layer in the Map View even though it's turned on and I've zoomed to it +### I cannot see a layer in the Map View even though it is turned on and I have zoomed to it Double-check that there is not another layer overlaying and thus obscuring the layer you want to see in the **Map View**. Remember that layer are displayed in the @@ -156,7 +156,7 @@ has determined can be ignored: impact on the layers themselves or the project usability. -## I'm having other problems. How do I contact the QGreenland team? +## I am having other problems. How do I contact the QGreenland team? If you have feedback on or questions about the QGreenland data package, or want to contribute datasets to future QGreenland releases, please contact us at diff --git a/doc/what_is_qgr.md b/doc/what_is_qgr.md index 40c06c1c..95018953 100644 --- a/doc/what_is_qgr.md +++ b/doc/what_is_qgr.md @@ -13,7 +13,7 @@ See our tutorial on how to get started with QGreenland Core ```{attention} The QGIS Plugin **[QGreenland Custom](https://plugins.qgis.org/plugins/qgreenland/) (beta)** is no longer supported. This was an experiment, and we decided to go in a -different direction. It shouldn't be expected to work. +different direction. It should not be expected to work. ``` Visit the [QGreenland website](https://qgreenland.org)