<div dir="ltr"><p dir="ltr"><br>
On Feb 17, 2014 11:33 PM, "Gordon Guthrie" <<a href="mailto:gordon@vixo.com" target="_blank">gordon@vixo.com</a>> wrote:<br>
><br>
> This is what I sent to Francesco<br>
><br>
> ****************************************************************************************<br>
><br>
> Building The Erlang Community<br>
><br>
> Background<br>
><br>
> Erlang has long lacked a solid community core to act as a place where users can discover existing modules and include them in their projects.<br>
><br>
> rebar now provides the standard mechanism to include external dependencies - this proposal is about making erldocs the standard place to discover community contributions.<br>
><br>
> Proposal 1<br>
><br>
> The proposal is that people who publish open source Erlang modules on GitHub be able to have them listed on erldocs.<br>
><br>
> The process would be two part:<br>
><br>
> commit a page called ERLDOCS.terms to github in the root next to README.md<br>
><br>
> submit the URL to a page on erldocs<br>
><br>
> erldocs would sook the github page into a community section<br>
><br>
><br>
> The structure of the ERLDOCS.terms file is simple tagged tuples, something like:<br>
><br>
> {name, "Starling"}.<br>
><br>
> {license, "EPL"}.<br>
><br>
> {description, "Unicode support for Erlang"}.<br>
><br>
> {details, "A C-Port wrapped around the ICU library for unicode"}.<br>
><br>
> {status, "production"}. % alpha | beta | production<br>
><br>
> {rebar, {version, "1"}, {starling, {git, "git://<a href="http://github.com/hypernumbers/starling.git" target="_blank">github.com/hypernumbers/starling.git</a>","master"}}}.<br>
><br>
> Proposal 2<br>
><br>
> Dale Harvey originally intended that erldocs should include the ability for members of the community to annotate the official documents with examples, links to tutorials etc, etc.<br>
><br>
> erldocs be so extended (by use of Disqus or other standard commenting systems)<br>
><br>
> Requirements For Success<br>
><br>
> Erldocs 'failed' last time out because the OTP team changed the way documents were generated, and Dale Harvey moved on from an Erlang shop to Mozilla.<br>
><br>
> In order for this to work Erlang Solutions has to commit to:<br>
><br>
> erldocs being the official community repository for Erlang documentation - linked to directly from <a href="http://erlang.org" target="_blank">erlang.org</a><br>
><br>
> production of these documents needs to be integrated into the OTP Team's release schedule<br>
><br>
> Modalities<br>
><br>
> If Erlang Solutions so agree the next stage would be to approach a number of suppliers of top-notch Erlang open source and sign them up for launch. My working list would be:<br>
><br>
> Erlang Solutions<br>
><br>
> Basho<br>
><br>
> Erlware<br>
><br>
> Mats Cronquist<br>
><br>
> Richard Carlsson<br>
><br>
> Yaws<br>
><br>
> Mochiweb<br>
><br>
> Nitrogen<br>
><br>
> Cowboy<br>
><br>
> Web Machine<br>
><br>
> Hypernumbers<br>
><br>
><br>
> There would need to be consultation with the launch group regarding the structure and elements of the term file.<br>
><br>
> Once they were onboard and the production cycle had been tested - an open launch on the mailing list.<br>
><br>
><br>
> ****************************************************************************************<br>
><br>
> The key point is that a community is only a real community if you choose to join it. I was 'joined' to the Agner community (and there have been other attempts, Erlware, CEAN, etc) but they don't stick.<br>



><br>
> Gordon<br>
><br>
></p><p dir="ltr"><br></p><p>Please don't build a community over a private company (github). I sure don't want to depends on Github to publish a doc. The doc system should be enough smart to handle multiple sources. This is what godoc is able to. Also readthedoc can be a good source of inspiration....</p>

<p><br></p><p>- benoit<br><br></p>
<p dir="ltr">> On 17 February 2014 22:28, Mark Allen <<a href="mailto:mallen@alertlogic.com" target="_blank">mallen@alertlogic.com</a>> wrote:<br>
>><br>
>> On 2/17/14 4:21 PM, "Garrett Smith" <<a href="mailto:g@rre.tt" target="_blank">g@rre.tt</a>> wrote:<br>
>> >> On 2/17/14 1:51 PM, "Vixo" <<a href="mailto:gordon@hypernumbers.com" target="_blank">gordon@hypernumbers.com</a>> wrote:<br>
>> >>>My suggestion would be a manifest file of Erlang terms at the root level<br>
>> >>>of a GitHub page (they will *all* be on GitHub) that can be polled and<br>
>> >>>turned into a static site. The logical thing to do would be combine thus<br>
>> >>>with the revived erldocs site IMHO (as I have said to Francesco)<br>
>><br>
>> >Does this require that all of github be crawled?<br>
>><br>
>> No. I'm pretty sure we can segment the crawl to only projects with some X<br>
>> threshold of Erlang. (I'll have a slice without so much rat in it. [0])<br>
>><br>
>> >Would a github based index make sense? Complete with a liberal pull<br>
>> >request policy?<br>
>><br>
>> Most likely, yes, using github pages with a nice custom domain would be a<br>
>> Good Thing for this type of project.  The code to do the crawl and build<br>
>> the index should be open source too, imo.<br>
>><br>
>> Mark<br>
>><br>
>> [0]:<br>
>> <a href="http://en.wikiquote.org/wiki/Monty_Python's_Flying_Circus#The_Money_Program" target="_blank">http://en.wikiquote.org/wiki/Monty_Python's_Flying_Circus#The_Money_Program</a><br>
>> me_.5B3.03.5D<br>
>><br>
><br>
><br>
><br>
> -- <br>
> ---<br>
> Gordon Guthrie<br>
> CEO <a href="http://vixo.com" target="_blank">vixo.com</a><br>
> @gordonguthrie<br>
> <a href="tel:%2B44%20%280%29%207776%20251669" value="+447776251669" target="_blank">+44 (0) 7776 251669</a> (in Bonnie Scotland!)<br>
><br>
> vixo is made in Scotland from electrons<br>
><br>
> _______________________________________________<br>
> erlang-questions mailing list<br>
> <a href="mailto:erlang-questions@erlang.org" target="_blank">erlang-questions@erlang.org</a><br>
> <a href="http://erlang.org/mailman/listinfo/erlang-questions" target="_blank">http://erlang.org/mailman/listinfo/erlang-questions</a><br>
><br>
</p>
</div>