Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]

Groups > comp.lang.javascript > #29019

Re: [FAQ] Repository on GitHub, license, review cycle

Show all headers | View raw

Thomas 'PointedEars' Lahn wrote:
 > Hello all,
 >
 > some of you might have noticed already that, as I indicated recently [0],
 > this weekend I have migrated the code repository for the “FAQ for
 > comp.lang.javascript” (“the FAQ”) from SVN to Git, and published it on
 > GitHub:
 >
 >    <https://github.com/PointedEars/faq-cljs>

Great news! I have waited for years someone starts maintaining the FAQ. 
Hope with the community efforts FAQ to be improved and keep in good 
shape as it is.

If I remember correct, the maintaining of FAQ was dropped in the time 
when ES5 was released. Today there is ES2015 a.k.a. ES6 is officially 
approved and I think there would be many new frequently asked questions. 
By today, the most common question is "How can I use ES6 in ES5 
environment?". Babel transpiler fills that gap, and if you browse npm 
packages you can notice how many packages are written in ES6.

 > It is my intention (as explained in the README there), in addition to
 > considering FAQ contributions via the already known channels [1], to 
review
 > Pull Requests for the “dev” branch of that repository (as it is 
customary,
 > “master” is the name of the stable branch on which the live version is
 > based).  I will continue to post here a summary of the suggestions 
for the
 > FAQ that I have and receive from you via those channels, and other 
*direct*
 > channels (like social media), for public discussion.

The contributions process seems pretty straightforward, but I think 
before PR, it should be open for discussion either via a github issue or 
thread here. My predictions, since FAQ is available in github the common 
approach would be using github's bug tracking system. This would lead to 
fragmented discussion, so you have to consider how to prevent it.

 > ... via Markdown ...

As we have discussed in twitter, as long FAQ is in github Markdown 
format would be pretty convenience and straightforward for github users, 
but of course every new entry and changes should be added after 
discussion here or in github, could be discussed in both places.

 > To make contributions even easier, I intend to publish the FAQ 
content under
 > the Creative Commons Attribution-NonCommercial-ShareAlike 4.0 
International
 > (CC BY-NC-SA 4.0) License.  AIUI, this change would only codify the 
existing
 > informal agreement, and it had some support [3].
 >
 > Why that license?
 >
 >    - Although it contains code examples, the FAQ content is more like 
a book
 >      than a piece of software; so a software license is not the 
appropriate
 >      type of license for it.  Creative Commons fill that gap by providing
 >      free *content* licenses.

You are correct, but there are many examples of softwares which include 
their own FAQ and the FAQ is not separately licensed under other license 
than the main project.
I think some entries of c.l.js FAQ could be included in some open source 
projects licensed under MIT, BSD and LGPL. Those licensed are pretty 
relaxed and the code can be used for commercial purposes, so if they use 
c.l.js FAQ entries, they have to distribute their FAQ or doc separately 
under (CC BY-NC-SA 4.0).

Please reply with your thoughts about the above statement.

Back to comp.lang.javascript | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread

Thread

[FAQ] Repository on GitHub, license, review cycle Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2015-12-13 18:02 +0100
  Re: [FAQ] Repository on GitHub, license, review cycle "danca (Daniele Campagna)" <cyberdanny@tiscalinet.it> - 2015-12-13 21:04 +0100
    Re: [FAQ] Repository on GitHub, license, review cycle Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2015-12-15 09:46 +0100
  Re: [FAQ] Repository on GitHub, license, review cycle Joao Rodrigues <groups_jr-1@yahoo.com.br> - 2015-12-14 15:22 -0200
    Re: [FAQ] Repository on GitHub, license, review cycle John Harris <niam@jghnorth.org.uk.invalid> - 2015-12-20 11:49 +0000
  Re: [FAQ] Repository on GitHub, license, review cycle Asen Bozhilov <asen.bozhilov@gmail.com> - 2015-12-16 22:35 +0200
    Re: [FAQ] Repository on GitHub, license, review cycle Cezary Tomczyk <cezary.tomczyk@gmail.com> - 2015-12-17 00:05 +0100
    Re: [FAQ] Repository on GitHub, license, review cycle Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2015-12-17 00:41 +0100
  [FAQ] Updates (was: [FAQ] Repository on GitHub, license, review cycle) Thomas 'PointedEars' Lahn <PointedEars@web.de> - 2016-02-09 01:30 +0100

csiph-web