documentation icon indicating copy to clipboard operation
documentation copied to clipboard

include documentation in Nextcloud 24

Open martin21 opened this issue 3 years ago • 1 comments

Proxmox Server Solutions includes the admin documentation for Proxmox VE within a typical Proxmox VE installation.

The make that documentation directly accessible from within Proxmox VE web interface. This way I can access documentation without having access to their documentation wiki. For Nextcloud this would have helped with #8445

Nextcloud does not offer this.

Expected result: HTML documentation for user and admin is directly accessible from within any Nextcloud instance in the version that matches the currently installed Nextcloud version.

Pro:

  • Access to documentation even if Nextcloud cannot access docs.nextcloud.com, for example due to no Internet access for a locally hosted Nextcloud instance
  • Documentation matches the exact version without the user having to find the right version of the documentation itself
  • Likely less bandwidth used for docs.nextcloud.com as documentation access is offloaded to single Nextcloud instances.

Con:

  • User or admin may miss documentation fixes for a specific version that may only be available online. As Nextcloud releases minor updates, I think this does not matter all too much.
  • More bandwidth used for downloading Nextcloud.

martin21 avatar May 26 '22 06:05 martin21

@martin21 Current state is, that:

  • User documentation is already included locally in Nextcloud instance (but English variant only - localized variants are omitted).
  • Administrator documentation is not included locally, it is only linked from online source. Yes, this can be improved for scenarios you mentioned by including it directly in Nextcloud instance itself, as you suggested.

p-bo avatar May 26 '22 07:05 p-bo

If this is to be done (or considered) it'll have to be driven at the server repo level (I.e. release process) rather than here in the documentation repo. We have no direct control over whether the docs end up in a server install from here.

This is because inclusion would have to be added either as part of the standard build/release process (of the distributed Archive) or - perhaps - further downstream (AIO, Snap, Official community Docker, etc.).

joshtrichards avatar Aug 19 '23 22:08 joshtrichards

Regarding user documentation - English version is already included (in form of snapshot of docs repo in time of server release) in server install package - so it is solved workfow here. Plea is to include localized versions too...

Regarding admin documentation - if it is possible in case of English user documentation, managed also in docs repo, why not for admin docs from the same repostiory (i.e. also not tied to server releases)?

p-bo avatar Aug 20 '23 07:08 p-bo