www.digitalmars.com         C & C++   DMDScript  

digitalmars.D - http://wiki.dlang.org/Starting_as_a_Contributor reorganization

reply Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
http://wiki.dlang.org/Starting_as_a_Contributor has multiple 
sections, each divided into subsections dedicated to distinct 
operating systems. As someone who started this document, I am 
thankful for the value added.

There's a problem though: I realized it a while ago while reading 
some assembly instructions for a piece of furniture, which were 
structured similarly for multiple languages (English, Spanish, 
French, Portuguese, ...). They were quite difficult to follow, 
and it was striking to realize that any given reader would have 
similar difficulties because they want to follow one language 
through, not each step explained in all available languages.

Similarly, the current structure of our document works against 
its readability. A given reader is likely to follow all steps 
under a given operating system, not each step on several 
operating systems.

I see Vladimir and Jack did these changes. Could you please 
restructure the document into three - one for each of the OSs we 
support?


Thanks,

Andrei
Dec 14 2015
next sibling parent reply Vladimir Panteleev <thecybershadow.lists gmail.com> writes:
On Monday, 14 December 2015 at 20:47:27 UTC, Andrei Alexandrescu 
wrote:
 I see Vladimir and Jack did these changes. Could you please 
 restructure the document into three - one for each of the OSs 
 we support?
As long as the text itself is not copy-pasted (could be done using wiki templates). Previously we had wildly inconsistent instructions (and to some extent the problem still exists with http://wiki.dlang.org/Using_Git_on_Windows), where e.g. one page said "first clone upstream as origin and then add your fork" and another said "first fork, clone your fork as origin and add upstream" and then the "origin" remote would point to different things depending on which instructions you followed. I won't be home until next year though.
Dec 14 2015
parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 12/14/15 4:14 PM, Vladimir Panteleev wrote:
 On Monday, 14 December 2015 at 20:47:27 UTC, Andrei Alexandrescu wrote:
 I see Vladimir and Jack did these changes. Could you please
 restructure the document into three - one for each of the OSs we support?
As long as the text itself is not copy-pasted (could be done using wiki templates). Previously we had wildly inconsistent instructions (and to some extent the problem still exists with http://wiki.dlang.org/Using_Git_on_Windows), where e.g. one page said "first clone upstream as origin and then add your fork" and another said "first fork, clone your fork as origin and add upstream" and then the "origin" remote would point to different things depending on which instructions you followed. I won't be home until next year though.
Yah, the steps should take the repos to similar states on all OSs. Who can take this? Thanks! -- Andrei
Dec 14 2015
prev sibling parent reply Jack Stouffer <jack jackstouffer.com> writes:
On Monday, 14 December 2015 at 20:47:27 UTC, Andrei Alexandrescu 
wrote:
 I see Vladimir and Jack did these changes. Could you please 
 restructure the document into three - one for each of the OSs 
 we support?
Sure, but we need to find a way to make sure that the decentralization doesn't cause the info to become stale, as the reason the different pages were consolidated was the wildly inaccurate info on some old pages. I also still have to incorporate http://wiki.dlang.org/Using_Git_on_Windows into the page.
Dec 15 2015
next sibling parent Andrei Alexandrescu <SeeWebsiteForEmail erdani.org> writes:
On 12/15/2015 04:21 PM, Jack Stouffer wrote:
 On Monday, 14 December 2015 at 20:47:27 UTC, Andrei Alexandrescu wrote:
 I see Vladimir and Jack did these changes. Could you please
 restructure the document into three - one for each of the OSs we support?
Sure, but we need to find a way to make sure that the decentralization doesn't cause the info to become stale, as the reason the different pages were consolidated was the wildly inaccurate info on some old pages. I also still have to incorporate http://wiki.dlang.org/Using_Git_on_Windows into the page.
Thanks very much! -- Andrei
Dec 15 2015
prev sibling parent reply Jacob Carlborg <doob me.com> writes:
On 2015-12-15 22:21, Jack Stouffer wrote:

 I also still have to incorporate
 http://wiki.dlang.org/Using_Git_on_Windows into the page.
Is that page something that is necessary for us to provide? There should be a lot of documentation available out there. -- /Jacob Carlborg
Dec 15 2015
parent Jack Stouffer <jack jackstouffer.com> writes:
On Wednesday, 16 December 2015 at 07:53:38 UTC, Jacob Carlborg 
wrote:
 On 2015-12-15 22:21, Jack Stouffer wrote:

 I also still have to incorporate
 http://wiki.dlang.org/Using_Git_on_Windows into the page.
Is that page something that is necessary for us to provide? There should be a lot of documentation available out there.
Most likely not. I have dropped most of the content from the other pages that I merged into this one as it was unnecessary/out of date. But I haven't even looked at the page yet so who knows.
Dec 16 2015