Commit Graph

204 Commits

Author SHA1 Message Date
Michael Stenta d38a5eb1d9 Split farm_migrate_user and farm_migrate_role out to their own migration groups.
This allows contrib modules to provide their own role migrations by replicating the farm_migrate_role config.
2021-02-25 12:58:32 -05:00
Michael Stenta 704791b6ef Add farm_migrate_plan group to migration instructions. 2021-02-23 08:59:07 -05:00
Michael Stenta c7244a0013 Document quantity API changes. 2021-02-05 12:23:20 -05:00
Michael Stenta 6010d3af8f Create a dedicated migration for Quantities. 2021-02-05 12:23:20 -05:00
Michael Stenta 6681a34dcd Rename farm_quantity to quantity. 2021-02-05 12:23:20 -05:00
paul121 94fb34da6d Start documenting quantity api changes. 2021-02-05 12:23:20 -05:00
Michael Stenta a8c9af5ee9 Document areas/locations API changes. 2021-02-04 17:14:30 -05:00
Symbioquine 938d80101c Use a test matrix to run tests and site-install against MariaDB/SQLite/Postgres in parallel
**Why?** Detect if things break on specific DBMS' and have ongoing proof
that the top DB options work with farmOS.
2021-01-18 14:31:39 -05:00
Michael Stenta ef96f35b5e Run all PHPUnit tests in the /opt/drupal/web/profiles/farm directory, instead of using --group farm.
The --group flag fails with a fatal error if there are any tests (even
not in the requested group) that extend from a PHP class that
doesn't exist. This is true for some modules like fraction and
email_registration which have tests that extend from tests in
other modules that we do not include in our composer.json.
2021-01-08 06:40:09 -05:00
Michael Stenta 6a7d5bc7b5 Explain that migrations are designed to be run on empty 2.x database. 2021-01-06 05:58:06 -05:00
Michael Stenta 1512f69893 Update 2.x API changes doc with plant_type. 2021-01-05 15:12:25 -05:00
Michael Stenta 0772ec163c Alphabetize 2.x asset field changes summary. 2021-01-05 15:08:28 -05:00
paul121 5c746a8454 Document changes to plant type taxonomies. 2021-01-04 09:07:02 -05:00
paul121 dd9e89ecf4 Document the changed farm_animal_types vocabulary name. 2021-01-04 08:28:48 -05:00
Michael Stenta 74fc7965c9 Issue #3189740: Cannot rollback farm_migrate_reference group migrations - add a note to migration docs. 2021-01-04 06:26:43 -05:00
Michael Stenta c1f7760001 Rename animal asset castrated field to is_castrated. 2020-12-29 12:27:35 -05:00
Michael Stenta d9bea90c25 Save warning messages when movement areas/geometry are overwritten. 2020-12-29 12:15:28 -05:00
Michael Stenta 342e0d8935 Allow movement log area/geometry data to be discarded via settings.php. 2020-12-29 06:55:38 -05:00
Michael Stenta 5ed78d6d68 Add some tips for migration troubleshooting. 2020-12-29 06:55:38 -05:00
Michael Stenta 70b5ce06ce Migrate Area terms to Land/Structure/Water assets using a custom d7_farm_area source plugin that extends from d7_taxonomy_term. 2020-12-29 06:55:38 -05:00
Michael Stenta 0678c2a541 Add a "Structure type" field to Structure assets, with allowed values defined by structure_type config entities. 2020-12-29 06:55:37 -05:00
Michael Stenta b096298066 Add a "Land type" field to Land assets, with allowed values defined by land_type config entities. 2020-12-29 06:55:37 -05:00
Michael Stenta 00d1786ccf Rename farm_field to farm_entity. 2020-12-14 10:07:58 -05:00
Michael Stenta 28ee05b41a Add FarmAssetType, FarmLogType, and FarmPlanType entity bundle plugin base classes. 2020-12-14 10:07:58 -05:00
Michael Stenta 6d1bce37bc Issue #3188055: Provide a hook for adding bundle fields 2020-12-14 10:07:58 -05:00
Michael Stenta 53556083bf Document adding new bundles and fields. 2020-12-13 08:34:49 -05:00
Michael Stenta bd6faab922 Add support for log bundle plugins. 2020-12-13 08:34:49 -05:00
Michael Stenta c407ba941d Document module automated updates. 2020-12-12 07:16:41 -05:00
Michael Stenta 2c8a65b3d7 Remove "composer update" example from "Common tasks" and move the warning up higher. 2020-12-11 14:36:32 -05:00
Michael Stenta 8c88bb4ab3 Document module publishing recommendations and licensing requirements. 2020-12-11 14:35:40 -05:00
Michael Stenta cf1164a796 Add note about PHPStorm's .idea folder when updating local codebase. 2020-12-05 15:32:59 -05:00
Michael Stenta 739301f6e4 Document how to update a local environment. 2020-12-05 15:32:59 -05:00
Michael Stenta 9bb7d4f855 Update Dockerfile, docker-compose.development.yml, and docs for XDebug 3. 2020-12-04 14:24:12 -05:00
Michael Stenta 471d9e81b4 Separate filenames from example code. 2020-11-29 20:51:02 -05:00
Michael Stenta 2b7748cbdf Add docblock to permissions callback example. 2020-11-29 20:51:02 -05:00
Symbioquine 267ee07419 Document running tests without XDebug 2020-11-27 06:59:47 -05:00
Michael Stenta 0968e7b1b0 Remove sudo from docker command examples. 2020-11-25 06:24:21 -05:00
Michael Stenta 764f189f11 Add favicon.ico for docs. 2020-11-24 16:46:06 -05:00
Michael Stenta 978fd2d64b Use mkdocs-material theme. 2020-11-24 16:43:29 -05:00
Michael Stenta 5f49e10f2a Rearrange menu.
Move development/environment below development/module.
Move api under development.
Move hosting to the end.
2020-11-24 16:42:01 -05:00
Michael Stenta 19e76c41b8 Document how to get started with farmOS module development. 2020-11-23 20:58:35 -05:00
Michael Stenta 3f4687675a Document 2.x changes to Taxonomies. 2020-11-23 20:58:31 -05:00
paul121 72e4bdd639 Private file path must be an absolute path. 2020-11-20 22:37:07 -05:00
Symbioquine 2ce6c8eac0 Add instructions about how to update documentation to documentation 2020-11-12 20:14:57 -05:00
Michael Stenta 8a2a347dfb Document how to extend Flag, Lab test type, and ID tag type options via module. 2020-10-16 15:41:27 -04:00
Michael Stenta 26f6246ef9 Move farm_access to farm_role. 2020-10-16 13:33:14 -04:00
Michael Stenta 7042088706 Remove "Farm" from Manager, Worker, Viewer roles. 2020-10-15 22:25:39 -04:00
Michael Stenta 7416cb4c36 Minor roles doc tweaks and whitespace. 2020-10-15 22:25:39 -04:00
Michael Stenta cbae839dcd Replace farm_asset with asset. 2020-10-15 19:41:40 -04:00
Michael Stenta b710d14112 Replace "Farm Access module" with "farmOS Access module". 2020-10-15 19:41:40 -04:00
Michael Stenta 590cf92008 Move farm_access.md to roles.md and provide an intro paragraph. 2020-10-15 19:41:40 -04:00
paul121 1660e2af48 Start farm_access documentation. 2020-10-15 19:41:40 -04:00
Michael Stenta a7a9b8d259 Document that "animal_tag" changed to "id_tag" in the API. 2020-10-15 15:33:10 -04:00
paul121 c93e295927 Document farm.json to meta.farm changes. 2020-10-11 21:31:08 -04:00
paul121 ceb58dc295 Fix farmOS version typo. 2020-10-11 21:31:08 -04:00
paul121 0af9d9051b Start documenting the farm_api module. 2020-10-11 21:31:08 -04:00
paul121 5353d7febd Start documenting OAuth usage. 2020-10-11 21:31:08 -04:00
Michael Stenta 8b3e7ae099 Initial placeholder for OAuth documentation. 2020-10-11 21:31:08 -04:00
Michael Stenta cef9e3af41 Nest development docs into development/environment section. 2020-10-11 21:31:04 -04:00
Michael Stenta 2324192f61 Move migration docs to hosting section. 2020-10-11 21:31:00 -04:00
Michael Stenta 31875bf886 Document how to view migration status. 2020-10-11 17:32:58 -04:00
Michael Stenta f619dfb1c9 Create separate migration groups for assets, logs, and taxonomy terms with shared configuration. 2020-10-11 17:32:58 -04:00
Michael Stenta ff3837a78b Add "Birthdate" field to Animals (with migration). 2020-10-11 12:17:23 -04:00
Michael Stenta 53cc591d55 Add "Castrated" field to Animals (with migration). 2020-10-11 12:17:23 -04:00
Michael Stenta 8379dcef99 Add "Sex" field to Animals (with migration). 2020-10-11 12:17:23 -04:00
Michael Stenta b3b62bd29b Add "Nicknames" field to Animals (with migration). 2020-10-11 12:17:23 -04:00
Michael Stenta a382e2068f Migrations for public and private files. 2020-10-07 13:28:25 -04:00
Michael Stenta 47763df8b3 Add a "Default" text format that allows filtered HTML, automatic line breaks, and converts URLs to links. 2020-10-07 13:28:25 -04:00
Michael Stenta 4ecbcccc81 Add "Files" and "Images" fields to all asset types. 2020-10-01 23:45:45 -04:00
Michael Stenta efc3fb0781 Add "Notes" field to all asset types. 2020-10-01 23:45:45 -04:00
Michael Stenta 2488bff344 Add "Flags" field to all asset types. 2020-10-01 23:44:26 -04:00
Michael Stenta 0ba4788d19 Document API changes for assets. 2020-10-01 23:41:40 -04:00
Michael Stenta 9ce18c1991 Make API change doc headings more explicit. 2020-10-01 23:41:40 -04:00
Michael Stenta a2214760c8 Document debugging via PHPStorm. 2020-10-01 15:48:04 -04:00
Michael Stenta 1acac48892 Document limitations of the migration. 2020-09-30 15:45:16 -04:00
Michael Stenta cf8ae810e8 Document migration instructions. 2020-09-30 10:51:17 -04:00
Michael Stenta 3e2247b222 Describe how filtering differs in farmOS 2.x API. 2020-09-30 10:46:59 -04:00
Michael Stenta f8f074d02a Describe the new JSON:API record structure (attributes and relationships). 2020-09-30 10:46:59 -04:00
Michael Stenta 69bfecede3 Move JSON Schema section above Endpoints, and add note about the root endpoint. 2020-09-30 10:35:06 -04:00
Michael Stenta 4e8cae2a6d Put JSON Schema description in its own section, and mention farm.json resources. 2020-09-29 19:57:49 -04:00
Michael Stenta 72b8c42910 Split out intro to 2.x vs 1.x changes, to describe restws vs jsonapi separately from describing endpoints. 2020-09-29 19:25:24 -04:00
Michael Stenta 05198a047c Initial API 2.x changes documentation. 2020-09-27 11:21:51 -04:00
Michael Stenta 405054621b Initial API documentation. 2020-09-27 11:21:51 -04:00
Michael Stenta 59fb52471e Document PostgreSQL in the development environment. 2020-09-25 09:19:50 -04:00
Michael Stenta 8fd3a754f8 Move docs/development/notes.md to docs/development/docker.md. 2020-09-24 22:01:51 -04:00
Michael Stenta b7da8c287f Add "Configure debugger" to optional dev environment setup tasks. 2020-09-24 21:39:23 -04:00
Michael Stenta 23f873b765 Use the private file system by default. Document how to configure settings.php. 2020-09-24 21:38:20 -04:00
Michael Stenta ddeede7106 Change example composer command from `update` to `help`. 2020-08-23 18:07:45 -04:00
Michael Stenta beeb044cd0 Configure PHP CodeSniffer in Docker dev image and document usage. 2020-08-19 16:31:03 -04:00
Michael Stenta da2f87605c Add note about Composer "Could not delete ..." error and link to drupal.org docs. 2020-08-17 13:22:23 -04:00
Michael Stenta c15d08fdc7 Add a warning about running composer update farmos/farmos in dev environments. 2020-08-17 13:22:01 -04:00
Michael Stenta 786ac6c04b The /opt/drupal/vendor/bin is now in PATH in the upstream drupal:9, so vendor/bin prefix is no longer necessary.
See https://github.com/docker-library/drupal/issues/177
2020-08-17 08:49:02 -04:00
Michael Stenta 25f1a924e2 Remove COMPOSER_MEMORY from example commands. It is set by default in the image. 2020-07-31 15:05:49 -04:00
Michael Stenta 9b142a39ba Allow the www-data user/group IDs to be set via build arg. 2020-07-31 13:10:03 -04:00
Michael Stenta 464b5373dc Allow the farmOS and Composer project repositories and versions to be set with build arguments. 2020-07-31 13:10:03 -04:00
Michael Stenta c00ed4b518 Change development branch from 2.0.x to 2.x. 2020-06-05 10:09:37 -04:00
Michael Stenta 062ca7c290 Change the user/group IDs of www-data to 1000 within the dev Docker image. 2020-06-05 10:09:37 -04:00
Michael Stenta 67039e540e Run composer and drush as www-data. 2020-04-30 15:23:11 -04:00
Michael Stenta 35ec4132e8 Document how to use Drush. 2020-04-30 12:28:23 -04:00
Michael Stenta 26e61b67b2 Document how to use Composer in development. 2020-04-30 12:00:57 -04:00
Michael Stenta f62a795f85 Document how to run automated tests. 2020-04-30 12:00:57 -04:00
Michael Stenta 1fe0f204a3 Document XDebug configuration. 2020-04-30 12:00:57 -04:00
Michael Stenta 86074bb6c6 Describe how to set up a development environment. 2020-04-30 12:00:49 -04:00
Michael Stenta f14d78d4ff Initial commit of /docs, using Mkdocs. 2020-04-30 11:43:43 -04:00