3
0
Fork 0
mirror of https://github.com/farmOS/farmOS.git synced 2024-02-23 11:37:38 +01:00
Commit graph

261 commits

Author SHA1 Message Date
jgOhYeah c3f7d79ebd Added notes on file naming for select options 2022-04-13 09:25:59 -04:00
jgOhYeah 9c2affa744 Added comments showing what to change in examples. 2022-04-13 09:25:59 -04:00
jgOhYeah e1b7d41893 Fixed ear tag type example code 2022-04-13 09:25:59 -04:00
jgOhYeah e08ee2f467 Fixed organic flag field example code
Appeared to be a copy / paste and not modified at one point.
Fixed it after reading https://farmos.discourse.group/t/custom-module-help/1149.
2022-04-13 09:25:59 -04:00
Paul Weidner 512ad6a15e Correct the zoom minus ( - ) button text in mapping user guide. 2022-04-07 15:53:40 -04:00
Michael Stenta 589f52f098 Make installation doc GEOS requirements wording stronger. 2022-04-07 14:23:38 -04:00
Paul Weidner 5c764c5b50 Pin selenium/standalone-chrome to 4.1.2-20220217. #514 2022-04-07 11:24:01 -04:00
Michael Stenta 5f246b85e2 Remove extra backtick from docs/development/environment/https.md. 2022-02-10 09:41:27 -05:00
Paul Weidner cb5d969d02 Update documentation for where a list of community modules can be found. 2022-02-07 15:35:44 -05:00
Paul Weidner 073b280d43 Correct list formatting in module development documentation. 2022-02-07 15:27:45 -05:00
Michael Stenta 28f83d2af3 Fix backtick in docs/hosting/localization.md. 2022-02-06 12:55:57 -05:00
Michael Stenta 35d30aaa05 Document farmOS cron set up in hosting/install docs. 2022-01-31 07:55:15 -05:00
Michael Stenta 5ef95da81f Add a QuickStringTrait::prioritizedString() method for joining, prioritizing, and trimming string parts. 2022-01-19 13:00:22 -05:00
Michael Stenta 44c51ee957 Add a QuickStringTrait::trimString() method for trimming strings on word boundaries. 2022-01-19 13:00:22 -05:00
Michael Stenta 30f70615b9 Fix incorrect Drush migrate:rollback commands in docs. 2022-01-17 05:08:44 -05:00
Michael Stenta 017efc07a7 Document how to enable translations. 2022-01-12 06:04:39 -05:00
Michael Stenta a742ee6ce9 Recommend hook_post_update_NAME() for configuration additions/deletions in module development docs. 2022-01-11 12:26:11 -05:00
Michael Stenta d41e4e4e84 Combine the BCMath and GEOS requirements into one item. 2021-12-28 13:38:56 -05:00
Michael Stenta 60ca070d76 Specifically require PHP 7.4 in installation docs. 2021-12-28 13:38:23 -05:00
Michael Stenta ad9b4f81c7 Copy and update user guide from 1.x docs to 2.x. 2021-12-27 17:27:13 -05:00
Michael Stenta 2c55037ed2 Delete docs/index.md. 2021-12-27 17:27:13 -05:00
Michael Stenta 8f2c0383e7 Remove favicon and mkdocs.yml lines that were only used for building docs.farmos.org. 2021-12-23 09:36:04 -05:00
Michael Stenta 394daa9f06 Reference non-existent farmos/farmos:2.x.y Docker tag in production hosting docs/examples.
By doing this, we will be forcing the end-user to follow best
practice by making an intentional decision about the version
they will use. We do not want farmos/farmos:2.x to be referenced
by default in the docs, otherwise we will be directing folks to
use the development branch, which may not be stable, and may
change if they update the image via `docker pull`. We also don't
want to recommend farmos/farmos:latest, for a similar reason:
when updating between versions it is important to manually run
update.php. By forcing intentional version use and updates, we
encourage best practice for updates as well.
2021-12-23 07:10:22 -05:00
Michael Stenta 73c3740322 Change docs.farmOS.org references to farmOS.org. 2021-12-23 06:56:37 -05:00
Michael Stenta 1f8941aff9 Document how to configure private filesystem in hosting docs. 2021-12-14 16:06:26 -05:00
Michael Stenta 6c3e9e7193 Document log geometry copying logic in more detail. 2021-12-08 07:48:55 -05:00
Michael Stenta af2393bfc5 Issue #3210067: Document log asset reference vs location reference in model docs 2021-12-08 06:58:14 -05:00
Michael Stenta 23cd6296d3 Link from hosting/install docs to development/environment. 2021-12-03 10:34:55 -05:00
Michael Stenta ceb7123384 Fix example quick form class in docs. 2021-11-17 16:49:51 -05:00
Michael Stenta 6b264ead7b Add "Data Streams" and "Files" links to the data model intro. 2021-11-01 11:45:56 -04:00
paul121 9937730c14 Query assets from multiple locations in a single query. 2021-10-27 16:27:19 -04:00
paul121 0df2e5b471 Query group members from multiple groups in a single query. 2021-10-27 16:27:19 -04:00
paul121 3bee8d4fb1 Provide a trait for loading prepopulated entity references. 2021-10-27 15:22:34 -04:00
paul121 560cd37168 Provide a base class for quick form action plugins. 2021-10-27 15:22:34 -04:00
paul121 ba3011a5e6 QuickForms are provided under the Plugin/QuickForms directory. 2021-10-27 15:22:33 -04:00
Michael Stenta 68e4f83c52 Document how modules can provide quick forms. 2021-10-27 15:22:33 -04:00
Michael Stenta 97309754c1 Issue #3243383: Allow flags to be limited to specific entity types and bundles 2021-10-18 14:55:11 -04:00
Michael Stenta 6d63bfbafb Correction in migration docs (farm_migrate:import). 2021-10-14 09:40:30 -04:00
Michael Stenta 2ebeef595e Require explicit use of accessCheck() on the result of farm.log_query service. 2021-10-01 12:44:07 -04:00
Michael Stenta e22bf3e576 Document that access checking is not performed in farmOS services. 2021-10-01 10:46:16 -04:00
Michael Stenta 26f7be7b73 Document the farm.log_query service access_check option. 2021-10-01 10:46:16 -04:00
Michael Stenta 3fa2cb6777 Fix documented log query service name. 2021-10-01 10:46:16 -04:00
Michael Stenta 092b6936d4 Clarify that farm_update only reverts configuration entities - not simple config. 2021-09-27 09:50:22 -04:00
Michael Stenta 74bbbd180f Document that it may be necessary to clear caches after farmOS updates. 2021-09-23 10:01:41 -04:00
Michael Stenta 7eccc896cd Document farmOS Update module's automatic configuration updates and exclusion options. 2021-09-23 09:55:41 -04:00
Symbioquine cc01293168 Update testing docs to reflect recent changes #445
**Why?** The docs were out of date - not capturing the
need for a Chrome/Selenium container and including info
about an XDebug work-around that isn't needed any more.
2021-09-23 09:44:54 -04:00
Michael Stenta c4bd241ed3 Remove material term reference field from Input logs. 2021-09-22 14:45:20 -04:00
paul121 5fd89cf2f8 Migrate input log material term reference field to Material Quantities. 2021-09-22 14:45:20 -04:00
Michael Stenta a95c487b9d Add a Material Quantity type with a Material type term reference field. 2021-09-22 14:45:20 -04:00
s33a 4b1b93efda Add a "Material type" reference field to Material assets. 2021-09-22 14:45:20 -04:00
s33a 13492129e6 Add a Material asset type. 2021-09-22 14:45:20 -04:00
s33a b88877b617 Rename "Material" taxonomy to "Material types".
This also changes the `material` term reference field on
Input logs to `material_type`, and updates all migrations
accordingly.
2021-09-22 14:45:20 -04:00
Michael Stenta f0e33e076a Document file entities in the data model. 2021-09-20 16:49:53 -04:00
Michael Stenta 1343f2393e Include "interoperability" in the goals of the data model. 2021-09-20 16:09:28 -04:00
Michael Stenta d59f587d37 Simplify reverse_proxy_addresses example in docs/development/environment/https.md. 2021-09-20 16:08:59 -04:00
Michael Stenta 09eb532f87 Document sensor data migration steps and considerations. 2021-09-20 15:07:25 -04:00
Michael Stenta 27b44cfd03 Document how to increase the Drush PHP memory limit for migrations. 2021-09-20 15:07:24 -04:00
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