documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Quick start section for new Nextcloud Admins

Open joshtrichards opened this issue 1 year ago • 2 comments

Thanks for helping improve our documentation!

  • There is always room for improvement!
  • All contributions (changes and change ideas) - from the largest to the tiniest - help make Nextcloud better and easier to use!

Given the depth and breadth of the Admin Manual, maybe we can assemble a "quick start" section (perhaps in or adjacent to one of the first four chapters and in a logical place such as right after completing initial installation). This might cover "things longtime users of Nextcloud know and wish every new admin knew too". But keep the list limited to like a page or two. Some of these may be brief write-ups while others are more links to the appropriate places in the Admin Manual

I'm thinking things like:

  • How to look at the logs / where to find the log file
  • How to look at the config / where to find the config file(s)
  • First thing to check upon first logging in: the Admin settings->Overview screen for warnings/errors/etc
  • How updates work / how versioning works
  • Where to find help (for community members, but with a reminder enterprise support is an option)
  • What the various warnings/errors in the setup checks mean (a reminder about how/where to look in the manual to find them)
  • Perhaps some suggestions of "where to go next" in the manual
  • Email setup
  • Backups (and Restoring)
  • Securing/Hardening
  • Performance/Optimization
  • etc

These are just some off-the-cuff ideas.


Notes

  • Please be patient: this is a large open source project that is overseen by a mixture of volunteers and non-volunteers which are all ultimately busy.
  • If your suggestion is a troubleshooting scenario or one you're not 100% certain about, please post for feedback on the Nextcloud Help Forum first.
    • Then return here to bring back your experience to help improve the documentation for clarity, etc. (and link back to the forum discussion in your report!)

Protip: If you want to help move things along (or just help out in other ways too) here are some suggestions:

  • Look for areas where you can assist - even seemingly unrelated areas - because doing so frees up resources for your favorite topics and ideas.
  • Submit a proposed change - that attempts to addresses your issue - as a pull request.
  • Participate in a discussion on some other unresolved submitted idea ("issues") to help move it along.
  • Post a comment or review on someone else's proposed change ("pull request") to help move it along.

joshtrichards avatar Mar 26 '24 16:03 joshtrichards

Hi. Can I work on this please?

Butterflyee avatar Nov 05 '24 08:11 Butterflyee

Of course. Have at it. :)

joshtrichards avatar Nov 05 '24 12:11 joshtrichards