summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorBenjamin Brahmer <info@b-brahmer.de>2021-06-01 11:44:34 +0200
committerBenjamin Brahmer <info@b-brahmer.de>2021-06-01 12:58:42 +0200
commit98143e8bbcecd2bf60451b571e629b293757658c (patch)
tree70d70defb85f4df0556a5d9d3a3d35f37c1b7e81 /docs
parent469807a09189a19628558830344f620d9e02265b (diff)
add admin docs page, document removal of command
Signed-off-by: Benjamin Brahmer <info@b-brahmer.de> Co-authored-by: anoy. <anoymouserver@users.noreply.github.com>
Diffstat (limited to 'docs')
-rw-r--r--docs/api/api-v1.md2
-rw-r--r--docs/developer.md22
2 files changed, 23 insertions, 1 deletions
diff --git a/docs/api/api-v1.md b/docs/api/api-v1.md
index fd39a8acd..fd7575e75 100644
--- a/docs/api/api-v1.md
+++ b/docs/api/api-v1.md
@@ -669,7 +669,7 @@ This is used to clean up the database. It deletes folders and feeds that are mar
}
```
-**New in 8.1.0**: The console command for achieving the same result is:
+**New in 8.1.0, Removed in 16.0.0**: The console command for achieving the same result is:
php -f nextcloud/occ news:updater:all-feeds
diff --git a/docs/developer.md b/docs/developer.md
new file mode 100644
index 000000000..8a6bdd411
--- /dev/null
+++ b/docs/developer.md
@@ -0,0 +1,22 @@
+# Developer
+Welcome to the Nextcloud News App developer documentation.
+
+News is open for contributions, if you plan to implement a new feature make sure to open a [discussion](https://github.com/nextcloud/news/discussions/new?category=Features). Describe the feature that you are planing and your first idea how to implement it.
+This ensures that you don't start working on something which collides with the targets of the maintainers.
+
+For small fixes and improvements feel free to directly create a PR, the maintainers are happy to review your code.
+
+## APIs
+News offers an API that can be used by clients to synchronize with the server.
+There are two API declarations, so far only V1 has been fully implemented.
+Work on V2 has started with low priority.
+
+- [API-V1](api/api-v1.md)
+- [API-V2](api/api-v2.md)
+
+## Coding Style Guidelines
+The PHP code should all adhere to [PSR-2](https://www.php-fig.org/psr/psr-2/).
+*Note that this is a different codestyle than Nextcloud itself uses.*
+To test the codestyle you can run `make phpcs`.
+
+For linting JavaScript, a [jshint file](https://github.com/nextcloud/news/blob/master/js/.jshintrc) is used that is run before compiling the JavaScript.