Skip to content

Commit

Permalink
Merge branch 'dev' into getFeatures-and-friends
Browse files Browse the repository at this point in the history
  • Loading branch information
twelch committed Dec 11, 2024
2 parents e65bb57 + 8cb2389 commit b10e738
Show file tree
Hide file tree
Showing 7 changed files with 40 additions and 23 deletions.
18 changes: 10 additions & 8 deletions website/docs/tutorials/Tutorials.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,20 +60,22 @@ Now start the devcontainer:

![Manage Devcontainers](assets/devcontainer-blue.jpg "Manage Devcontainers")

You now have a devcontainer, ready to create a project in.

To exit your devcontainer:
You now have a running devcontainer, ready to create a project in. To exit your devcontainer:

- Click the blue icon in the bottom left, and then `Reopen locally`. This will bring VSCode back out of the devcontainer session.
- You can also type `Ctrl-Shift-P` or `Cmd-Shift-P` and select `Dev Containers: Reopen folder locally`.

![Manage Devcontainers](assets/ManageDevcontainers.jpg "Manage Devcontainers")

- To update to the latest `geoprocessing-workspace` Docker image at any point you simply use a different VSCode command to start it:
- `Ctrl-Shift-P` or `Cmd-Shift-P` to open the VSCode command palette
- type "Dev Containers: Rebuild Without Cache and Reopen In Container"
If you get an error in red, as your devcontainer tries to start, choose the option to "reopen locally" and you will be presented with a log file that should contain the relevant error buried within it.

![Devcontainer error](assets/devcontainer-error.png "Decontainer error")

In most cases, the issue is that you did not create your .env properly. Revisit the instructions above as necessary.

To update to the latest `geoprocessing-workspace` Docker image in the future use the [upgrade](./upgrade.md#upgrade-devcontainer) tutorial.

See devcontainer advanced usage [guide](../devcontainer/devcontainer.md) to learn more or the [upgrade](../upgrade.md) tutorial
- To learn more about devcontainers visit the [devcontainer](../devcontainer/devcontainer.md) guide.

## Windows WSL Install

Expand Down Expand Up @@ -160,7 +162,7 @@ ls /mnt/c

Follow the [final configuration steps](#final-configuration---all-install-options) below, then move on to creating a new project.

[Upgrade](../upgrade.md#upgrade-windows-geoprocessing) steps for the Geoprocessing Distribution are available.
[Upgrade](./upgrade.md#upgrade-windows-geoprocessing) steps for the Geoprocessing Distribution are available.

### Default Ubuntu Distribution

Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion website/docs/tutorials/newproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Start with initializing a new project:

```sh
cd /workspaces
npx @seasketch/[email protected]experimental-7x-docs.132 init 7.0.0-experimental-7x-docs.132
npx @seasketch/[email protected]beta.10 init 7.0.0-beta.10
```

Tips:
Expand Down
2 changes: 1 addition & 1 deletion website/docs/tutorials/sampleproject.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ Start the project `init` process, which will download the framework, and collect

```sh
cd /workspaces
npx @seasketch/[email protected]experimental-7x-docs.132 init 7.0.0-experimental-7x-docs.132
npx @seasketch/[email protected]beta.10 init 7.0.0-beta.10
```

```text
Expand Down
39 changes: 27 additions & 12 deletions website/docs/tutorials/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,23 +76,38 @@ You should now be able to start a Docker container shell using the latest image
```bash
sudo docker run -it --entrypoint /bin/bash seasketch/geoprocessing-workspace

(base) vscode ➜ / $ node -v
v20.12.1
(base) vscode ➜ / $ npm -v
10.5.0
(base) vscode ➜ / $ gdalinfo --version
GDAL 3.8.5, released 2024/04/02
node -v
npm -v
gdalinfo --version
```

Exit back out of this shell when done
Exit back out of this shell when done.

The latest version of the `geoprocessing-workspace` will only work with geoprocessing 7.x projects. This is due to a change in how GDAL produces flatgeobuf files. If you suddenly see errors of `"Not a FlatGeobuf file"` when trying to read your file, this is likely the reason. In order to continue to develop older 6.x and lower geoprocessing projects you will need to start your devcontainer using the `local-dev-pre-7x` environment. This is pinned to an older version of the docker image - `seasketch/geoprocessing-workspace:sha-69bb889`
When restarting your VSCode devcontainer for the first time, you may want to use this VSCode command to ensure your new container image is used:

```text
Cmd-Shift-P (MacOS) or Ctrl-Shift-P (Windows) to open command palette
Dev Containers: Rebuild Without Cache and Reopen In Container
```

If you're maintaining your own development environment then you should look to have at least the following versions at minimum:
![Simple Card View](./assets/rebuild-without-cache.jpg)

- Node 20.12.1
- NPM 10.5.0
- GDAL 3.5.0
### Unstable Testing

If you are testing out a new `unstable` image you will need to pull using that tag instead:

```bash
docker pull seasketch/geoprocessing-workspace:unstable
```

Then, when restarting your VSCode devcontainer, choose the `unstable` version.

If you get an error when starting unstable, make sure that you have a .env file in your `local-dev-unstable` directory. You need to have one there, just as in the top-level stable devcontainer directory.

### When Using Geoprocessing Less Than 7.0

The latest version of the `geoprocessing-workspace` will only work with geoprocessing 7.x projects. This is due to a change in how GDAL produces flatgeobuf files. If you suddenly see errors of `"Not a FlatGeobuf file"` when trying to read your file, this is likely the reason. In order to continue to develop older 6.x and lower geoprocessing projects you will need to start your devcontainer using the `local-dev-pre-7x` environment. This is pinned to an older version of the docker image - `seasketch/geoprocessing-workspace:sha-69bb889`

### Upgrade Windows Geoprocessing

Expand Down
2 changes: 1 addition & 1 deletion website/sidebars.ts
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ const sidebars: SidebarsConfig = {
},
{
type: "doc",
id: "upgrade",
id: "tutorials/upgrade",
label: "Upgrade Project",
},
{
Expand Down

0 comments on commit b10e738

Please sign in to comment.