Skip to content
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

package doc removal #2417

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

package doc removal #2417

wants to merge 1 commit into from

Conversation

OniriCorpe
Copy link
Member

@OniriCorpe OniriCorpe commented Feb 27, 2024

now package docs are in the package repo itself

see: https://yunohost.org/packaging_app_doc

packagers, please, port the relevant parts on your package doc
https://forum.yunohost.org/t/package-documentation-changes/28754/2

@alexAubin
Copy link
Member

alexAubin commented Mar 19, 2024

Sorting the files by number of lines, maybe we want to specifically backport those to the doc inside the git repo:

  • transmission : maybe tips regarding the URL (/downloads, /completed) and sftp, scp ... -> confirmed, todo?
  • vaultwarden : maybe links to the admin interface + desktop/mobile clients (ported the small bits into the testing branch of the app package)
  • rainloop : maybe some useful notes about initial configuration, carddav, php (rainloop is deprecated, replaced by snappymail)
  • grafana : doesn't sound super important
  • zap : upstream not maintained so hmpf
  • umami : note on how to upgrade from v1 to v2, dunno how relevant this is, maybe this is super old -> it's actually from mid-2023 so meh idk watdo with this, maybe check with orhtej2
  • gemserv : important note on how to create a capsule ? (the package doc already include these)
  • writefreely : just an extensive list of features idk
  • pleroma : (only in fr), doc presenting pleroma's interface (doesn't sound super relevant, imho this should be the job of the upstream to provide such a user doc...)
  • my_webapp : doc about configuring ssh keys on the my_webapp user for SFTP via CLI .. sounds overly complex :| ...
  • collabora : the fr doc has pointers on how to run it on nextcloud ... it's a bit confusing as it doesn't seem to be related to the app itself...
  • mautrix_signal : significant tips on how to use the bridge (the package doc already include these)
  • mailman3 : meh
  • baikal : tips about connecting to thunderbird, agendav, etc, sounds worth to port it to the git repo if not there already -> Confirmed, TODO
  • rss-bridge : small tip about how to enable/disable bridge, dunno if it's that important (the package doc already include these)
  • pihole : tips about usage and configuration, sounds important-ish
  • seafile : doesn't sound hugely important, idk
  • domoticz : tips regarding mosquitto, access and API configuration, sounds important to compare to the git repo (the package doc already include these)
  • radicale : tips regarding admin and usage, sounds worth to compare to the git repo ... update : app is actually outdated and flagged as notworking so meh
  • synapse : tips regarding federation, turnserver, VPN context, security, to be compared to the current doc/ folder in the git repo : already part of the package doc (at least in testing branch)
  • netdata : just an extensive list of the features, doesn't sound super important...
  • nextcloud : there are important tips about moving data to an external storage (similar but different from https://yunohost.org/external_storage) + tips about collabora (in the fr version) and keeweb

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
2 participants