docs icon indicating copy to clipboard operation
docs copied to clipboard

Add Ansible deployment option

Open ChrisEdS opened this issue 3 years ago • 6 comments

WHAT Needs to be Documented?

Ansible deployment as option to install ownCloud

WHERE Does This Need To Be Documented (Link)?

https://doc.owncloud.com/server/10.7/admin_manual/installation/

WHY Should This Change Be Made?

Ansible is an automated way to deploy ownCloud with minimal effort in a reproducible way.

There is already a post in central.owncloud.com which can be used for the official docs: https://central.owncloud.org/t/owncloud-ansible-introduction-and-how-to/25320 Also we have a GIST with information: https://gist.github.com/erwinpalma/ed6afef3f11995f4d3a532bb6142dc22

(Optional) What Type Of Content Change Is This?

  • [x] New Content Addition
  • [ ] Old Content Deprecation
  • [ ] Existing Content Simplification
  • [ ] Bug Fix to Existing Content

(Optional) Which Manual Does This Relate To?

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

ChrisEdS avatar May 28 '21 12:05 ChrisEdS

Thanks for highlighting the need documenting Ansible. To proceed, I would like to raise an important point. Creating a documentation for Ansible can be done by the docs tream, you are welcomed. But whenever things get public, we needto assure that there are people and processes in the backend which cover the documented topic from the technical perspective. If we create awareness with docs for Ansible, readers expect a working infrastructure, support when there are issues and fixes for those. Can you confirm that these prerequisites are present or when those will be present, which impacts priorisation and other things. Let us know what the status is and tell us who will be our counterparts for questions raised during the documentation process.

I guess that these prerequisites can be answerd by @dragotin and @cdamken or they are at least interested in an answer too.

Adding @xoxys @TheRealBro

mmattel avatar Jun 10 '21 11:06 mmattel

  • The same problem also exists the other way round: The more we and our customers use ansible, the more confusing it becomes, when an ansible deployment differs from the docs at doc.owncloud.com

  • The same problem also exists with docker compose: We should also review how much docker-compose documentation and support we offer. The docs currently go into great detail in e.g. https://doc.owncloud.com/server/10.8/admin_manual/installation/docker/#docker-compose-yaml-file -- all I can say here, is that this is no longer covered by any QA from the BTR team. It probably becomes defunct over time.

jnweiger avatar Jul 21 '21 11:07 jnweiger

Sorry but deployment methods will always have differences and IMO it does not make sense to align all deployment methods... But we discuss this topic also again and again

xoxys avatar Jul 21 '21 11:07 xoxys

I prefer to have the docs in a way, where we address standard topics in standard sections. All specialities related to docker, appliance or like ansible must go into those pages describing differences when needed.

mmattel avatar Jul 22 '21 08:07 mmattel

@pmaier1 @micbar @cdamken Please give guidance here. Thank you

michl19 avatar Jul 28 '21 13:07 michl19

We discussed this recently. The outcome was that we want to use the documentation that is already existing (https://owncloud-ansible.github.io/). For the official documentation it is important to at least mention that we provide and encourage Ansible as a deployment method. We agreed that we would not want to port this to the official documentation or start a new project there. Instead list Ansible as a deployment method and link to https://owncloud-ansible.github.io/.

Makes sense?

pmaier1 avatar Jul 28 '21 13:07 pmaier1