Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation of available log types #38

Open
richardostler opened this issue Sep 9, 2020 · 2 comments
Open

Improve documentation of available log types #38

richardostler opened this issue Sep 9, 2020 · 2 comments

Comments

@richardostler
Copy link

Just a quick note that 'farm_seeding' seems to be a valid log filter, although not listed in the readme documentation.

@mstenta
Copy link
Member

mstenta commented Sep 10, 2020

Great observation @richardostler ! The README.md only lists the four basic log types (farm_activity, farm_observation, farm_input, and farm_harvest)...

But it also notes:

Other log types may be provided by add-on modules in farmOS.

That covers a number of other log types, but perhaps it would be worth improving the README.md a bit...

Maybe we could say something like:

These are the log types that come with farmOS (although may not be enabled depending on the modules that are turned on). Other log types may be provided by add-on modules in farmOS.

@mstenta
Copy link
Member

mstenta commented Sep 10, 2020

Might also be worth pointing to the /farm.json API documentation: https://farmos.org/development/api/#farmjson

Each farmOS instance has a /farm.json endpoint that contains detailed information about the log types that are available on it. So any code that intends to work with farmOS generally should be checking that endpoint to make sure the log types it needs are available. That's not necessary for custom scripts that are only needed to work with a single farmOS instance - in that case you know what you have available.

@mstenta mstenta changed the title farm_seeding log filter Improve documentation of available log types Sep 10, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

No branches or pull requests

2 participants