-
Notifications
You must be signed in to change notification settings - Fork 10
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
Migration of documentation to Nextcloud documentation #415
Comments
Clarification on what is outdated content: a lot of content was written before AppAPI was a shipped app. Content that makes no longer sense due to this change, should be removed. |
A new PR has been created for the Flow repository (nextcloud/flow#14) with two It would be nice to include this information in future documentation so that when it appears we can update the necessary links in the Flow repository. |
Sorry for the wait, but I think I am satisfied now in terms of the top-level reorganizing the existing documentation. I still need another pass to re-read the documentation again for outdated info, though, maybe re-order some pieces here and there too if needed. If you think it's ready to merge right now, let me know and I can mark it as such.
For the info in both links, I'm not sure how much of it is tied to the fact that Flow is a Python app. For Python-specific info, I'm not sure how much of it would be appropriate for inclusion in the documentation. Maybe linking the tutorial would be sufficient? |
Second pass is done and PR is now marked as ready. There are probably some things that I still missed, but you can let me know if you want to address them now or later. |
Final pass is now done and PR is merged. |
Task: Migrate and Refactor AppAPI Documentation for Nextcloud
Context:
We cannot make significant updates to our current AppAPI documentation because the more we update it now, the more we’ll have to redo later. Additionally, much of the old documentation was written before AppAPI became a built-in application. At that time, the documentation was simpler, as we assumed users knew why they were installing AppAPI and how to configure it.
Now that AppAPI is a built-in application, the documentation requirements have changed, necessitating this migration and refactor to better suit the new user base.
We need to migrate the current documentation from AppAPI's GitHub Pages to the official Nextcloud documentation, located here, and split it into two sections:
Each section should also have its own FAQ, which we'll review and complete later.
As part of this migration, the main tasks include:
Remember, the documentation doesn't need to be perfect in this iteration; it just needs to be split and structured.
This is for Nextcloud version 30+ only, and it's important to reflect that AppAPI is now an embedded application.
Even draft PRs are acceptable, as long as we have a foundation to move forward.
The text was updated successfully, but these errors were encountered: