www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - [RFC] D Improvement Proposals: Move to git + markdown?

reply Seb <seb wilzba.ch> writes:
Hi all,

as mentioned in a previous thread, I thought it would be cool to 
have all DIPs in a git repo as many DIPs had wrong "status" 
headers.

It turns out, it is not that much work & I quickly went ahead 
with a small export & convert to markdown script [2].
Moreover it converts the header to YAML, so we can easily use the 
Jekyll static page generator (=the tool behind Github pages). 
Thus putting it up to the web is as easy as pushing a commit and 
then it can be easily viewed like this:

http://wilzbach.github.io/d-dip/DIP57
http://wilzbach.github.io/d-dip/DIP85

A couple of advantages:

1) Full page generator engine included - extending the setup or 
template is easy
2) Dlang theme/branding -> official status
3) In future: Detailed Git history
4) Peer-review on Github
5) Plain-text (+offline access)
6) Static html -> faster page load
7) Github Pages "workflow" (no CI or deployment)

That being said I have to admit that the automatic conversion is 
not entirely perfect and it currently is only a mirror of the 
wiki. So some files require a bit of manual work which I wouldn't 
mind doing if we go this road.

Anyhow my question was: do you like the move to a git repository 
and markdown?
How about github.com/dlang/dips and dips.dlang.org?

To give the coming discussion two counter-arguments. Firstly the 
maintenance time is really small - it's just about reviewing PRs 
as we already do for dlang.org. Secondly other languages like 
Python[2] or Rust [3] also use a version control system.

Cheers,

Seb

[1] 
http://forum.dlang.org/post/vwerejpqbfpkgkgcallb forum.dlang.org
[2] https://github.com/wilzbach/d-dip/blob/gh-pages/download.sh
[3] https://hg.python.org/peps/
[3] https://github.com/rust-lang/rfcs
Apr 28 2016
next sibling parent Vladimir Panteleev <thecybershadow.lists gmail.com> writes:
On Thursday, 28 April 2016 at 08:28:20 UTC, Seb wrote:

 Anyhow my question was: do you like the move to a git 
 repository and markdown?
 How about github.com/dlang/dips and dips.dlang.org?


Personally I think it's unnecessary.

DIPs are generally drafted by one person (as their language 
improvement proposal document), and it doesn't make a lot of 
sense to peer-review changes to such edits. It would be an 
unnecessary hurdle for them, for the most part.


 2) Dlang theme/branding -> official status


A dlang.org theme for wiki.dlang.org has been on my list for a 
while, but I welcome anyone to have a go at it. It would need to 
be generated from the same DDoc files as the website (in the same 
way as it's done for the forum), so it stays in sync with future 
changes, though.
Apr 28 2016
prev sibling parent reply =?UTF-8?B?Tm9yZGzDtnc=?= <per.nordlow gmail.com> writes:
On Thursday, 28 April 2016 at 08:28:20 UTC, Seb wrote:

 A couple of advantages:

 1) Full page generator engine included - extending the setup or 
 template is easy
 2) Dlang theme/branding -> official status
 3) In future: Detailed Git history
 4) Peer-review on Github
 5) Plain-text (+offline access)
 6) Static html -> faster page load
 7) Github Pages "workflow" (no CI or deployment)

 That being said I have to admit that the automatic conversion 
 is not entirely perfect and it currently is only a mirror of 
 the wiki. So some files require a bit of manual work which I 
 wouldn't mind doing if we go this road.


I'm in favour of this, Seb. IMO, the pros outweigh the cons. 
Integrated peer-review is a big win.
May 08 2016
parent reply Seb <seb wilzba.ch> writes:
On Sunday, 8 May 2016 at 11:39:45 UTC, Nordlöw wrote:

 I'm in favour of this, Seb. IMO, the pros outweigh the cons. 
 Integrated peer-review is a big win.


We already see at our github repos that peer review/help is 
great, so why not for the DIPs?
May 26 2016
parent reply Seb <seb wilzba.ch> writes:
On Thursday, 26 May 2016 at 22:05:52 UTC, Seb wrote:

 On Sunday, 8 May 2016 at 11:39:45 UTC, Nordlöw wrote:

 I'm in favour of this, Seb. IMO, the pros outweigh the cons. 
 Integrated peer-review is a big win.


 We already see at our github repos that peer review/help is 
 great, so why not for the DIPs?


Pinging this one last time as "consensus on strategies, basic 
project management for bigger features, better administration of 
DIPs and module review queue" is on the draft vision of Andrei 
and Walter for the next six months!
Jun 07 2016
next sibling parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 6/7/16 10:50 PM, Seb wrote:

 On Thursday, 26 May 2016 at 22:05:52 UTC, Seb wrote:

 On Sunday, 8 May 2016 at 11:39:45 UTC, Nordlöw wrote:

 I'm in favour of this, Seb. IMO, the pros outweigh the cons.
 Integrated peer-review is a big win.


 We already see at our github repos that peer review/help is great, so
 why not for the DIPs?


 Pinging this one last time as "consensus on strategies, basic project
 management for bigger features, better administration of DIPs and module
 review queue" is on the draft vision of Andrei and Walter for the next
 six months!


Yes, please add it to the draft vision wiki 
https://wiki.dlang.org/Vision/2016H2_(Draft). Thanks! -- Andrei
Jun 07 2016
prev sibling parent reply Dicebot <public dicebot.lv> writes:
On Tuesday, 7 June 2016 at 20:50:48 UTC, Seb wrote:

 On Thursday, 26 May 2016 at 22:05:52 UTC, Seb wrote:

 On Sunday, 8 May 2016 at 11:39:45 UTC, Nordlöw wrote:

 I'm in favour of this, Seb. IMO, the pros outweigh the cons. 
 Integrated peer-review is a big win.


 We already see at our github repos that peer review/help is 
 great, so why not for the DIPs?


 Pinging this one last time as "consensus on strategies, basic 
 project management for bigger features, better administration 
 of DIPs and module review queue" is on the draft vision of 
 Andrei and Walter for the next six months!


FYI: I'd like to take over DIP management, currently drafting out 
process and tools for new system ( 
https://github.com/Dicebot/DIPs )
Jun 07 2016
parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 6/8/16 8:32 AM, Dicebot wrote:

 FYI: I'd like to take over DIP management, currently drafting out
 process and tools for new system ( https://github.com/Dicebot/DIPs )


That would be great, thanks for your service! -- Andrei
Jun 08 2016