www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - Articles/Doc repo on Official dlang github

reply dewitt <dkdewitt gmail.com> writes:
I don't know if this has been asked before and I am too lazy to 
search.  Has anyone brought up the idea of adding a repo to the 
official dlang project on github with Articles.  I know the 
website has a section but think that a repo with md files might 
get more collaboration and result in more useful articles.  I see 
with dotnet they have the

https://github.com/dotnet/apireviews

repo that contains a lot of md files some useful and some not so 
much.  This is NOT a discussion about the website and peoples 
opinion as I have none due to not really looking into the process 
one way or another.  I am just wondering if a github repo would 
give more visibility and allow for more collaboration and more 
information readily available?  Seems there could be more 
articles on say the Allocators or best practices for X,Y,Z and 
could be actively updated.

I guess one could argue the blog would be the place but I think 
the articles currently in the section and more being actively 
written may be good and Pull Request would allow a good review 
process for them?

No need for a huge discussion or OT on this but looking at this 
dotnet example not necessarily the structure of project but 
general idea may be useful and see more traffic.  At least I know 
I would find it convenient and easily searchable.
Jun 15 2016
parent reply Steven Schveighoffer <schveiguy yahoo.com> writes:
On 6/15/16 1:51 PM, dewitt wrote:

 I don't know if this has been asked before and I am too lazy to search.
 Has anyone brought up the idea of adding a repo to the official dlang
 project on github with Articles.  I know the website has a section but
 think that a repo with md files might get more collaboration and result
 in more useful articles.  I see with dotnet they have the


They are already on github:

https://github.com/dlang/dlang.org

-Steve
Jun 15 2016
parent reply dewitt <dkdewitt gmail.com> writes:
On Wednesday, 15 June 2016 at 18:20:19 UTC, Steven Schveighoffer 
wrote:

 On 6/15/16 1:51 PM, dewitt wrote:

 I don't know if this has been asked before and I am too lazy 
 to search.
 Has anyone brought up the idea of adding a repo to the 
 official dlang
 project on github with Articles.  I know the website has a 
 section but
 think that a repo with md files might get more collaboration 
 and result
 in more useful articles.  I see with dotnet they have the


 They are already on github:

 https://github.com/dlang/dlang.org

 -Steve


Are you talking the dd files?  I am saying markdown that you can 
just click in github and view.  If it is the dd files then that 
process, although not hard if more tedious for collaborating than 
markdown that can easily be viewed in my opinion.  Plus that 
consists of the entire dlang site.  a separate repo would serve a 
specific purpose of holding articles that people could view 
easily on github.  Plus I believe a PR for MD would be easy to 
view how the file would look in the PR itself.  Thats just my 
opinion.
Jun 15 2016
next sibling parent Seb <seb wilzba.ch> writes:
On Wednesday, 15 June 2016 at 19:34:13 UTC, dewitt wrote:

 On Wednesday, 15 June 2016 at 18:20:19 UTC, Steven 
 Schveighoffer wrote:

 On 6/15/16 1:51 PM, dewitt wrote:

 I don't know if this has been asked before and I am too lazy 
 to search.
 Has anyone brought up the idea of adding a repo to the 
 official dlang
 project on github with Articles.  I know the website has a 
 section but
 think that a repo with md files might get more collaboration 
 and result
 in more useful articles.  I see with dotnet they have the


 They are already on github:

 https://github.com/dlang/dlang.org

 -Steve


 Are you talking the dd files?  I am saying markdown that you 
 can just click in github and view.  If it is the dd files then 
 that process, although not hard if more tedious for 
 collaborating than markdown that can easily be viewed in my 
 opinion.  Plus that consists of the entire dlang site.  a 
 separate repo would serve a specific purpose of holding 
 articles that people could view easily on github.  Plus I 
 believe a PR for MD would be easy to view how the file would 
 look in the PR itself.  Thats just my opinion.


A couple of points maybe are useful to you:

- We use the same approach for tour.dlang.org and since yesterday 
every chapter is a small markdown file that is just a button 
click away.
We already got people who want to contribute content that you 
could consider as an article, e.g. [2].

- In future D's DIPs will be written in Markdown (WIP at [3]).

- There is also awesome-d [4], which is just a big link 
collection, but also written in Markdown.

[1] http://tour.dlang.org/
[2] https://github.com/stonemaster/dlang-tour/pull/289
[3] https://github.com/Dicebot/DIPs
[4] https://github.com/zhaopuming/awesome-d
Jun 15 2016
prev sibling parent Steven Schveighoffer <schveiguy yahoo.com> writes:
On 6/15/16 3:34 PM, dewitt wrote:

 On Wednesday, 15 June 2016 at 18:20:19 UTC, Steven Schveighoffer wrote:

 On 6/15/16 1:51 PM, dewitt wrote:

 I don't know if this has been asked before and I am too lazy to search.
 Has anyone brought up the idea of adding a repo to the official dlang
 project on github with Articles.  I know the website has a section but
 think that a repo with md files might get more collaboration and result
 in more useful articles.  I see with dotnet they have the


 They are already on github:

 https://github.com/dlang/dlang.org


 Are you talking the dd files?  I am saying markdown that you can just
 click in github and view.  If it is the dd files then that process,
 although not hard if more tedious for collaborating than markdown that
 can easily be viewed in my opinion.


The standard on the D website is that they should be in ddoc form. All I 
was saying is that you can use github to propose, comment on, or fix 
articles already. Yes, github isn't going to render it for you, but 
Vladimir's auto-tester will.


  Plus that consists of the entire
 dlang site.  a separate repo would serve a specific purpose of holding
 articles that people could view easily on github.


Or, we could put the articles in their own directory. The flat structure 
of the web site files is pretty difficult to navigate, I think.

-Steve
Jun 15 2016