Commit Graph

245 Commits

Author SHA1 Message Date
Joas Schilling
9ea91c26aa
Document disabled keyboard shortcuts
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-09-16 09:48:34 +02:00
Quinn Zipse
41f7c3547c
Fix typo in routing.rst
Signed-off-by: Quinn Zipse <25140452+quinnzipse@users.noreply.github.com>
2022-09-14 21:25:52 -05:00
Robin Windey
8073549620
Improve migration docs
* Add section on how migration classes are constructed
* Add a hint for "version" argument on "migrations:execute"

Signed-off-by: Robin Windey <ro.windey@gmail.com>
2022-09-03 12:18:51 +02:00
John Molakvoæ
e7683f866c
Merge pull request #6748 from PanCakeConnaisseur/non-existing-event
Remove nonexistent event
2022-08-13 13:04:59 +02:00
Raul
a6a3ebcae4 Add instructions for inviting nextcloud-bot to a repository
Signed-off-by: Raul <r.ferreira.fuentes@gmail.com>
2022-07-27 14:25:02 +02:00
kalle (jag)
3f2903a9c8
Dev settings docs: implement interface, not extend
Signed-off-by: kalle (jag) <kalle.f8@proton.me>
2022-07-07 21:28:35 +02:00
Felix Schneider
3a791dd690
Fix Typo
"addning" --> "adding"

Signed-off-by: Felix Schneider <fs@felix-schneider.org>

Signed-off-by: Felix Schneider <fs@felix-schneider.org>
2022-06-18 14:25:08 +02:00
Christoph Wurst
92cdbcda0d
Document logger function in dev manual
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-06-07 13:55:01 +02:00
zak39
efa31104f0 Explain how to add several IDelegatedSettings classes 'settings'
In this documentation, there is no explanation on how to add several IDelegatedSettings' classes for a function.

Signed-off-by: zak39 <fotia.baptiste@hotmail.com>
2022-06-03 10:37:07 +02:00
Joas Schilling
8af6bf851c
Extend translation docs a bit
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-05-19 16:23:25 +02:00
Carl Schwan
888ad06e72 Cleanup part of the developer api
- Port away from deprecated stuff
- Update php syntax

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2022-05-16 15:53:27 +02:00
Carl Schwan
4b23f5d53e Add section about OCP\Server::get
Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2022-05-10 00:12:22 +02:00
Carl Schwan
fed2de15da Modernize dependency injection section
Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2022-05-10 00:08:04 +02:00
Louis Chemineau
347f64d5c2 Add high level filesystem documention
From https://github.com/nextcloud/server/pull/26982

Adds some documentation for the filesystem layer, both a high level overview of how the various pieces interact and a high level guide for apps interacting with the filesystem.

Hopefully this will be useful to anyone trying to either use the filesystem or work on the filesystem.

Signed-off-by: Louis Chemineau <louis@chmn.me>
2022-05-02 14:18:20 +02:00
Vitor Mattos
31661e7113
Fix appdata url
Signed-off-by: Vitor Mattos <vitor@php.rio>
2022-04-25 20:02:30 -03:00
tflidd
2d620bee2c
Merge pull request #8134 from nextcloud/sualko-patch-1
emphasize that debug mode is required
2022-04-22 19:29:48 +02:00
Joas Schilling
9af1862f84
Document the string length issue
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-04-04 16:03:28 +02:00
Joas Schilling
dfee257fc2
Document database requirements and specialties
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-03-17 16:08:59 +01:00
Klaus
9b644bef94
emphasize that debug mode is required 2022-03-16 15:59:52 +01:00
Joas Schilling
ee73b3e241
Fix transaction method name
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-02-24 11:54:06 +01:00
Joas Schilling
83b5f104a0
Use "$this->"
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-02-22 14:15:31 +01:00
Joas Schilling
ce51b05458
Add section to the dev docs as well
Signed-off-by: Joas Schilling <coding@schilljs.com>
2022-02-22 14:03:37 +01:00
Côme Chilliet
42773a35d8
Merge pull request #8048 from nextcloud/enhancement/dev-ttransactional
Document TTransactional for developers
2022-02-21 10:07:39 +01:00
Christoph Wurst
6088dd56d1
Merge pull request #7851 from nextcloud/mejo--patch-1
Update configuration.rst, mention HintException
2022-02-21 08:55:13 +01:00
Christoph Wurst
53524d8542
Document TTransactional for developers
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2022-02-18 12:42:45 +01:00
Cyrille Bollu
7b29164174 Adds a provision about 'composer dump-autoload' to the migrations
chapter

Signed-off-by: Cyrille Bollu <cyr.debian@bollu.be>
2022-02-09 11:25:17 +01:00
Jonas
237ca61475
Update configuration.rst, mention HintException
With https://github.com/nextcloud/server/pull/30130, `setConfigValue` throws a HintException when config is read-only.

Signed-off-by: Jonas Meurer <jonas@freesources.org>
2022-01-13 12:17:25 +01:00
Christian Wolf
80234e56a5 Removed issues in developer manual
Signed-off-by: Christian Wolf <github@christianwolf.email>
2021-12-16 18:30:43 +01:00
rakekniven
c384544090
Fixed link (#7731)
Fixes #7169 

Signed-off-by: rakekniven <2069590+rakekniven@users.noreply.github.com>
2021-12-03 11:22:02 +01:00
Christian Wolf
39db36fdb2 Fixed some more links in the dev manual
Signed-off-by: Christian Wolf <github@christianwolf.email>
2021-11-24 14:50:02 +01:00
Christoph Wurst
334d2865db
Fix dev manual links to the app controllers page
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-11-22 10:38:11 +01:00
Joas Schilling
65302d916f
Merge pull request #7168 from nextcloud/rakekniven-patch-1
Add source examples for various used programming languages on how to add comments for translators
2021-10-29 08:39:42 +02:00
rakekniven
8b6e91eaef
Removed code block for vue
Signed-off-by: rakekniven <2069590+rakekniven@users.noreply.github.com>
2021-10-29 08:28:36 +02:00
rakekniven
a373ef8fcf
Changed wording for vue files
Signed-off-by: rakekniven <2069590+rakekniven@users.noreply.github.com>
2021-10-28 17:23:31 +02:00
Carl Schwan
f31f02f611
Merge pull request #7178 from nextcloud/work/dev_settings
Add setting section in the app developement tutorial
2021-10-14 11:40:10 +02:00
Carl Schwan
bd3c9594bf
Various code modernisation in code examples
* Type hinting
* Use of ::class instead of string

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2021-10-14 11:17:39 +02:00
Carl Schwan
b83a86ef18
Add setting section in the app developement tutorial
Fix #7158

Signed-off-by: Carl Schwan <carl@carlschwan.eu>
2021-10-14 11:13:16 +02:00
Daniel
19a40e4e16
Merge pull request #7177 from Aeredren/patch-2
Typo
2021-10-11 19:23:04 +02:00
Aeredren
f23b1a5245
Correct value for appname variable
Here $class2->appName come from $AppName which come from $app = new \OCP\AppFramework\App('myapp');
So it should be 'myapp' and not 'appname'
2021-10-08 15:30:52 +02:00
Aeredren
bb442806e6
Typo 2021-10-08 14:08:22 +02:00
rakekniven
933fc971d2 Update l10n.rst
Improved comments.

Signed-off-by: rakekniven <2069590+rakekniven@users.noreply.github.com>
2021-10-05 10:35:01 +02:00
rakekniven
b0c8a7fd2d Merge branch 'master' into rakekniven-patch-1 2021-10-04 16:26:44 +02:00
Joas Schilling
1a72294771
Fix "'any' reference target not found: OCP\AppFramework\Http"
Signed-off-by: Joas Schilling <coding@schilljs.com>
2021-09-14 09:53:11 +02:00
Joas Schilling
daecbdec07
Fix headline length errors
Signed-off-by: Joas Schilling <coding@schilljs.com>
2021-09-14 09:42:45 +02:00
Christoph Wurst
c2d4375701
Document correct db transaction handling
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-08-13 13:03:53 +02:00
Louis
0586b57bfa Add modern way of loading initial-state
Signed-off-by: Louis Chemineau <louis@chmn.me>
2021-07-07 16:39:30 +02:00
Christoph Wurst
3d60bece92
Fix dev manual inconsistencies
* Add missing debugging page
* Remove dead request lifecycle sub pages TOC
* Remove dead link to core translations page
* Revive link to basics debugging page
* Fix traige workflow image path
* Remove dead link to performance page

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 16:04:53 +02:00
Christoph Wurst
4b9a868a4c
Fix links from the request lifecycle to the app init docs
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-07-05 09:46:01 +02:00
Vincent Petry
ebca005493
Remove DB schema docs, add note for NC 22
Signed-off-by: Vincent Petry <vincent@nextcloud.com>
2021-06-17 17:42:31 +02:00
Vincent Petry
1f5ffe8253
Remove traces of migrations:generate-from-schema
Remove traces of occ migrations:generate-from-schema which was removed
in NC 22.

Also adjust text that specifies that now ALL migrations:* commands are only
available in debug mode.

Signed-off-by: Vincent Petry <vincent@nextcloud.com>
2021-06-17 15:33:53 +02:00
Alexey Abel
d7ca49af41 Remove non-existing event
There is no string `CreateUserEvent` in the entire nextcloud-server code.
2021-06-08 01:48:25 +02:00
Lukas Reschke
cce504ca87
Schema -> ISchemaWrapper
This makes my autocomplete happier :)
2021-05-25 19:37:37 +02:00
Michael Hirschler
4a8de965b7
Update filesystem.rst 2021-01-18 16:30:29 +01:00
Christoph Wurst
730f23cbee
Recommend our own type constants instead of Doctrine's
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-01-15 10:12:29 +01:00
Christoph Wurst
806a44eb50
Fix upgrade info about the dbal type vs types class
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2021-01-12 09:44:10 +01:00
Morris Jobke
b75263ea8e
Merge pull request #5887 from nextcloud/tcitworld-patch-2
Fix another typo
2021-01-06 14:26:54 +01:00
Thomas Citharel
07831576c3
Fix another typo
Signed-off-by: Thomas Citharel <nextcloud@tcit.fr>
2021-01-05 15:36:01 +01:00
Thomas Citharel
362b344431
Fixed a typo in l10n docs
Signed-off-by: Thomas Citharel <nextcloud@tcit.fr>
2021-01-05 11:10:11 +01:00
Christoph Wurst
8cb613ff7b
Give devs a hint that it's their last chance ditch database.xml
It looks like 22 will drop the database.xml support alltogether, so
let's motivate devs for the mgiration if they haven't done already.

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-12-14 10:26:13 +01:00
Christoph Wurst
9fcd5196bb
Drop misleading traces of app.php recommendations
The app init docs still recommended using app.php.

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-11-24 10:51:33 +01:00
rakekniven
d8e15157cb
Added examples on how to add comments in different coding languages
Signed-off-by: rakekniven <mark.ziegler@rakekniven.de>
2020-11-19 18:43:33 +01:00
Morris Jobke
d0a2340c51
Merge pull request #5308 from Nienzu/fix_backgroundjob
Correct sample code dependency and some typo
2020-10-29 14:18:52 +01:00
Morris Jobke
b2a4abfe0c
Document subadmin events
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-10-29 11:21:10 +01:00
Morris Jobke
58d04b03cf
Fix space
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-10-29 09:46:01 +01:00
Morris Jobke
3496f555c5
Document Settings' BeforeTemplateRenderedEvent
See https://github.com/nextcloud/server/pull/22649

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-10-29 09:29:36 +01:00
Morris Jobke
f293c293ad
Document typed LDAP event for user and group backend
See https://github.com/nextcloud/server/pull/22221

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-10-29 09:19:24 +01:00
nienzu
4ad5b11ffd Correct sample code dependency and some typo
Signed-off-by: nienzu <ibqqz0602@gmail.com>
2020-10-28 16:33:46 +08:00
Mason Payne
b9f7c57409
Update required info about Hooks
Spent too much time looking for something to give me the right direction. Found this forum post from 2017.
https://help.nextcloud.com/t/filehook-not-working/14591/14

Signed-off-by: Mason Payne <gomas.bmw@gmail.com>
2020-10-15 21:37:47 -06:00
nienzu
b6cb8489f4 Fix spelling error in migrations
Signed-off-by: nienzu <ibqqz0602@gmail.com>
2020-10-14 17:24:30 +08:00
Morris Jobke
8752c1d9cc
Merge pull request #5157 from dassio/tutorial_migration_command
add migration to tutorial
2020-10-06 09:02:09 +02:00
Christoph Wurst
5111715c34
Migrate logging docs to new interface
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-10-05 14:30:43 +02:00
dassio
097b700fed change to suffixing
Signed-off-by: dassio <dassio@icloud.com>
2020-10-04 17:11:38 +01:00
dassio
7f3adcb809 add migration to tutorial
Signed-off-by: dassio <dassio@icloud.com>
2020-10-04 17:11:32 +01:00
nienzu
dd19c90353 Correct the sample code for middleware 2020-09-29 11:17:48 +08:00
Roeland Jago Douma
224f72a093
Merge pull request #5040 from nextcloud/enh/getAppFolder_is_dead
getAppfolder is dead
2020-09-24 08:31:26 +02:00
Roeland Jago Douma
3826534ee5
enh appdata docs
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
2020-09-23 20:42:19 +02:00
Roeland Jago Douma
ee8b49b0d9
getAppfolder is dead
Signed-off-by: Roeland Jago Douma <roeland@famdouma.nl>
2020-09-23 20:30:22 +02:00
J0WI
122ed88e53 Update urls to HTTPS
Signed-off-by: J0WI <J0WI@users.noreply.github.com>
2020-09-17 20:33:30 +02:00
ecsecta
34605cce0d
Fix name of deprecated oc_requesttoken
oc_requesttoken is marked as deprecated.
2020-09-10 09:54:53 +02:00
Morris Jobke
5e6b9a714c
Merge pull request #3124 from jivanpal/patch-2
Update routing.rst; corrected parameter name from `method` to `verb`
2020-09-09 18:29:45 +02:00
Klaus
65ca339f34
Add example of n function 2020-09-09 11:36:58 +02:00
Jivan Pal
2e02596b06
Update routing.rst; corrected parameter name from method to verb 2020-08-20 18:12:06 +01:00
Morris Jobke
c4158932a8
Merge pull request #2765 from nextcloud/georgehrke-patch-1
Update documentation as per server#22041
2020-08-19 19:34:48 +02:00
Glen
67cf4b1729 Update dependency_injection.rst
Dependency Injection and the art of Services and Containers Tutorial is unavailable due to being private on YouTube. Removed the link.

Signed-off-by: Glen Clark <glenuk@gmail.com>
2020-08-18 08:38:18 +01:00
Morris Jobke
ed635f5e9f
Fix underline
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-08-13 08:13:28 +02:00
Morris Jobke
9b7234ea79
Add TwoFactorProviderDisabled event
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-08-13 07:26:27 +02:00
Georg Ehrke
20d37d52b4
Update documentation as per server#22041 2020-08-10 15:31:52 +02:00
Morris Jobke
0165943a36
Add deprecation notice for OCP\Group\Events\BeforeUserRemovedEvent
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-08-10 15:05:14 +02:00
Morris Jobke
da43209771
Document existing events
* LoadAdditionalScripts (@rullzer) - https://github.com/nextcloud/server/pull/16641
* LoadViewerEvent (@skjnldsv) - https://github.com/nextcloud/viewer/pull/271
* RegisterDirectEditorEvent (@juliushaertl) - https://github.com/nextcloud/server/pull/17625
* typed events for files scanner (@christophwurst) - https://github.com/nextcloud/server/pull/18351
* typed events for group mangement (@christophwurst) - https://github.com/nextcloud/server/pull/18350
* AddContentSecurityPolicyEvent (@rullzer) - https://github.com/nextcloud/server/pull/15730
* UserLiveStatusEvent (@georgehrke) - https://github.com/nextcloud/server/pull/21186
* password_policy events (@christophwurst) - https://github.com/nextcloud/server/pull/18019
* AddFeaturePolicyEvent (@rullzer) - https://github.com/nextcloud/server/pull/16613
* ShareCreatedEvent (@rullzer) - https://github.com/nextcloud/server/pull/18384
* LoadSettingsScriptsEvent (@blizzz) - https://github.com/nextcloud/server/pull/21475
* flow events (@rullzer) - https://github.com/nextcloud/server/pull/18535

Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-08-10 14:22:20 +02:00
Morris Jobke
8776c169e6
Add OCA\DAV\Events\SabrePluginAuthInitEvent event
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-07-23 21:47:02 +02:00
Christoph Wurst
cf126f82c4
Merge pull request #2201 from nextcloud/new-events
New events for typed event handling
2020-07-17 09:10:41 +02:00
Christoph Wurst
eb3228f05c
Document PSR-11 integration
Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-07-16 14:34:41 +02:00
Morris Jobke
3c4cfa1314
Add event for BeforeTemplateRenderedEvent
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-07-15 20:08:59 +02:00
Morris Jobke
9c9ed0f35f
Add BeforeTemplateRenderedEvent
Signed-off-by: Morris Jobke <hey@morrisjobke.de>
2020-07-15 19:55:07 +02:00
Christoph Wurst
2647cd93c7
Restructure the dev manual
This moves lots of pages around. The high-level changes are

* Better main sections, so it's more *general*, *into*, *basics* and *details*
* Move more general topics to a *Basic* section, which are not
  app-specific
* Remove app docs to the stuff that is likely used, anything else goes
  into "Digging deeper"
* Move general guides into a prologue
* Try to *compress*/combine some pages with similar content
* Try to have better consistencs on level ob abstraction across pages
* Split app development and maintenance pages into two sections
* Integrate bugtracker info into prologue
* Integrate Android pages into client APIs section

Signed-off-by: Christoph Wurst <christoph@winzerhof-wurst.at>
2020-06-22 18:35:59 +02:00