Rename & restructure repo for forklift v0.3.0; fix license SPDX for GPL

README.md

@@ -1,28 +1,35 @@
-# pallets
-Forklift package repositories for the PlanktoScope software distro
+# device-pkgs
+Forklift packages for the PlanktoScope software distro
 
 ## Introduction
 
-Pallets are simple platforms, usually wooden, which enable moving stacks of packages safely and easily:
-
-![Photograph of a worker operating a forklift to move a stack of cardboard boxes on a wooden pallet](https://cdn2.picryl.com/photo/2020/04/27/a-worker-moves-a-pallet-of-personal-protective-equipment-da8b5e-1600.jpg)
-
-This repository provides a collection of software packages in [*Forklift*](https://github.com/PlanktoScope/forklift), a software packaging system for enabling safe, simple, and easy software installations and upgrades on PlanktoScopes. Specifically, this Github repository is a collection of four Forklift pallets of software packages for Planktoscopes - `core`, `community`, `restricted`, `testing` - which serve different purposes and have different types of software packages. Each pallet has a `README.md` file which describes its purpose. Packages in the `core`, `community`, and `restricted` repositories are configured to be deployed as integrated components of the overall PlanktoScope software distro.
+This repository provides a collection of [*Forklift*](https://github.com/PlanktoScope/forklift)
+software packages for the PlanktoScope's software distro. Specifically, this repository consists of
+four categories of software packages for Planktoscopes - `core`, `community`, `restricted`,
+`testing` - which serve different purposes and have different types of software packages. Each
+category of packages has its own subdirectory with a `README.md` file which describes its purpose.
+Packages in this repository are configured to be deployed as integrated components of the overall
+PlanktoScope software distro.
 
 ## Usage
 
-Refer to the README for [Forklift](https://github.com/PlanktoScope/forklift) for usage instructions. This repository provides the following pallets:
-- `github.com/PlanktoScope/pallets/core`
-- `github.com/PlanktoScope/pallets/community`
-- `github.com/PlanktoScope/pallets/restricted`
-- `github.com/PlanktoScope/pallets/testing`
+Refer to the README for [Forklift](https://github.com/PlanktoScope/forklift) for usage instructions.
 
 ## Licensing
 
-The Forklift packages provided by these pallets have their own software licenses, as specified by SPDX short form identifiers (e.g. "Apache-2.0") in the packages' corresponding `forklift-package.yml` metadata files and/or LICENSE files provided in the package directories. Any other source code provided here is covered by the following information, except where otherwise indicated:
+The Forklift packages provided by these pallets have their own software licenses, as specified by
+SPDX short form identifiers (e.g. "Apache-2.0") in the packages' corresponding
+`forklift-package.yml` metadata files and/or by LICENSE files provided in the package directories.
+Any other source code provided here is covered by the following information, except where otherwise
+indicated:
 
 Copyright Ethan Li and PlanktoScope project contributors
 
 SPDX-License-Identifier: Apache-2.0 OR BlueOak-1.0.0
 
-You can use the source code provided here either under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0) or under the [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0); you get to decide. We are making the software available under the Apache license because it's [OSI-approved](https://writing.kemitchell.com/2019/05/05/Rely-on-OSI.html), but we like the Blue Oak Model License more because it's easier to read and understand.
+You can use the source code provided here either under the
+[Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0)
+or under the [Blue Oak Model License 1.0.0](https://blueoakcouncil.org/license/1.0.0);
+you get to decide. We are making the software available under the Apache license because it's
+[OSI-approved](https://writing.kemitchell.com/2019/05/05/Rely-on-OSI.html),
+but we like the Blue Oak Model License more because it's easier to read and understand.

community/README.md

@@ -1,7 +1,7 @@
 # community
 Community-maintained open-source PlanktoScope packages
 
-This repository contains packages which are maintained by users from the community working with the
+This directory contains packages which are maintained by users from the community working with the
 PlanktoScope core team and which are available under
 [OSI-approved](https://opensource.org/licenses/) open-source licenses. These packages are supported
 by contributions from users, and they could end if their maintainers stop supporting them. They may

core/README.md

@@ -1,7 +1,7 @@
 # core
 Officially-maintained open-source PlanktoScope packages
 
-This repository contains packages which are essential to the PlanktoScope software distro and are
+This directory contains packages which are essential to the PlanktoScope software distro and are
 available under [OSI-approved](https://opensource.org/licenses/) open-source licenses. These
 packages have official special documentation, direct support, and updates from the PlanktoScope core
 team.

core/apps/README.md

@@ -0,0 +1,5 @@
+# core/apps
+Application software for PlanktoScope devices
+
+This directory contains high-level software applications (backend & frontends) which collectively
+provide the user-facing functionality of each PlanktoScope device.

core/apps/planktoscope-controller/forklift-package.yml

@@ -3,9 +3,9 @@ package:
   maintainers:
     - name: Ethan Li
       email: lietk12@gmail.com
-  license: GPL-3.0
+  license: GPL-3.0-or-later
   sources:
-    - https://github.com/PlanktoScope/PlanktoScope
+    - https://github.com/PlanktoScope/device-backend
 
 host:
   tags:

core/apps/planktoscope-docs/docker-compose.yml

@@ -1,6 +1,6 @@
 services:
   server:
-    image: ghcr.io/planktoscope/project-docs:sha-2fe6719
+    image: ghcr.io/planktoscope/project-docs:2023.9.0-alpha.1
     volumes:
       - server_data:/data
       - server_config:/config

core/apps/planktoscope-node-red-dashboard/forklift-package.yml

@@ -3,7 +3,7 @@ package:
   maintainers:
     - name: Ethan Li
       email: lietk12@gmail.com
-  license: GPL-3.0
+  license: GPL-3.0-or-later
   sources:
     - https://github.com/PlanktoScope/PlanktoScope
 

core/apps/planktoscope-processing-segmenter/forklift-package.yml

@@ -3,9 +3,9 @@ package:
   maintainers:
     - name: Ethan Li
       email: lietk12@gmail.com
-  license: GPL-3.0
+  license: GPL-3.0-or-later
   sources:
-    - https://github.com/PlanktoScope/PlanktoScope
+    - https://github.com/PlanktoScope/device-backend
 
 host:
   tags:

core/host/README.md

@@ -0,0 +1,5 @@
+# core/host
+PlanktoScope host environment descriptions
+
+This directory contains descriptions of resources ambiently provided by the PlanktoScope's base
+operating system, independently of any package deployments.

core/infra/README.md

@@ -0,0 +1,4 @@
+# core/infra
+Core software infrastructure on PlanktoScope devices
+
+This directory contains low-level software systems enabling usage of other PlanktoScope software.

forklift-repository.yml

@@ -0,0 +1,4 @@
+repository:
+  path: github.com/PlanktoScope/device-pkgs
+  description: Forklift packages for the PlanktoScope software distribution
+  readme-file: README.md

restricted/README.md

@@ -1,7 +1,7 @@
 # restricted
 License-restricted PlanktoScope packages
 
-This repository contains packages which are only available under licenses not
+This directory contains packages which are only available under licenses not
 [approved by the OSI](https://opensource.org/licenses/); some licenses may include restrictions on
 how the software may be used, for example restrictions on governmental uses, commercial uses, or
 unethical uses of the software. None of these packages are necessary for operating PlanktoScopes.

testing/README.md

@@ -1,6 +1,6 @@
 # testing
 Unstable PlanktoScope packages for testing
 
-This repository contains new packages made by any contributor, purely for software testing purposes.
+This directory contains new packages made by any contributor, purely for software testing purposes.
 Packages here may appear or disappear at any time, and will break without warning. None of these
 packages should be used in production deployments of PlanktoScopes for collecting scientific data.