Azure / azurefile-dockervolumedriver

Docker Volume Driver for Azure File Service over SMB/CIFS :whale:
Apache License 2.0
169 stars 55 forks source link

Improved documentation for Ubuntu15+ installations #39

Closed stephlocke closed 8 years ago

stephlocke commented 8 years ago

As I've gone through the process as a n00b I identified various points where there were issues (like the wget going to wrong dir) or where there it just assumed you were comfortable with linux.

I added a TL;DR so that people who were really expert could get going quickly.

Hopefully, these docs are considered an improvement. If they are, I'm happy to do a similar modification to the Ubuntu14 notes.

ahmetb commented 8 years ago

thanks for this I'll review.

ahmetb commented 8 years ago

it just assumed you were comfortable with linux.

I think we have a bit of disagreement. This product is a bit intended for Linux-savvy people as it is Linux-only a well as an advanced tool. I'm not very big fan of explaining every single bit of detail of the steps and it appears like it gets kind of harder to follow for the advanced users.

I'll add our docs expert @squillace to comment.

ahmetb commented 8 years ago

looks way better now. thanks! 👍 🎊

stephlocke commented 8 years ago

On the level the docs should be pitched at.... Docker is a hot topic and there's a lot of different pressures for people to use it. Most of those people do not have the time to first get fully up to speed with Linux - most are from "Microsoft shops, and only Microsoft". There's even more incentive for these people to try to keep it in Azure so they still retain some of that Microsoft aegis. I think you'll see more n00bs in future as a consequence. I think you should be lowering the barriers to entry as much as possible - it's the Microsoft way (in my eyes). Obviously, you don't have to accept my PR though or my opinions on documentation!

cc @squillace

ahmetb commented 8 years ago

I think there is a good balance between totally n00b docs and an advanced one. This is way better now. Thanks for your contribution. 🎆

stephlocke commented 8 years ago

My pleasure, apologies for being hassle!