Cannot develop own BackgroundTask when using Nextcloud Developer Documentation

Hi, thanks @ChristophWurst for the commit to update the background jobs doc because it was really confusing.

To give some feedback, I really had some troubles to get started with Nextcloud App development because of these things:

  • Finding out how to access the filesystem and how the access management is done by the filesystem API is really tricky. It was not clear for me to realize that a filesystem view is depending on a user and fetching files by e.g. their ID also depends on a users access rights. In my case I wanted to scan the filesystem which should not depend on a specific user. That was very complicated to find out how to do it…

  • Another tricky thing is logging… Until today I did not find out how to get reliable log messages escpecially when it comes to background jobs. At the beginning I had the issue that my background job kind of stopped because of an unknown reason and it did not logged anything of an error… I manually added more and more log messages into my job to find out the error step by step. Because of that I created an issue (https://github.com/owncloud/core/issues/37489) on GitHub to provide more information about executed background jobs during development or manual triggering.

  • Building on the point above it may generally be useful to get all information about (all) background jobs… The entities which are handled by the job worker are containing useful information which can be very helpful when trying to find out the cause of an issue.

  • The thing with the hooks documentation… You already know it, so I dont want to add something more about that.

  • It would also be very helpful for new Nextcloud App developers to get a basic “CRUD” based example about dealing with folders and files. If you haven’t done it before it is really hard to find out how it works and how the Nextcloud core API wants you to work with it.

  • Besides of that, my collegue is working on an administration UI for our developed App and he is really annoyed by it. It would be very helpful to provide some basic App UI documentation which describes the main cases “file selection” and “CRUD with CSRF via the Apps routes”.

Besides of all that, I’ve found a very good playlist on YouTube which explaines the process of an Nextcloud App development very good for beginners: https://www.youtube.com/playlist?list=PL0ZTCrsTNYF9EnvK39wVng4WFpEdX8X0I

I really dont want to blame anyone of the Nextcloud community and the development team because I know how hard it is to maintain a documentation of a product you are very familiar with also for people who did not know anything about that product. But I think it is a good way to stay in contact together to increase the usability of the documentation :slight_smile:

Best regards!