erebion/libervia-backend
Watch
1
0
Fork
You've already forked libervia-backend
 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
4,237 commits 2 branches 0 tags 65 MiB
Commit graph libervia-backend/doc
Author SHA1 Message Date
Goffi
146dd6022f doc (contributing/testing): typo 2024-02-23 15:47:53 +01:00
Goffi
672f967080 doc (cli/call): add `tui` output, and document options: 
fix 428
 2024-02-16 18:46:06 +01:00
Goffi
40ababcf9c doc (cli/call): add outputs documentation: 
outputs are now documentated, and notably the new `gui` one.

fix 427
 2024-02-11 23:22:18 +01:00
Goffi
b634e41ac0 core, doc, cli (forums): new forums set commands + doc: 
- document the fact that if an empty `uri` is used, the forum node is created
  automatically
- new `forums/set` CLI commands and its documentation
 2023-12-11 18:10:27 +01:00
Goffi
d80c4e89dc plugin XEP-0277, doc: conflict is now checked and avoided if user_friendly_id_suffix is False, doc updated 2023-12-05 13:39:03 +01:00
Goffi
3c6cd70c80 doc (cli/blog): Document new --alt-link option 2023-12-05 13:14:55 +01:00
Goffi
e3370c0a00 doc (cli/blog): documentation of the new --no-id-suffix option. 2023-12-05 13:13:03 +01:00
Goffi
d96ca8443b doc (cli): documentation for the new call command: 
fix 426
 2023-11-01 14:10:31 +01:00
Goffi
ba3f96672f doc (cli): notification commands documentation. 2023-10-18 15:33:46 +02:00
Goffi
0e6dd6a8de doc (installation): update pipx instruction and remove requirements.txt mention 2023-08-09 00:48:11 +02:00
Goffi
75c8868620 doc (conf): fix version retrieval 2023-06-23 15:19:06 +02:00
Goffi
7e3834a5e9 refactoring: fix names in doc following modules hierarchy refactoring 2023-06-02 17:38:37 +02:00
Goffi
6a6f15707a massive refactoring to switch from camelCase to snake_case: 
historically, Libervia (SàT before) was using camelCase as allowed by PEP8 when using a
pre-PEP8 code, to use the same coding style as in Twisted.

However, snake_case is more readable and it's better to follow PEP8 best practices, so it
has been decided to move on full snake_case. Because Libervia has a huge codebase, this
ended with a ugly mix of camelCase and snake_case.

To fix that, this patch does a big refactoring by renaming every function and method
(including bridge) that are not coming from Twisted or Wokkel, to use fully snake_case.

This is a massive change, and may result in some bugs.
 2023-04-08 13:54:42 +02:00
Goffi
d50412c7f7 dpc (cli/info): update "disco" documentation to include new "external services": 
fix 418
 2023-04-07 15:18:39 +02:00
Goffi
217d49918d doc[installation]: update instructions 2022-11-24 12:25:07 +01:00
Goffi
5eae9dc299 doc (components): typo 2022-11-22 11:53:31 +01:00
Goffi
14eac027d8 doc (components/AP Gateway): html_redirect_dict option 2022-11-11 13:51:22 +01:00
Goffi
dd434fbf1f doc (encryption, cli): document Pubsub Targeted Encryption: 
a small section has been added to `encryption` to explain the difference with OXPS, and
the `--encrypt-for` arguments are explained.

fix 382
 2022-10-31 13:50:12 +01:00
Goffi
289855c9d1 doc (encryption, cli): pubsub signing documentation: 
- add a `Pubsub Signature` section to `encryption` documentation
- document `-X, --sign` flag where it's used
- document `pubsub/signature` subcommands

fix 381
 2022-10-30 01:06:58 +02:00
Goffi
39181f0bff doc (blog, pubsub): documentation on new e2ee arguments for pubsub, and shared secrets handling: 
fix 380
 2022-10-15 20:38:33 +02:00
Goffi
3ead662a51 doc: new doc giving an overview on how e2ee is working in Libervia/XMPP: 
the doc explain pubsub e2ee for now

rel 380
 2022-10-15 20:38:33 +02:00
Goffi
6eac59dc2d doc (components/AP Gateway): Ad-Hoc and Events: 
New Ad-Hoc command is explained, and `Events` section specify how the conversion is done
between the 2 protocols.

fix 372
 2022-09-22 12:03:12 +02:00
Goffi
b06f5cad04 doc (cli/event): update doc following changes: 
rel 372
 2022-09-22 12:01:44 +02:00
Goffi
84e6d9ceb2 doc (components/AP gateway): "reactions": 
fix 371
 2022-08-31 17:07:03 +02:00
Goffi
c7acfc1b9f doc (components): the word "handle" is more adapted here 2022-08-31 17:07:03 +02:00
Goffi
6bb76a2bd0 doc (components/AP gateway): "repeat" and "noticed/like": 
fix 370
 2022-07-22 17:40:03 +02:00
Goffi
4b8e1c2747 doc (cli/pubsub, cli/blog): attachments subcommands documentation: 
rel 370
 2022-07-22 17:16:28 +02:00
Goffi
fa5a0de7f7 doc (cli/blog): repeat documentation: 
rel 370
 2022-07-22 17:15:40 +02:00
Goffi
3633997ec4 doc (components/AP): Mention: 
fix 369
 2022-07-10 16:15:44 +02:00
Goffi
0938a7cd58 doc (cli/pubsub): add doc for `reference` subcommand: 
rel 369
 2022-07-10 16:15:09 +02:00
Goffi
b682a3bfeb doc (developer): typo 2022-07-09 16:29:36 +02:00
Goffi
ebed317c3b doc (components/AP): identity and avatar: 
fix 368
 2022-06-29 14:23:16 +02:00
Goffi
f9eb48d72d doc (components): AP item retraction + blocking: 
fix 367
 2022-06-17 15:50:34 +02:00
Goffi
daccd1de5d doc (cli/message): retract command 2022-06-17 15:50:15 +02:00
Goffi
5ecca19b71 doc (components): typo/spelling 2022-06-17 14:15:23 +02:00
Goffi
60dcb5d396 doc (cli/blocking): blocking command documentation: 
rel 367
 2022-06-17 14:15:23 +02:00
Goffi
5191343a40 doc (components): message delivery documentation: 
fix 366
 2022-05-24 17:57:41 +02:00
Goffi
9564647b21 doc (installation): sat_media is now libervia-media 2022-05-14 23:00:35 +02:00
Goffi
f96d703098 doc (installation): fix missing hg clone instructions 2022-05-14 22:35:39 +02:00
Goffi
a59ddef97c doc (components): update AP gateway documentation: 
add documentation for:
    - Publishing an Item
    - Following, Subscribing and Cache
    - Following/Followers Collections and Public Pubsub Subscription

fix 365
 2022-05-13 19:34:12 +02:00
Goffi
f66f602df2 doc (cli/pubsub): document new --public flags: 
`--public` option is documented for `subscribe`, `subscriptions` and `node subscriptions
get`, with examples. A warning has been added to show explicitely the privacy implication
of using `--public` with `subscribe`.

rel 365
 2022-05-13 19:32:06 +02:00
Goffi
44906f3bc3 doc (components): documentation of comments_max_depth option and threads conversion: 
ActivityPub to XMPP threads conversion is detailed.

fix 364
 2022-03-22 17:00:42 +01:00
Goffi
a8ec84f3ec doc (components): update AP component documentation: 
- add `configuration` section
- update instructions on AP actor handle <=> JID/node conversion
- explain how to get AP messages from XMPP
- explain how to get XMPP items for AP
- notes to explain tricks and implementations details

fix 363
 2022-01-31 18:35:52 +01:00
Goffi
aa4e6004e8 doc (components): base documentation for AP Gateway: 
fix: 362
 2021-09-26 16:41:58 +02:00
Goffi
d7d40a6d50 merge bookmark @ 2021-09-26 16:41:49 +02:00
Goffi
8c9af32d56 doc: components documentation: 
rel 362
 2021-09-26 16:38:00 +02:00
Goffi
60526e6849 doc (cli/pubsub_cache): search command documentation: 
rel 361
 2021-09-08 17:58:48 +02:00
Goffi
65f8701648 doc (cli/pubsub_cache): add a warning for reset 2021-09-08 17:58:48 +02:00
Goffi
50d7cb2a51 merge bookmark @ 2021-09-08 11:20:37 +02:00
Goffi
88afb112d8 doc (contributing): typo 2021-09-08 11:15:41 +02:00