diff --git a/frontend/documentation/topics/After-Adding-Measurements.md b/frontend/documentation/topics/After-Adding-Measurements.md index caca05d8..5313a574 100644 --- a/frontend/documentation/topics/After-Adding-Measurements.md +++ b/frontend/documentation/topics/After-Adding-Measurements.md @@ -1,25 +1,26 @@ # After Adding Measurements -Once you have successfully uploaded your supporting data, measurements, and successfully -validated your data, you can proceed in a number of ways. +Once you have successfully uploaded your supporting data, measurements, and successfully +validated your data, you can proceed in a number of ways. ## Post-Validation Statistics -After you have populated the measurements page, you can navigate to the post-validation -statistics page to perform statistics calculations on your census. +After you have populated the measurements page, you can navigate to the post-validation +statistics page to perform statistics calculations on your census. ### Interacting with the Post-Validation Statistics Page -After navigating to the page, you should see a table appear with a set of: -- SQL queries -- a brief explanation of their function -- historical data columns indicating: +After navigating to the page, you should see a table appear with a set of: + +- SQL queries +- a brief explanation of their function +- historical data columns indicating: - the last time they were run - - whether they were successful + - whether they were successful - what their successful run returned -Use the checkboxes to select the queries you want to run, and then click on the **Run -Statistics** button to run the queries. The queries should update momentarily. +Use the checkboxes to select the queries you want to run, and then click on the **Run +Statistics** button to run the queries. The queries should update momentarily. -You can also download or print the results of the queries by again selecting them via their -checkboxes and clicking on the **Download Statistics** or **Print Statistics** buttons. \ No newline at end of file +You can also download or print the results of the queries by again selecting them via their +checkboxes and clicking on the **Download Statistics** or **Print Statistics** buttons. diff --git a/frontend/documentation/topics/Navigable-Endpoints.md b/frontend/documentation/topics/Navigable-Endpoints.md index 0d95585a..1b63f18c 100644 --- a/frontend/documentation/topics/Navigable-Endpoints.md +++ b/frontend/documentation/topics/Navigable-Endpoints.md @@ -14,5 +14,5 @@ This a brief overview of the pages you can access in the app and their function! - Uploaded Files (review uploaded files here) - View All Historical Data (view all data, irrespective of census, here) - Validations (review validations, what they are examining, and toggle them on/off here) - > Toggling validations is an admin-only feature! -{style='warning'} \ No newline at end of file + > Toggling validations is an admin-only feature! + > {style='warning'} diff --git a/frontend/documentation/topics/Onboarding.md b/frontend/documentation/topics/Onboarding.md index f653d79a..7aecc13c 100644 --- a/frontend/documentation/topics/Onboarding.md +++ b/frontend/documentation/topics/Onboarding.md @@ -1,19 +1,18 @@ # Onboarding for New Users -Thank you for using this application! +Thank you for using this application! This document will provide you with an understanding of how the application works. - ## Preparing Your Account Before you can log into the application, you must complete the following steps: 1. You must have a personal MS or Office account. - > Support for existing SI accounts is still pending. Thank you for your patience! - {style='warning'} + > Support for existing SI accounts is still pending. Thank you for your patience! + > {style='warning'} 2. This account must be invited to the SIOCIORC tenant. -3. A user should be created for you and must be loaded into the website's `catalog` database. +3. A user should be created for you and must be loaded into the website's `catalog` database. 4. Your user should be assigned a user persona. 5. At least one site should be assigned to your account. -Once this process is completed, you should be able to successfully log in to the website! \ No newline at end of file +Once this process is completed, you should be able to successfully log in to the website! diff --git a/frontend/documentation/topics/Selecting-Options.md b/frontend/documentation/topics/Selecting-Options.md index 5e504b9b..f1c64249 100644 --- a/frontend/documentation/topics/Selecting-Options.md +++ b/frontend/documentation/topics/Selecting-Options.md @@ -1,34 +1,35 @@ # Selecting Options -Before you can properly access the website, you will need to **use the left-hand sidebar** to +Before you can properly access the website, you will need to **use the left-hand sidebar** to select: + 1. A site 2. A plot 3. A census (if you need to start a new census, click on the Add New Census button!) -Once you select all of these, you will be redirected to the dashboard page, and a new interface +Once you select all of these, you will be redirected to the dashboard page, and a new interface will appear. ## Understanding Sites, Plots, and Census ### What is a site? -A site describes an overall collection of plots in the same geographic location, and further sets +A site describes an overall collection of plots in the same geographic location, and further sets a series of default parameters for the plots in that site: -- Subquadrat dimensions—sites are subdivided as follows: a site is a collection of plots, and a +- Subquadrat dimensions—sites are subdivided as follows: a site is a collection of plots, and a plot is a collection of **quadrats** -- Double data entry—sites can be set to require double data entry. When this is enabled, - measurements must be recorded **twice** for each **quadrat**, and will be held in temporary - storage until an administrator reviews both sets of data and approves a single merged set. +- Double data entry—sites can be set to require double data entry. When this is enabled, + measurements must be recorded **twice** for each **quadrat**, and will be held in temporary + storage until an administrator reviews both sets of data and approves a single merged set. ### What is a plot? -A plot describes a specific region within a site being sampled, and is used to further -determine the overall coordinates of sampled stems within the plot. +A plot describes a specific region within a site being sampled, and is used to further +determine the overall coordinates of sampled stems within the plot. ### What is a census? -A census describes a date range for which sampled data is collected. This date range can vary -and is not a fixed interval. It is defined by the first and last measurements taken -during the sampling range. \ No newline at end of file +A census describes a date range for which sampled data is collected. This date range can vary +and is not a fixed interval. It is defined by the first and last measurements taken +during the sampling range. diff --git a/frontend/documentation/topics/Submitting-Data.md b/frontend/documentation/topics/Submitting-Data.md index 98e4780e..f78e7d8b 100644 --- a/frontend/documentation/topics/Submitting-Data.md +++ b/frontend/documentation/topics/Submitting-Data.md @@ -1,52 +1,54 @@ # Data Submission and Updating -There are several different ways you can add data to a census, and some data does overlap across -censuses. +There are several different ways you can add data to a census, and some data does overlap across +censuses. ## Adding Supporting Data ### Direct submission -Let's use the stem codes page as an example: -1. When you navigate to its data grid, you will see an **add row** button at the top of the grid. +Let's use the stem codes page as an example: + +1. When you navigate to its data grid, you will see an **add row** button at the top of the grid. 2. Clicking on it will generate a **single** empty row that can then be populated. -3. Once completed, click the save button to confirm and then submit your changes. -4. The grid will reload and you should see your new row. +3. Once completed, click the save button to confirm and then submit your changes. +4. The grid will reload and you should see your new row. ### Bulk submission Again, let's use the stem codes page as an example: + 1. Click on the **Manual Entry Form** button to open the bulk data input interface 2. This will open a popup with a new grid, with buttons to add new rows, save, and submit. 3. Add rows as needed and ensure that you save your changes before submitting. - 1. Note: Bulk data input follows the same header format as file upload. Please ensure you + 1. Note: Bulk data input follows the same header format as file upload. Please ensure you correctly enter your data. 4. The grid will reload and you should see your new rows. ### File upload Again, let's use the stem codes page as an example: + 1. Click on the **Upload** button to open the file upload interface -2. Follow the prompts to upload, review, and submit your file. - 1. Note: your file should be in CSV format and correctly match the header format outlined in - the first page of the interface. -3. After the upload completes, you should see your new rows in the grid. +2. Follow the prompts to upload, review, and submit your file. + 1. Note: your file should be in CSV format and correctly match the header format outlined in + the first page of the interface. +3. After the upload completes, you should see your new rows in the grid. ### Editing Existing Data -If needed, you can edit existing data by clicking on the pencil icon at the end of a row. The -row will then switch to Edit mode, allowing you to make changes. Once completed, click the save +If needed, you can edit existing data by clicking on the pencil icon at the end of a row. The +row will then switch to Edit mode, allowing you to make changes. Once completed, click the save icon to confirm and then submit your changes. -> When in the View Data (measurements upload) page, you should notice that Actions column is not -> present. This is a +> When in the View Data (measurements upload) page, you should notice that Actions column is not +> present. This is a > deliberate choice to ensure that data is preserved as-is. ## Adding Measurements Data -Uploading measurements data follows the same process as uploading supporting data, with the -exception that Direct Submission and Editing are **disabled**. Furthermore, addition of new rows -will automatically run validation checks on the rows to ensure they are correct. Rows that pass -validation will be highlighted green and have a checkmark icon, while rows that fail validation +Uploading measurements data follows the same process as uploading supporting data, with the +exception that Direct Submission and Editing are **disabled**. Furthermore, addition of new rows +will automatically run validation checks on the rows to ensure they are correct. Rows that pass +validation will be highlighted green and have a checkmark icon, while rows that fail validation will be highlighted red and have an exclamation mark icon. - diff --git a/frontend/documentation/topics/Understanding-Supporting-Data.md b/frontend/documentation/topics/Understanding-Supporting-Data.md index da1b2112..3955c8c9 100644 --- a/frontend/documentation/topics/Understanding-Supporting-Data.md +++ b/frontend/documentation/topics/Understanding-Supporting-Data.md @@ -1,12 +1,13 @@ # Understanding Supporting Data -Supporting data is descriptive information that needs to be added before you can submit any -measurements. +Supporting data is descriptive information that needs to be added before you can submit any +measurements. ## What is Supporting Data? -There are four types of supporting data that are **required** before any measurements can be +There are four types of supporting data that are **required** before any measurements can be submitted: + 1. Stem Codes 2. Personnel 3. Quadrats @@ -15,6 +16,7 @@ submitted: ### Stem Codes These are attributes that can be assigned to a stem, and are subdivided into seven **statuses**: + - alive - alive-not measured - dead @@ -23,23 +25,23 @@ These are attributes that can be assigned to a stem, and are subdivided into sev - omitted - missing -When you add a new stem code, you must specify a **unique** code, a description of the attribute -being represented, and a status from the aforementioned list. +When you add a new stem code, you must specify a **unique** code, a description of the attribute +being represented, and a status from the aforementioned list. ### Personnel (and Roles) -Personnel are the people who are involved in the collection of data. They are assigned by census -and can be assigned a role depending on their involvement. If their role is not present, you can -create it by clicking ont the **Roles** button, which will open a popup with a new table. +Personnel are the people who are involved in the collection of data. They are assigned by census +and can be assigned a role depending on their involvement. If their role is not present, you can +create it by clicking ont the **Roles** button, which will open a popup with a new table. ### Quadrats -Quadrats are the smallest **recorded** region of measurement in a plot. They record starting +Quadrats are the smallest **recorded** region of measurement in a plot. They record starting coordinates (and their units of measure), their dimensions (and their units of measure), their area (and its units of measure), and their rough shape (square, rectangular, circular, etc.) ### Species -The taxonomic information for the stems being measured. This can range from as broad as the -family designation, or as specific as the subspecies designation. However, at a minimum, the -species must be specified. \ No newline at end of file +The taxonomic information for the stems being measured. This can range from as broad as the +family designation, or as specific as the subspecies designation. However, at a minimum, the +species must be specified. diff --git a/frontend/package-lock.json b/frontend/package-lock.json index 97bb6c2a..c4612f89 100644 --- a/frontend/package-lock.json +++ b/frontend/package-lock.json @@ -3749,15 +3749,6 @@ "url": "https://opencollective.com/unified" } }, - "node_modules/duplexer2/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/min-indent": { "version": "1.0.1", "resolved": "https://registry.npmjs.org/min-indent/-/min-indent-1.0.1.tgz", @@ -5520,17 +5511,6 @@ "eslint": "^3.0.0 || ^4.0.0 || ^5.0.0 || ^6.0.0 || ^7.0.0 || ^8.0.0-0" } }, - "node_modules/webpack/node_modules/estraverse": { - "version": "4.3.0", - "resolved": "https://registry.npmjs.org/estraverse/-/estraverse-4.3.0.tgz", - "integrity": "sha512-39nnKffWz8xN1BU/2c79n9nB9HDzo0niYUqx6xyqUnyoAnQyyWpOTdZEeiCch8BBu515t4wp9ZmgVfVhn9EBpw==", - "dev": true, - "license": "BSD-2-Clause", - "peer": true, - "engines": { - "node": ">=4.0" - } - }, "node_modules/space-separated-tokens": { "version": "2.0.2", "resolved": "https://registry.npmjs.org/space-separated-tokens/-/space-separated-tokens-2.0.2.tgz", @@ -6082,15 +6062,6 @@ "stylis": "4.2.0" } }, - "node_modules/jszip/node_modules/string_decoder": { - "version": "1.1.1", - "resolved": "https://registry.npmjs.org/string_decoder/-/string_decoder-1.1.1.tgz", - "integrity": "sha512-n/ShnvDi6FHbbVfviro+WojiFzv+s8MPMHBczVePfUpDJLwoLT0ht1l4YwBCbi8pJAveEEdnkHyPyTP/mzRfwg==", - "license": "MIT", - "dependencies": { - "safe-buffer": "~5.1.0" - } - }, "node_modules/@mui/x-data-grid": { "version": "7.22.1", "resolved": "https://registry.npmjs.org/@mui/x-data-grid/-/x-data-grid-7.22.1.tgz", @@ -6291,16 +6262,6 @@ "node": "^10.12.0 || >=12.0.0" } }, - "node_modules/eslint-plugin-react/node_modules/brace-expansion": { - "version": "1.1.11", - "resolved": "https://registry.npmjs.org/brace-expansion/-/brace-expansion-1.1.11.tgz", - "integrity": "sha512-iCuPHDFgrHX7H2vEI/5xpz07zSHB00TpugqhmYtVmMO6518mCuRMoOYFldEBl0g187ufozdaHgWKcYFb61qGiA==", - "license": "MIT", - "dependencies": { - "balanced-match": "^1.0.0", - "concat-map": "0.0.1" - } - }, "node_modules/https-proxy-agent": { "version": "7.0.5", "resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-7.0.5.tgz",