Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Update README and other documentation #711

Merged
merged 59 commits into from
Aug 14, 2023
Merged

Update README and other documentation #711

merged 59 commits into from
Aug 14, 2023

Commits on Aug 7, 2023

  1. Add NSIDC and NSF logos to README

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    c1b6089 View commit details
    Browse the repository at this point in the history

  2. Sections for level of support, installation, usage, and troubleshooting

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    5143fff View commit details
    Browse the repository at this point in the history

  3. Link to documentation page for usage section

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    5d51c39 View commit details
    Browse the repository at this point in the history

  4. Link to github issues

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    9aced42 View commit details
    Browse the repository at this point in the history

  5. Link to contributing section from "level of support"

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    7caa2b7 View commit details
    Browse the repository at this point in the history

  6. remove redudant content about what's included in QGreenland

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    7e5d4dd View commit details
    Browse the repository at this point in the history

  7. Link to "What is QGreenland" page in description

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    de5c6c7 View commit details
    Browse the repository at this point in the history

  8. Tweak disclaimer text

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    348b32f View commit details
    Browse the repository at this point in the history

  9. Move QGIS supported versions to get-started tutorial.

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    f04a4b8 View commit details
    Browse the repository at this point in the history

  10. Fixup broken link

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    1b3d486 View commit details
    Browse the repository at this point in the history

  11. Move disclaimer to page on RTD

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    f3afcc5 View commit details
    Browse the repository at this point in the history

  12. docs: relative link to RTD page

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    7553ed7 View commit details
    Browse the repository at this point in the history

  13. Fix link in video series overview

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    12d0ab9 View commit details
    Browse the repository at this point in the history

  14. Link title + formatting

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    a76f27b View commit details
    Browse the repository at this point in the history

  15. Fixups and improvements for the qgreenland beginner series tutorial

    @trey-stafford
    trey-stafford committed Aug 7, 2023
    Configuration menu
    Copy the full SHA
    6354f2a View commit details
    Browse the repository at this point in the history

Commits on Aug 8, 2023

  1. Update QGIS docs refs from v3.16 -> v3.28 

    The 3.16 links give an 'outdated docs' warning. Since 3.28 is our latest
supported version, update these paths to reflect that.
    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    05e249f View commit details
    Browse the repository at this point in the history

  2. Update note about temporal controller 

    Link to actual QGIS documentation page.
    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    cb17c26 View commit details
    Browse the repository at this point in the history

  3. Remove unnecessary new lines

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    3a4efec View commit details
    Browse the repository at this point in the history

  4. Remove user installation instructions from README

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    04a50f5 View commit details
    Browse the repository at this point in the history

  5. Tweaks for "what is qgr" doc pageo 

    * Remove QGreenland plugin as indicated way that QGreenland is delivered. The
  attention admonition is sufficient.
* "Return to QGreenland website" -> "Visit the QGreenland website". This page is
  linked to from more than just he QGreenland website.
    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    4a2f95e View commit details
    Browse the repository at this point in the history

  6. formatting

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    768a6bc View commit details
    Browse the repository at this point in the history

  7. Merge branch 'main' into update-readme-nsidc-template

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    c6fca01 View commit details
    Browse the repository at this point in the history

  8. Remove text about the future of QGreenland custom using 'modules'

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    09535f4 View commit details
    Browse the repository at this point in the history

  9. Data compatibility guide: link to documentation page

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    75a5284 View commit details
    Browse the repository at this point in the history

  10. Adding-data how-to: update text around adding new layers to qgis

    @trey-stafford
    trey-stafford committed Aug 8, 2023
    Configuration menu
    Copy the full SHA
    3786f58 View commit details
    Browse the repository at this point in the history

Commits on Aug 9, 2023

  1. Clarify name of section about selecting for greenaland-specific data 

    This section is specifically about vector data.

TODO: should we also have a section on clipping raster data?
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    872e63a View commit details
    Browse the repository at this point in the history

  2. Move & update section on creating custom clipping boundary polygon

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    8c17ab8 View commit details
    Browse the repository at this point in the history

  3. update section on adding new vector layers 

    Remove content about creating shapefiles. We do not reccomend their
use/creation. Point to QGIS documentation for creating new vector layers, which
covers shapefile creation. Keep Geopackage creation instructions for those who
are working offline.
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    8b3ea4e View commit details
    Browse the repository at this point in the history

  4. Cleanup trailing whitespaces

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    364462e View commit details
    Browse the repository at this point in the history

  5. Fixup references

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    5b708e8 View commit details
    Browse the repository at this point in the history

  6. Remove some contractions (e.g., you're -> you are) from docs

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    66ed05e View commit details
    Browse the repository at this point in the history

  7. Significantly simplify GPS how-to guide. 

    The information as-written is outdated for QGIS 3.28. There's a lot of
detail (including installation of an external dependency) that we should avoid
repeating here.
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    06855fb View commit details
    Browse the repository at this point in the history

  8. Fixup heading position (swap newline)

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    5d8f42b View commit details
    Browse the repository at this point in the history

  9. that's -> that is

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    c1a08b8 View commit details
    Browse the repository at this point in the history

  10. it's -> it is

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    51d977c View commit details
    Browse the repository at this point in the history

  11. Move note about qgr project crs

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    18452bc View commit details
    Browse the repository at this point in the history

  12. Metadata how-to: remove reference to qgreenland custom 

    No reason to confuse users over qgr custom
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    e001a35 View commit details
    Browse the repository at this point in the history

  13. Replace plugin tutorial w/ discussion page.

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    6038fe4 View commit details
    Browse the repository at this point in the history

  14. Remove "How-tos" section from contributing discussion 

    We don't have an index page for the `contributor-how-to`, just the TOC on the
left.
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    dcf24a3 View commit details
    Browse the repository at this point in the history

  15. Further updates to README, contributor docs

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    27edfe8 View commit details
    Browse the repository at this point in the history

  16. what's -> what is 

    I can't help myself 😆
    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    5a3ca42 View commit details
    Browse the repository at this point in the history

  17. Fixup link

    @trey-stafford
    trey-stafford committed Aug 9, 2023
    Configuration menu
    Copy the full SHA
    360a157 View commit details
    Browse the repository at this point in the history

Commits on Aug 10, 2023

  1. Update doc/user/tutorials/video-series-overview.md 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    69351a3 View commit details
    Browse the repository at this point in the history

  2. Update README.md 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    f618dbc View commit details
    Browse the repository at this point in the history

  3. Update README.md 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    baaa5c8 View commit details
    Browse the repository at this point in the history

  4. Update README.md 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    ba7fb53 View commit details
    Browse the repository at this point in the history

  5. Update README to make repo responsibilities clear 

    We want to direct those who want to use QGreenland Core to our website.
    @trey-stafford
    trey-stafford committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    740b770 View commit details
    Browse the repository at this point in the history

  6. Attempt to force README logos to be same size

    @trey-stafford
    trey-stafford committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    f53e2ed View commit details
    Browse the repository at this point in the history

  7. Move badges below title

    @trey-stafford
    trey-stafford committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    116b910 View commit details
    Browse the repository at this point in the history

  8. Add CODE_OF_CONDUCT

    @trey-stafford
    trey-stafford committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    d86d5f5 View commit details
    Browse the repository at this point in the history

  9. Capitalize word 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    2003968 View commit details
    Browse the repository at this point in the history

  10. Clarify link text 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    5822d62 View commit details
    Browse the repository at this point in the history

  11. Fixup spelling 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    ab4caa7 View commit details
    Browse the repository at this point in the history

  12. ! -> . 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 10, 2023
    Configuration menu
    Copy the full SHA
    42559b4 View commit details
    Browse the repository at this point in the history

  13. Replace note about downloading qgr w/ info about tutorial 

    Should be obvious that qgr core is required to look at layer metadata. We do a
good job of directing users to the 'right' starting place already.

The info about the tutorial is better suited for a note.
    @trey-stafford
    trey-stafford committed Aug 10, 2023
    Configuration menu
    Copy the full SHA
    3e55c05 View commit details
    Browse the repository at this point in the history

Commits on Aug 14, 2023

  1. Remove Level of Support section, for now 

    We need some updated guidance on when/how to set the LoS. This is primarily for
tools supported by USO, which we don't really expect for QGreenland.
    @trey-stafford
    trey-stafford committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    c65d456 View commit details
    Browse the repository at this point in the history

  2. Tweak language about scope of users 

    Co-authored-by: Matt Fisher <[email protected]>
    @trey-stafford @mfisher87
    trey-stafford and mfisher87 authored Aug 14, 2023
    Configuration menu
    Copy the full SHA
    d791b50 View commit details
    Browse the repository at this point in the history

  3. Update how-to: add note about geospatial metadata

    @trey-stafford
    trey-stafford committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    06abc3c View commit details
    Browse the repository at this point in the history

  4. Explicit reference

    @trey-stafford
    trey-stafford committed Aug 14, 2023
    Configuration menu
    Copy the full SHA
    d540657 View commit details
    Browse the repository at this point in the history