Commit Graph

204 Commits

Author SHA1 Message Date
Michael Stenta 9e6b6b0a7f Add a note about community modules to migration docs. 2021-09-20 12:11:07 -04:00
Michael Stenta 89996482be Issue #3220623: Split Sale/Purchase/Price bundles out to contrib 2021-09-17 15:59:27 -04:00
Michael Stenta 1652c4746f Add a farm_migrate:rollback Drush command that rolls back all farmOS migrations. 2021-09-15 14:22:09 -04:00
Michael Stenta a24c3ff221 Add a farm_migrate:import Drush command that executes all farmOS migrations. 2021-09-15 14:22:03 -04:00
Michael Stenta f3ec44d43e Issue #3189740 by m.stenta: Cannot rollback farm_migrate_asset_parent group migrations 2021-09-15 12:03:04 -04:00
Michael Stenta 14bb01e681 Rename farm_migrate_reference group to farm_migrate_asset_parent. 2021-09-15 12:03:04 -04:00
Michael Stenta f70ab7020e Document how to debug migration validation errors. 2021-09-15 09:01:51 -04:00
paul121 1fc54816b0 Add API documentation for uploading files. 2021-07-13 16:43:17 -04:00
paul121 f4f48f2d25 Include link to JSON:API module documentation. 2021-07-13 16:43:17 -04:00
Paul Weidner 2109ed4cd7 Correct the farmOS version that had areas. 2021-07-13 16:24:08 -04:00
Michael Stenta fda3f325ac Add an isLocation() method to the asset.location service. 2021-06-04 21:15:25 -04:00
Michael Stenta 8a5f2a0caa Document asset.location service's getAssetsByLocation() method. 2021-06-04 21:12:37 -04:00
Michael Stenta 8f0838fad5 Document group.membership service's getGroupMembers() method. 2021-06-04 21:10:41 -04:00
Michael Stenta 814499d8ab Add $options to log.query service documentation for consistency. 2021-06-04 07:18:57 -04:00
Michael Stenta 462d94cd2c Fix group.membership service documentation. 2021-06-04 07:18:57 -04:00
Michael Stenta bb08d9a3a8 Update module dev guide to suggest putting modules in sites/all/modules.
Instead of the [docroot]/modules, which is where Composer puts modules.
In the future, if we include more documentation about Composer-based
deployments we can talk specifically about that.
2021-04-16 12:31:11 -04:00
paul121 88090239a4 Document consumer.allowed_origins field and purpose. 2021-04-08 19:05:36 -04:00
Michael Stenta bfffc82188 Add recommended proxy buffer config to example nginx config for local HTTPS.
I found that this was necessary for the asset GeoJSON Views to prevent 502 Bad Gateway.
2021-04-08 15:37:23 -04:00
Michael Stenta 249f74d9f4 Document Data Streams in the data model docs. 2021-04-01 11:22:28 -04:00
Michael Stenta e3a74c18e0 Document when to run farm_migrate_sensor_data migrations. 2021-04-01 11:22:28 -04:00
Michael Stenta babe340e21 Generalize hosting SSL instructions regarding sensor data streams. 2021-04-01 11:22:28 -04:00
Michael Stenta c0f9827d1a Reference the Basic class name instead of including the code in docs. 2021-04-01 11:22:28 -04:00
Michael Stenta 645ce82b44 Refer to legacy_listener as "Listener (Legacy)". 2021-04-01 11:22:28 -04:00
paul121 5d42be6412 Rename listener to basic. 2021-04-01 11:22:27 -04:00
paul121 64ba354e33 Update data stream docs to reflect bundle plugins. 2021-04-01 11:22:27 -04:00
paul121 ae66f05e33 Add documentation for the data stream module. 2021-04-01 11:22:27 -04:00
Michael Stenta eaef284f07 Document type-specific fields on assets, logs, and terms. 2021-04-01 11:22:26 -04:00
Michael Stenta 99eae4de12 Document inventory management in the data model docs. 2021-03-27 14:43:53 -04:00
Michael Stenta 235b98afff Document that the 1.x inventory field merged into quantity entities in 2.x. 2021-03-27 14:43:53 -04:00
Michael Stenta 4064c4f84f Initial asset.inventory service. 2021-03-25 18:42:03 -04:00
Michael Stenta 4d189d24b1 Add "Standard attributes" heading to all record types in data model docs. 2021-03-25 18:31:09 -04:00
Michael Stenta 100e8bb974 Link to API Authorization doc and highlight authorize URL, token URL, and Content-Type differences. 2021-03-19 09:03:50 -04:00
Michael Stenta d94862970f Describe price quantities. 2021-03-19 08:23:13 -04:00
Michael Stenta 0dc9c45dff Describe Quantity Types (only includes Standard). 2021-03-19 08:23:13 -04:00
Michael Stenta 103cbd5aa7 Remove references to "bundles". 2021-03-19 08:23:13 -04:00
Michael Stenta bfbe862321 Refer to "record types" instead of "data types". 2021-03-19 08:23:06 -04:00
Michael Stenta 6858ae694e Use the word "record" instead of "entity" in data model docs. 2021-03-19 08:20:15 -04:00
Michael Stenta 934ea34a83 Document the farmOS data model (first draft). 2021-03-19 08:20:15 -04:00
Michael Stenta 5eff5d9f8c Document services for module development: asset.location, group.membership, log.query. 2021-03-19 08:20:15 -04:00
Michael Stenta f3db655455 Issue #3203228: Running migrations out of order can result in data collisions 2021-03-12 08:14:50 -05:00
Michael Stenta a8350acca0 Add note about orphaned quantities to migration doc. 2021-03-01 08:15:46 -05:00
Michael Stenta 4041a46715 Rename the farm_migrate group to farm_migrate_config. 2021-03-01 08:15:46 -05:00
Michael Stenta 0555d774ae Split file migrations out to a farm_migrate_file migration group to resolve dependency issues. 2021-03-01 08:15:46 -05:00
Michael Stenta 5505a3c91a Email configuration documentation. 2021-02-25 23:50:51 -05:00
Michael Stenta 7b9bfa1c1e Updating farmOS documentation. 2021-02-25 23:50:51 -05:00
Michael Stenta 1126516024 Installing farmOS documentation. 2021-02-25 23:50:46 -05:00
Michael Stenta 8bbee97c7d Hosting farmOS documentation.
This is mostly copied from existing farmOS.org documentation,
modified and updated for 2.x.
2021-02-25 22:33:13 -05:00
Michael Stenta 00d7c91435 Move from 2x.farmos.org to docs.farmos.org. 2021-02-25 22:33:13 -05:00
Michael Stenta 2d1b0b298a Document how to set up HTTPS for local development. 2021-02-25 22:30:54 -05:00
Michael Stenta f6365c9425 Migration doc updates.
- Add an introduction.
- Organize important migration considerations.
- Link to sections.
2021-02-25 12:58:32 -05:00
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