From 7f739db1f0cca88983974fa89f5387deeec28d22 Mon Sep 17 00:00:00 2001 From: Philip Bailey Date: Fri, 19 Apr 2024 23:16:51 +0000 Subject: [PATCH] QViewer uploader docs --- .../page/software-help/help-qgis-uploader.mdx | 73 + docs/content/page/software-help/help-qgis.mdx | 6 +- docs/static/images/qviewer/uploader-menu.png | Bin 0 -> 100994 bytes docs/static/images/qviewer/uploader.png | Bin 0 -> 87602 bytes docs/yarn.lock | 3234 ++++++++--------- 5 files changed, 1695 insertions(+), 1618 deletions(-) create mode 100644 docs/content/page/software-help/help-qgis-uploader.mdx create mode 100644 docs/static/images/qviewer/uploader-menu.png create mode 100644 docs/static/images/qviewer/uploader.png diff --git a/docs/content/page/software-help/help-qgis-uploader.mdx b/docs/content/page/software-help/help-qgis-uploader.mdx new file mode 100644 index 0000000..044d92b --- /dev/null +++ b/docs/content/page/software-help/help-qgis-uploader.mdx @@ -0,0 +1,73 @@ +--- +title: Uploading Projects +banner: true +description: Uploading Projects to the Riverscapes Data Exchange +--- + +# Uploading Riverscapes Projects + +With QViewer you can upload riverscapes projects into the [Riverscapes Data Exchange](https://data.riverscapes.net). + + +# Before You begin + +This feature requires that you have the following: + +1. a Riverscapes login. Visit the [Riverscapes Data Exchange](https://data.riverscapes.net) and create one first if you don't have one already. +1. A valid Riverscapes compliant project. This can be a new project that you have created, either by hand or using a tool such as [Riverscapes Studio](https://qris.riverscapes.net). Or it could be a project that you or someone else has downloaded from the Data Exchange and altered in some way; Perhaps you have edited some data or performed quality control. + +# Getting Started + +1. Open the project you want to upload in the Riverscapes Viewer. +1. Right click on the project node in the project explorer and choose `Upload Project to Data Exchange`. + +![upload menu](/images/qviewer/uploader-menu.png) + +A web browser will open and you will be prompted to login to the Riverscapes Data Exchange. After you have successfully logged in, focus will return to QGIS and the project upload form (see below). If you already have an active Riverscapes login then it will be detected and you will not need to login again. Should you want to change Riverscapes logins you can click the `Reset` button (4) to logout and be prompted for a different login. + +![uploader](/images/qviewer/uploader.png) + +The project name is shown at the top of the form (1), followed by the local path (2) where the project is located on your computer. ALWAYS check that both these fields are correct and that you are attempting to upload the correct project! + +# New or Update Project + +If your riverscapes project originated from the Data Exchange then you will have the option to modify the existing project (i.e. overwrite the version that's in the Data Exchange) (5). If you choose to modify you can choose whether you want to keep all files on the Data Exchange ("no remote delete"). This is useful if you have downloaded a partial copy of a project from the Data Exchange and want to upload just the parts that you downloaded while keeping all the other files that exist online. Unchecking the "No remote delete" box when modifying existing projects will upload your local copy and remove any files on the Data Exchange that do no appear in your local copy. + +For projects that originated in the Data Exchange, clicking the `Visit` button will launch a web browser and take you to the project details for the relevant project. + +If the project has never been stored in the Data Exchange, you will be limited to the "Upload as new project" option. + +# Project Ownership + +If the project has never been stored in the Data Exchange, you can choose whether to assign the new project to an organization or leave it associated with your Riverscapes user account (shown above in 3). Note that the list of available organizations is limited to only those to which you have `write` privileges. If you don't see the desired organization, then visit the [list of organizations](https://data.riverscapes.net/s?type=Organization) in the Data Exchange and contact the organization administrator to request access. + +# Visibility + +Pick the appropriate visibility for the project in the Data Exchange. Note that this option is only available when uploading new projects. Modifying an existing project will retain its existing visility. + +- **PUBLIC** projects are visible, downloadable and searchable by any user in the system (applies to both user owned AND organization owned). +- **PRIVATE** Can be searched by all users, but only owners of the project (user owned projects) or members of the organization (org-owned projects) can see, download or modify the project and data layers. +- **SECRET** projects are identical to PRIVATE projects with one exception: they are not searchable or visible to users who do not explicitly have access. + +# Tags + +Use the `Add` and `Remove` buttons to add tags (8) to the project in the Data Exchange. Projects that originated from the Data Exchange prepopulate the list with the existing tags. + +Tags are strongly recommended because they are an excellent means by which to search the Data Exchange. + +# Upload Status + +Before you click `Start` to begin the Upload process you should review the proposed number of files to be added, updated or deleted. Pause and genuinely contemplate if the numbers make sense! + +# Uploading + +Clicking `Start` will commence project upload into the Data Exchange. There's one final prompt to ensure that you do indeed want to upload the project. You can cancel the process part way through and any files that have already been uploaded will be removed from the Data Exchange. The project is not considered part of the Data Exchange until ALL files are successfully uploaded. + +Once the upload is complete, the Data Exchange does a final check to validate the project and it's files. The status will appear as "Waiting for Upload Completion" for a few seconds during this step (9). + +After the project upload is complete you can click the `View in Data Exchange` button (10) to open a browser and navigate to the project details of the newly uploaded project in the Data Exchange. + +# Notes + +- Modifying an existing project in the Data Exchange is permanent and cannot be undone. +- For projects that originated from the Data Exchange, a comprehensive file hash check is used to determine which files have changed relative to those that already exist online. Only files that have changed are uploaded. \ No newline at end of file diff --git a/docs/content/page/software-help/help-qgis.mdx b/docs/content/page/software-help/help-qgis.mdx index 9541c19..f8d38ca 100644 --- a/docs/content/page/software-help/help-qgis.mdx +++ b/docs/content/page/software-help/help-qgis.mdx @@ -63,4 +63,8 @@ Simply click on the Riverscapes Viewer Help menu and choose "Updates Resources". > Need more help?