Skip to content

Restructure significant part of the controller documentation #12549

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

Merged
merged 23 commits into from
Feb 28, 2025

Conversation

christianlupus
Copy link
Contributor

This mainly restructures the controller section.

☑️ Resolves

🖼️ Screenshots

Routing

Screenshot 2025-01-29 at 14-03-44 Routing — Nextcloud latest Developer Manual latest documentation

Controllers

Screenshot 2025-01-29 at 14-01-50 Controllers — Nextcloud latest Developer Manual latest documentation

Copy link
Contributor

Hello there,
Thank you so much for taking the time and effort to create a pull request to our Nextcloud project.

We hope that the review process is going smooth and is helpful for you. We want to ensure your pull request is reviewed to your satisfaction. If you have a moment, our community management team would very much appreciate your feedback on your experience with this PR review process.

Your feedback is valuable to us as we continuously strive to improve our community developer experience. Please take a moment to complete our short survey by clicking on the following link: https://cloud.nextcloud.com/apps/forms/s/i9Ago4EQRZ7TWxjfmeEpPkf6

Thank you for contributing to Nextcloud and we hope to hear from you soon!

(If you believe you should not receive this message, you can add yourself to the blocklist.)

Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Introduction to responders

Introduction HTML responses

Introduction to data responses

Introduction special reponders

Introduction security considerations

Signed-off-by: Christian Wolf <[email protected]>
Update OCS migration text

Fix OCS routes entry

Responders on OCS

APIRoute on 29

Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
@christianlupus christianlupus force-pushed the maintenance/restructure-controllers branch from 24a7c57 to 17043e2 Compare February 28, 2025 15:34
Copy link
Member

@provokateurin provokateurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This was so much better to review now! ❤️

I'm not sure about 0935fa8. Right now the introduction of each chapter will be part of the previous chapter.
In a real book this might make sense, but here people jump around between sections using the TOC or direct links, so they will easily miss the introduction. I would suggest to just make the introductions the first paragraph of their respective chapters.

Add first batch of changes to be incorporated.

Co-authored-by: Kate <[email protected]>
Signed-off-by: Christian Wolf <[email protected]>
@christianlupus
Copy link
Contributor Author

About the introduction texts in 0935fa: They are in fact in the parent chapters. So, the serve as an introduction on why the subchapter are grouped the way they are right now. We can easily drop this commit it is serves no purpose.

@christianlupus
Copy link
Contributor Author

As far as I see, all comments are addressed.

I will be abroad for the weekend, so I am only available via mobile phone (aka no big changes possible). You might merge or reread things at your own schedule. Just FYI

Copy link
Member

@provokateurin provokateurin left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nothing to comment on, so merging 🚀

@provokateurin provokateurin merged commit da5233e into master Feb 28, 2025
12 checks passed
@provokateurin provokateurin deleted the maintenance/restructure-controllers branch February 28, 2025 17:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants