Docker-sync: [idea] Rework configuration reference to explain each option

Created on 12 Jul 2016  路  10Comments  路  Source: EugenMayer/docker-sync

Instead of showing a annotated configuration, rather split into global options and syncs option and explain each value as:

  • meaning
  • default
  • possible values / allowed values
  • optional / mandatory

anybody willing to help here? Be bold https://github.com/EugenMayer/docker-sync/wiki/2.-Configuration

everybody has write access

documentation help wanted

All 10 comments

Would a docker-sync init task that auto-generates a fully-documented sample docker-sync.yml file be useful? Similar to how vagrant init works.

That Sounds like a realy good idea. Go forward doing that happy to merge such in

Thanks to docker-sync I've just got my Bedrock WordPress Docker Compose (V3) setup working and would be glad to add a section to the wiki for this as it would help many WordPress developers.

How does updating the wiki work? I just edit it and commit?

You Fan freely create neu Wiki Pages, just be bold!

I'd really like to see a good description of each of the sync options, then breaking each configuration explanation into its own page.

This would allow the user to determine which option will be best for their use, then go access example and details strictly addresses their sync option. For example, I don't know right now if I should define _sync_host_port_ when using native_osx because the wiki mentions not using it for unison, but also that it is for rsync.

Separating these out would make it much easier to grok for the end user.

@unnawut any chance you would pick this up. This would be so great :)

Note that I haven't forgotten this issue but havn't got time to get to it yet. Will be back!

@unnawut you have done so much already, so i am already more then happy! If you can take this on anytime, this is just over the top :)

Thanks!

This can be closed.

Right, thanks for the follow up and thank you for all the work!

Was this page helpful?
0 / 5 - 0 ratings