search

minishift / minishift-addons

A repository for the community to exchange Minishift add-ons
Apache License 2.0
71 stars 86 forks source link

Asciidoc or Markdown for READMEs? #64

Open coolbrg opened 6 years ago

coolbrg commented 6 years ago

Currently, we are have all existing add-on README's in markdown(.md) format. However, our project README and contributing doc are in Asciidoc(.adoc).

Few PRs are there whose README are in Asciidoc - See Istio PR and in Markdown - See Ansible Service Broker PR.

We need to decide a consistent format here.

/cc @minishift/minishift-dev

LalatenduMohanty commented 6 years ago

+1 for consistency. I think markdown is fine for each add-on readme as it is easy to write in markdown as compared to asciidoc. I somehow thought we decided markdown for this repository.

gbraad commented 6 years ago

markdown preferred, unless needed... such having the readme in markdown, but have a technical explanation in asciidocs (as a separate file).

On Thu, Dec 21, 2017 at 2:34 PM, Lalatendu Mohanty <notifications@github.com

wrote:

+1 for consistency. I think markdown is fine for each add-on readme as it is easy to write in markdown as compared to asciidoc. I somehow thought we decided markdown for this repository.

— You are receiving this because you are on a team that was mentioned. Reply to this email directly, view it on GitHub https://github.com/minishift/minishift-addons/issues/64#issuecomment-353270012, or mute the thread https://github.com/notifications/unsubscribe-auth/AAAHZpPEz3eKMPAb85YO9OVZeX-qyzz4ks5tCfwJgaJpZM4RApmk .

--

Gerard Braad | http://gbraad.nl [ Doing Open Source Matters ]