Skip to content

feat(developermanual): move new and deprecated APIs to dedicated pages#14183

Open
ChristophWurst wants to merge 1 commit intomasterfrom
feat/developer/new-deprecations
Open

feat(developermanual): move new and deprecated APIs to dedicated pages#14183
ChristophWurst wants to merge 1 commit intomasterfrom
feat/developer/new-deprecations

Conversation

@ChristophWurst
Copy link
Copy Markdown
Member

This is the cleaned-up version of #14180.

I did not move the upgrade doc(s) yet as I'm a bit unsure how to do it without link breakage and how to only list the newest one and hide the old ones.

🖼️ Screenshots

Header Header
Index Screenshot 2026-03-31 at 16-46-24 Release notes — Nextcloud latest Developer Manual latest documentation
New Screenshot 2026-03-31 at 16-46-32 New in this release — Nextcloud latest Developer Manual latest documentation
Deprecated Screenshot 2026-03-31 at 16-46-39 Deprecations — Nextcloud latest Developer Manual latest documentation
Upgrade guide Screenshot 2026-03-31 at 16-47-12 Upgrade to Nextcloud 34 — Nextcloud latest Developer Manual latest documentation

Signed-off-by: Christoph Wurst <1374172+ChristophWurst@users.noreply.github.com>
Deprecations
============

In order to improve our platform we are phasing out some APIs. Deprecated APIs are not removed before ???,
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

❓❓❓ lol

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Right. That brings up the old discussion about what we promise as deprecation period. IIRC it was three years. Should I write it down or skip?

.. _deprecated-apis:

============
Deprecations
Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Should also be a file per major for better linking?

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

I don't like it. This will get messy quickly. It also makes it impossible to have a stable link as every major release will have the version embedded in the URL.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We could collect all current deprecations on this page. First we list the new ones, then there's the rest. When a deprecation is finally removed, it's also removed from the page.

It's equally messy, but there is one stable URL for the page.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

it's also removed from the page.

Could have a second page then for those?

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