Restructure admin manual - concept

[haukman]

What Needs to be Documented?

The background of this ticket is to improve the structure/content of the ownCloud admin manual.

Where Does This Need To Be Documented?

https://doc.owncloud.com/server/administration_manual/

Why Should This Change Be Made? (Optional)

The admin manual should have a better guidance which options ownCloud admins have to install it. In addition to that, it should be possible to install ownCloud (manual install) based on a step by step guide based on the distribution used.

What Type Of Content Change Is This? (Optional)

• New Content Addition
• Old Content Deprecation
• Existing Content Simplification
• Bug Fix to Existing Content

Which Manual Does This Relate To? (Optional)

• Admin Manual
• Developer Manual
• User Manual
• Android
• iOS
• Branded Clients
• Desktop Client
• Other

Current structure of admin manual

Proposal for a new structure

initial thoughts:

• ownCloud has only three different install options (Docker, manual install, UCS appliance)
• Focus complete structure on these three types to provide a clear guidance to admins
• Provide information about pros/cons of each install options to help picking the right one
• Currently the docs for the UCS appliance is outside of the other install options

first outcome after a call with @mmattel:

Admin Manual

• Installation
  • Release Notes
  • What´s New
  • FAQ
  • How to choose the right installation options
  • System Requirements
    - UCS Appliance
    - Manual Installation
    - Docker Containers
  • Installation Options
    • UCS Appiance
    • Manual Installation
      • Deployment Recommendations
      • Prepare the Server
        • Ubuntu 16.04
        • RHEL 7.2
          • SELinux Configuration
        • ...
      • Install ownCloud
        • Download/Unpack/permissions etc. (just as placeholder)
        • Command Line Installation
        • Installation Wizard
    • Docker Containers
  • Installing and Managing Apps
    • Supported Apps
  • Using Let’s Encrypt SSL Certificates
• Configuration
• Maintenance
• ownCloud Upgrade

This is a first draft of an updated structure for the admin manual. Most of the content is already there, just needs to be shifted to another place.

Please share your thougths: @settermjd @dercorn @michaelstingl @patrickjahns @felixboehm

I was thinking about having a "docs hackweek (or days)" in Nürnberg to get things done efficiently.