Add upload spatial layers docs (#27)

* Add upload spatial layers docs * Add reference * Apply suggestions from code review minor language changes Co-authored-by: Jeremy-Prior <[email protected]> --------- Co-authored-by: Jeremy-Prior <[email protected]>
kartoza · Dec 3, 2024 · d144412 · d144412
1 parent 0381979
commit d144412
Show file tree

Hide file tree

Showing 24 changed files with 168 additions and 0 deletions.
diff --git a/docs/mkdocs-base.yml b/docs/mkdocs-base.yml
@@ -98,6 +98,7 @@ nav:
                   - Publishing layers in GeoServer: administrator/geoserver/publishing-layers-in-geoserver.md
                   - Styling layers in GeoServer: administrator/geoserver/styling-layers-in-geoserver.md
                   - Visualising GeoServer layers in QGIS: administrator/geoserver/visualising-geoserver-layers-in-qgis.md
+            - Upload Spatial Layer: administrator/upload-spatial-layers.md
             - GIS Data in BIMS:
                   - administrator/geocontext/index.md
                   - GeoContext Overview: administrator/geocontext/overview.md

diff --git a/docs/src/administrator/img/upload-spacial-layer-1.png b/docs/src/administrator/img/upload-spacial-layer-1.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-10.png b/docs/src/administrator/img/upload-spacial-layer-10.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-11.png b/docs/src/administrator/img/upload-spacial-layer-11.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-12.png b/docs/src/administrator/img/upload-spacial-layer-12.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-13.png b/docs/src/administrator/img/upload-spacial-layer-13.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-14.png b/docs/src/administrator/img/upload-spacial-layer-14.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-15.png b/docs/src/administrator/img/upload-spacial-layer-15.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-16.png b/docs/src/administrator/img/upload-spacial-layer-16.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-17.png b/docs/src/administrator/img/upload-spacial-layer-17.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-18.png b/docs/src/administrator/img/upload-spacial-layer-18.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-19.png b/docs/src/administrator/img/upload-spacial-layer-19.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-2.png b/docs/src/administrator/img/upload-spacial-layer-2.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-20.png b/docs/src/administrator/img/upload-spacial-layer-20.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-21.png b/docs/src/administrator/img/upload-spacial-layer-21.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-22.png b/docs/src/administrator/img/upload-spacial-layer-22.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-3.png b/docs/src/administrator/img/upload-spacial-layer-3.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-4.png b/docs/src/administrator/img/upload-spacial-layer-4.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-5.png b/docs/src/administrator/img/upload-spacial-layer-5.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-6.png b/docs/src/administrator/img/upload-spacial-layer-6.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-7.png b/docs/src/administrator/img/upload-spacial-layer-7.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-8.png b/docs/src/administrator/img/upload-spacial-layer-8.png
diff --git a/docs/src/administrator/img/upload-spacial-layer-9.png b/docs/src/administrator/img/upload-spacial-layer-9.png
diff --git a/docs/src/administrator/upload-spatial-layers.md b/docs/src/administrator/upload-spatial-layers.md
@@ -0,0 +1,167 @@
+---
+title: BIMS Documentation
+summary: Central documentation site for BIMS projects
+    - Ketan Bamniya
+date: 26-09-2023
+some_url: https://github.com/kartoza/bims-website
+copyright: Copyright 2023, Kartoza
+contact: 
+license: This program is free software; you can redistribute it and/or modify it under the terms of the GNU Affero General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.
+#context_id: 1234
+---
+
+# BIMS: Upload Spatial Layers
+
+>Note: Only admin/super users can upload spatial layers.
+
+Click [here](https://bims.site.com/upload-spatial-layer/) to access the upload spatial layers page.
+
+This is how it looks.
+
+![Upload Layers UI](./img/upload-spacial-layer-1.png)
+
+* **Name:** Enter the name of the layer.
+
+* **Choose files:** Select the shape file and auxiliary files to upload.
+
+* **Submit:** Uploads the files.
+
+* **❎:** Close the form.
+
+
+## Upload Layers
+
+Click on the `Choose files` button to select the shape file and auxiliary files to upload.
+
+![Upload Layers UI](./img/upload-spacial-layer-4.png)
+
+This will open the file explorer from where user can select the necessary files for their layer.
+
+> Note: Users should select multiple files at the same to upload.
+
+![File Explorer](./img/upload-spacial-layer-2.png)
+
+* **Cancel:** Cancel the process.
+
+* **Open:** After selecting the files, click on the `Open` button to upload the files.
+
+* **✅ Open files read only:** Open the files in read only mode.
+
+* **None:** File extension.
+
+This process will take some time to complete.
+
+## 413 Request Entity Too Large
+
+This error appears when the uploaded files exceeds the maximum size limit.
+
+![Error](./img/upload-spacial-layer-3.png)
+
+## Current Process:
+
+### Status: Start
+
+Indicates that the process has started.
+
+![Start Status](./img/upload-spacial-layer-7.png)
+
+
+### Status: Running
+
+Indicates that the process is in progress and may take some time to complete.
+
+![Running Status](./img/upload-spacial-layer-5.png)
+
+### Status: Success
+
+Indicates that the files have been uploaded successfully.
+
+![Success Status](./img/upload-spacial-layer-8.png)
+
+* Users will receive a success message.
+
+    ![Success Status Message](./img/upload-spacial-layer-10.png)
+
+### Status: Failed
+
+Indicates that the files failed to upload.
+
+## Access Editor
+
+After successfully completing the process, the user will gain access to the editor page.
+
+Click on the `Editor` button to access the editor page
+
+![Editor Button](./img/upload-spacial-layer-9.png)
+
+This is the UI of the `Editor` page.
+
+![Editor UI](./img/upload-spacial-layer-11.png)
+
+## Admin page 
+
+* To access the admin page, hover on the `Administration` drop down menu from the top navigation bar.
+
+    ![Administration tab](./img/upload-spacial-layer-12.png)
+
+* Choose the `Admin Page` option from the drop down menu. This will open the admin page.
+
+    ![Drop Down Menu](./img/upload-spacial-layer-13.png)
+
+### Access the Uploaded Layers
+
+* Navigate to the `Cloud Native Layer` section from the left menu.
+
+    ![Cloud Native Layers Section](./img/upload-spacial-layer-15.png)
+
+    Click on the `Cloud Native Layer` heading to navigate to this section on a new page. 
+
+    ![Cloud Native Layers Section](./img/upload-spacial-layer-16.png)
+
+    1. **Layer uploads:** By clicking on this, users will be able to see all the uploaded layers.
+
+        ![Layer Uploads](./img/upload-spacial-layer-17.png)
+
+        **1. total:** Displays the total number of layers uploaded.
+
+        **2. Data:** This is the list of uploaded layers with the corresponding details.
+
+        **3. Add layer upload:** This button is used to upload a new layer.
+
+        **4. Filter:** By using this, users can filter the data. After clicking on this a dropdown menu will appear.
+
+        ![Filter](./img/upload-spacial-layer-18.png)
+
+        * **Layer:** This is used to filter the layers by name.
+
+        * **Status:** This filter allows users to arrange the layers by their current status such as success, failed, etc.
+
+            ![Filter By Status](./img/upload-spacial-layer-19.png)
+
+        **5. Dropdown menu:** This menu allows users to perform some actions on the data. This are the available options.
+
+        ![Dropdown Menu](./img/upload-spacial-layer-20.png)
+
+        * **Import data:** This option allows users to import the data.
+
+        * **Delete selected layer uploads:** This option is used to delete the selected layers. Users can delete multiple layers at once.
+
+        **6. Go:** This button allows users to proceed with the actions they have selected from the dropdown menu.
+
+    2. **Layers:** By clicking on this users will be able to see the list of the layers they have uploaded including their details.
+
+        ![Layers](./img/upload-spacial-layer-21.png)
+
+        **1. total:** Total number of layers.
+
+        **2. Data:** This is the list of layers with their details such as id, status, created_by, etc.
+
+        **3. Add layer:** This button allows users to upload a new layer from the admin panel.
+
+        **4. Dropdown menu:** This menu allows users to perform some actions on the data. This are the available options.
+
+        ![Dropdown Menu](./img/upload-spacial-layer-22.png)
+
+        * **Delete selected layers:** This option is used to delete the selected layers. Users can delete multiple layers at once.
+
+        * **Go:** This button allows users to proceed with the actions they have selected from the dropdown menu.