Skip to content

Commit

Permalink
broken link fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
twelch committed Dec 5, 2024
1 parent b87c710 commit 631641e
Show file tree
Hide file tree
Showing 9 changed files with 23 additions and 18 deletions.
2 changes: 1 addition & 1 deletion website/docs/architecture/Architecture.md
Original file line number Diff line number Diff line change
Expand Up @@ -381,6 +381,6 @@ These 2 execution modes create 4 different request scenarios. A lambda is create
- determining whether sketches within a collection overlap with each other and remove the overlap ensuring there is no double counting.
- assessing the protection level of each sketch and calculating metrics by protection level. Overlap of sketches within each protection level can also be removed ensuring there is not double counting.

The result can take any form but typically are [metrics](../concepts/AdvancedConcepts.md#metrics)).
The result can take any form but typically are [metrics](../concepts/Concepts.md#metrics)).

[Boundary overlap example](https://github.com/seasketch/fsm-reports/blob/main/src/functions/boundaryAreaOverlap.ts#L23)
2 changes: 1 addition & 1 deletion website/docs/geoprocessing.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ const protectionLevels = sketchFeatures.reduce<Record<string, number>>(
);
```
The key part of most geoprocessing functions is to take the parameters you've collected, use a pre-defined MetricGroup to retrieve and load datasources, then finally run the an analysis function to produce [Metrics](./concepts/AdvancedConcepts.md#metrics), append additional IDs to those metrics (class, geography, etc.) so that it's explicitly clear what the value represents, and merge those metrics into a single result.
The key part of most geoprocessing functions is to take the parameters you've collected, use a pre-defined MetricGroup to retrieve and load datasources, then finally run the an analysis function to produce [Metrics](./concepts/Concepts.md#metrics), append additional IDs to those metrics (class, geography, etc.) so that it's explicitly clear what the value represents, and merge those metrics into a single result.
```typescript
const metrics: Metric[] = (
Expand Down
9 changes: 6 additions & 3 deletions website/docs/gip/GIP-1-i18n.md
Original file line number Diff line number Diff line change
Expand Up @@ -188,13 +188,16 @@ When you `init` a new project it will automatically install the `src/i18n` direc
- Add credentials to your `.bashrc` file

```bash
nano ~/.bashrc

export POEDITOR_PROJECT=[YOUR_PROJECT_ID_NUMBER]
export POEDITOR_API_TOKEN=[YOUR_API_TOKEN]
```

[How do I do that?](../skills.md#editing-your-startup-bash-script-in-ubuntu)
Ctrl-O to save
Ctrl-X to exit
```

Now, verify the environment variables are set
Now source the changes into to your current shell and verify the environment variables are set

```bash
source ~/.bashrc
Expand Down
2 changes: 1 addition & 1 deletion website/docs/linkData.md
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,7 @@ Cons:

Steps:

- First, if you use a Cloud Drive product to share and sync data files, make sure your data is synced and you know the path to access it. See [access Cloud Drive folder](./skills.md#access-cloud-drive-folder)
- First, if you use a Cloud Drive product to share and sync data files, make sure your data is synced and you know the path to access it. See [access Cloud Drive folder](./tutorials/clouddrive.md)
- Assuming you are using MacOS and your username is `alex`, your path would be `/Users/alex/Library/CloudStorage/Box-Box`

To create the symbolic link, open a terminal and make sure you are in the top-level directory of your geoprocessing project:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/multiBoundary/multiBoundary.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Some projects might need to support multiple sets of planning units within a lar

So seports might be required to calculate how well each Sketch/Sketch Collection meets planning objectives for **each of the planning units** as well as the overall planning boundary. If a % value metric is to be calculated (value in sketch / value overall), this requires calculating what portion of each Sketch is in each unit as well as how much value for each datasource is in each unit.

The geoprocessing framework solves all of these use cases using [geographies](../concepts/AdvancedConcepts.md#geographies), and the helper functions for working with them.
The geoprocessing framework solves all of these use cases using [geographies](../concepts/Concepts.md#geographies), and the helper functions for working with them.

If the user will be presented with metrics for all geographies at once, then you can [iterate over the geographies](https://github.com/seasketch/california-reports/blob/main/src/functions/eelgrass.ts#L44) in your geoprocessing function to calculate metrics and display them in your report client.

Expand Down
8 changes: 4 additions & 4 deletions website/docs/structure.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,10 @@ There are a variety of project configuration files. Many have been pre-populated
- `externalLinks` - central store of links that you want to populate in your reports.
- `languages` - array of languages to enable for translation. Master list of language codes are in `src/i18n/languages.json`.
- `geoprocessing.json` - file used to register assets to be bundled for deployment. If they aren't registered here, then they won't be included in the bundle.
- `geographies.json` - contains one or more planning geographies for your project. If you chose to start with a blank project template, you will have a default geography of the entire world. If you chose to start with the Ocean EEZ template, you will have a default geography that is the EEZ you chose at creation time. Geographies must be manually added/edited in this file. You will then want to re-run `precalc` and `test` to process the changes and make sure they are working as expected. Learn more about [geographies](./concepts/AdvancedConcepts.md#geographies)
- `datasources.json` - contains an array of one or more registered datasources, which can be global (url) or local (file path), with a format of vector or raster or subdivided. Global datasources can be manually added/edited in this file, but local datasources should use the [import](./dataimport.md) process. After import, datasources can be manually added/edited in this file. You will then want to run `reimport:data`, `precalc:data`, `precalc:clean`, and `test` to process the changes and make sure they are working as expected. Learn more about [datasources](./concepts/AdvancedConcepts.md#datasources)
- `metrics.json` - contains an array of one or more metric groups. Each group defines a metric to calculate, with one or more data classes, derived from one or more datasources, measuring progress towards a planning objective. An initial boundaryAreaOverlap metric group is included in the file by default that uses the global eez datasource. Learn more about [metrics](./concepts/AdvancedConcepts.md#metrics)
- `objectives.json` - contains an array of one or more objectives for your planning process. A default objective is included for protection of `20%` of the EEZ. Objectives must be manually added/edited in this file. Learn more about [objectives](./concepts/AdvancedConcepts.md#objectives)
- `geographies.json` - contains one or more planning geographies for your project. If you chose to start with a blank project template, you will have a default geography of the entire world. If you chose to start with the Ocean EEZ template, you will have a default geography that is the EEZ you chose at creation time. Geographies must be manually added/edited in this file. You will then want to re-run `precalc` and `test` to process the changes and make sure they are working as expected. Learn more about [geographies](./concepts/Concepts.md#geographies)
- `datasources.json` - contains an array of one or more registered datasources, which can be global (url) or local (file path), with a format of vector or raster or subdivided. Global datasources can be manually added/edited in this file, but local datasources should use the [import](./dataimport.md) process. After import, datasources can be manually added/edited in this file. You will then want to run `reimport:data`, `precalc:data`, `precalc:clean`, and `test` to process the changes and make sure they are working as expected. Learn more about [datasources](./concepts/Concepts.md#datasources)
- `metrics.json` - contains an array of one or more metric groups. Each group defines a metric to calculate, with one or more data classes, derived from one or more datasources, measuring progress towards a planning objective. An initial boundaryAreaOverlap metric group is included in the file by default that uses the global eez datasource. Learn more about [metrics](./concepts/Concepts.md#metrics)
- `objectives.json` - contains an array of one or more objectives for your planning process. A default objective is included for protection of `20%` of the EEZ. Objectives must be manually added/edited in this file. Learn more about [objectives](./concepts/Concepts.md#objectives)
- `precalc.json` - contains precalculated metrics for combinations of geographies and datasources. Specifically it calculates for example the total area/count/sum of the portion of a datasources features that overlap with each geography. This file should not be manually edited. If you have custome metrics/precalculations to do, then use a separate file. Learn more about the [precalc](./precalc.md) command.

The object structure in many of the JSON files, particularly the `project` folder, follow strict naming and structure (schema) that must be maintained or you will get validation errors when running commands. Adding additional undocumented properties may be possible, but is not tested. The schemas are defined here:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/tutorials/Tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

import { NodeVersion, UbuntuVersion } from '../\_components/NodeVersion';

These tutorials will walk you through creating and deploying a basic seasketch `geoprocessing` project. You should already have a basic working knowledge of your computer, its operating system, shell environment (command line), and web application development using NodeJS and React. Learn more about the [skills](../skills.md) required.
These tutorials will walk you through creating and deploying a basic seasketch `geoprocessing` project. You should already have a basic working knowledge of your computer, its operating system, shell environment (command line), and web application development using NodeJS and React. Learn more about the [skills](../introduction.md) required.

Setup options:

Expand Down
8 changes: 5 additions & 3 deletions website/docs/tutorials/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,13 +42,15 @@ Now, open a Ubuntu shell and edit your bash environment variables to [point to t
Add the following to your startup `.bashrc` file.

```bash
nano ~/.bashrc
export AWS_SHARED_CREDENTIALS_FILE=/mnt/c/Users/alex/.aws/credentials
export AWS_CONFIG_FILE=/mnt/c/Users/alex/.aws/config
```

[How do I do that?](../skills.md#editing-your-startup-bash-script-in-ubuntu)
Ctrl-o to save
Ctrl-x to exit
```

Now, verify the environment variables are set
Now, source the file into your current shell environment and verify the environment variables are set

```bash
source ~/.bashrc
Expand Down
6 changes: 3 additions & 3 deletions website/docs/tutorials/sampleproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -642,7 +642,7 @@ The import process will:
- quickly access project datasources in your reports using the `projectClient` (more on this later)
- quickly reimport datasources using the `reimport:data` command, without having to answer questions again.

Once finished you are ready to use your datasources for `local` report development. You can add, edit, or delete records in datasources.json manually to meet your need as long as the records meet the expected [schema](../concepts/AdvancedConcepts.md#datasources).
Once finished you are ready to use your datasources for `local` report development. You can add, edit, or delete records in datasources.json manually to meet your need as long as the records meet the expected [schema](../concepts/Concepts.md#datasources).

If at any point the process of using `data:import`, `datasources.json`, and `projectClient` doesn't meet your needs, you are welcome to create your own separate process, as long as it gets datasources to the `data/dist` directory in the format (fgb) and projection required (EPSG 4326 for vector, EPSG 6933 for raster), ready to be published for production use.

Expand Down Expand Up @@ -1238,7 +1238,7 @@ Add the following metric group object to `project/metrics.json` and save the fil
This defines a `benthicHabitat` metric that sources data from the `benthic` datasource. The `classKey` indicates this datasource has an attribute named `class` used to identify which data class each polygon is a member of. 3 data classes are defined with a `classId` serving as the unique identifier for the data class, and it also matches the value used in the data at the `classKey` attribute.
To learn more about metric groups, visit the [advanced concepts](../concepts/AdvancedConcepts.md#metric-group) page.
To learn more about metric groups, visit the [advanced concepts](../concepts/Concepts.md#metric-group) page.
### Create Report
Expand Down Expand Up @@ -1579,7 +1579,7 @@ You might have noticed in the precalculated metrics that they are assigned a geo
The default Geography for a new project is the `world` geography, which establishes the entire world as your planning boundary. This is sufficient for your needs until you have a more specific planning boundary that you want to work with. For example you can clip your sketches and your data to a geography in order to report metrics for a specific geography. Since your data is already pre-clipped to the planning area, and there is only one planning area, you don't need to do anything more with this feature. You can just leave it to use the `world` geography.
Geographies are defined in `project/geographies.json`. To learn more visit the [advanced concepts](../concepts/AdvancedConcepts.md#geographies) page.
Geographies are defined in `project/geographies.json`. To learn more visit the [advanced concepts](../concepts/Concepts.md#geographies) page.
### View Reports
Expand Down

0 comments on commit 631641e

Please sign in to comment.