Re: How, precisely, can we improve?

Richard, thank you for trying to give this some technical basis. As someone who as contributed some tiny bugfixes to ghc, I found the process a bit cumbersome, yet manageable[1]. I’d however like to propose some concrete changes, and please excuse if these have been discussed and found to not be actionable. What I’d really like to see improved is the “multiple (web)services, multiple accounts” issue solved. As it is right now I need to have a github account (ghc-proposals, soon tiny PR against ghc), a trac account (for the wiki and issue tracker; which never seems to remember me), a phabricator account[2], likely a stack overflow account for questions and answers. On top of that I also need to be on a large set of mailing lists if I want to not miss anything, and an irc client and twitter client to tap into the most recent discussions. And there’s another wiki on haskell.org for which I would need to sign up and get an approved account. I’d like to see the following: 1. Unify the issue tracker and code review into phabricator. Hence *if* I want to contribute to the ghc codebase, I essentially only need a phabricator account[3]. And a simple one page website on haskell.org that runs me through the “Contributing to GHC” as in:
GHC Development is facilitated through phabricator.
Please go to https://phabricator.haskell.org[4] and create an account.
If you want to report a bug, please file a bugreport through the “Maniphest” module, you can find on the left.
If you are looking for something to contribute, and browse the Open Tasks at https://phabricator.haskell.org/maniphest/query/open/[5]
Clone the GHC tree and build it [ clone and build instructions here; note about stage2 pinning to reduce compile times and other build system features ]
Hack to your hearts content on GHC (you might get some quick responses regarding ghc’s internals at irc://irc.freenode.net/ghc, as well as in the ghc commentary at …[6], or the ghc-dev mailing list for which you can sign up at ...)
Validate your build [ plus instructions how to do so, and how to run performance measurements on the changed ghc; if one is interested in that as well ]
Upload your patch to GHC using the arc command line tool. You will have to set up your token during the first use, just follow the instructions.
To upload your patch, commit your local changes; and run $ arc diff origin/master
arc will run a few linters against your diff, and provide you with a form to fill in all the details regarding your patch. This form is usually prepopulated with the commit messages from your local commits.
During the review process you might have to update your diff. To do so you can rebase your changes against the most recent master and/or add additional commits to it; once you are done updating your patch, run $ arc diff --update
Once your diff has been accepted, someone with commit rights with “land” your diff into the official ghc tree.
And have this prominently liked from https://www.haskell.org/ under “Contributing” 2. Move the Wiki someplace else. I don’t know if the wiki in phabricator is any good, I’ve never used it. However, finding something in the ghc wiki has been more hit and miss for me than anything else. The built in search almost never reveals what I’m looking for, and resorting to a search engine only sometimes helps me find what I’m looking for. (This might totally be my fault). 3. Reduce the number of Mailing lists. I’m supposedly not on the haskell ml; so I missed https://mail.haskell.org/pipermail/haskell/2016-September/024995.html, and only saw it due to https://twitter.com/ezyang/status/780134457101516800. Are our MLs really that high volume that we need so many? 4. I like the idea of trivial pull requests to be accepted on GH as well. And I don’t see it as a big hurdle to ask someone to please be so kind and submit the patch through phabricator if it’s more involved with a link to https://www.haskell.org/contributing (see above). In conclusion I’d like to propose to reduce the fragmentation of tooling, and accept the status quo of what open source development seems looks like to many (github for code, stackoverflow questions (and documentation soon?)) as much as we can. Cheers, Moritz — [1]: I didn’t understand phabriactor and arc in the beginning, however today I appreciate the process phabricator and arc offer a lot! (Over PRs) [2]: for which you can actually use your bitbucket, github, twitter, … account. [3]: I will also need some access to the staging area, if I want to use that feature. [4]: Can we have http://phabricator.haskell.org redirect to https://phabricator.haskell.org? Instead of having both? [5]: I guess one could create some Trivial, Easy, Medium and Hard queries. [6]: This is currently scattered across the trac wiki.
On Sep 26, 2016, at 9:27 AM, Richard Eisenberg
wrote: Like many of you, I'm sure, I'm saddened by the occasional tone of the recent exchange about contributions to GHC.
I'd like to move the conversation forward -- and I'd like to do so on a technical basis.
So, I ask: How, precisely, can we improve?
I think it would be best to have answers to this question start their own thread, as I expect several good answers to this question.
As I ask this, I am not making the assumption that we cannot, nor is this meant to be rhetorical. I am asking a question in search of precise, technical answers.
"Be more like Rust" is not an answer to this question, as it is imprecise. (I'm not at all maligning the overall goal of emulating a successful process. It's just that "be more like Rust" is not actionable.)
"Accept PRs on GitHub" *is* an answer to this question, but one we have revisited several times in recent memory. (I believe https://mail.haskell.org/pipermail/ghc-devs/2015-September/009744.html is the most recent.) Perhaps we can revisit this yet again, but it would be great if new technical content can be injected into the debate. I hope the rejection of the proposal linked there is not considered "dismissive", as the proposal generated vigorous debate -- the opposite of dismissiveness. (For what it's worth, I'm weakly in favor of accepting PRs on GitHub. However, I have no experience setting up or maintaining infrastructure for an open source project and have happily deferred to those who have such experience and who have come out against this idea.)
"Have process (X) for accepting new language features" *is* an answer to my question. This is in flight and I hope addresses the concern in the community. It seems to me that this step addresses the grievances described in "The Process" part of http://www.arcadianvisions.com/blog/2016/ghc-contributing.html
"Have a formal mentorship system" *is* another answer to my question, and one I think we can readily adopt. Can you (for all values of "you") suggest a concrete model with a link? It seems to me that folks who ask for help get the help they need. But this surely requires the courage and wherewithal to ask for the help. Perhaps there is a better way to advertise our availability and desire to mentor. I, personally, have onboarded (or attempted to) several contributors and enjoy doing so. Though my ability to mentor wanes when I have gotten busy, I have always prioritized helping out the newest contributors, letting other, more confident actors' emails slip if necessary. If I have erred, I am sorry.
"Don't be dismissive" is not an answer to my question, as it is both imprecise and not technical. The most recent thread indeed had posts that seemed quite dismissive, but these posts emanated from people with a variety of viewpoints. It was hardly GHC HQ (whatever that means). What, precisely, has been dismissed? It looks to me that we (regular GHC contributors) take the community's concerns seriously. Fixes may be slow in coming, but that's not dismissiveness. Of course I'm biased here, but I am truly and earnestly asking for clarification.
Emboldened by the technical, respectful discussion recently on the merits (and usage patterns) of stack (starting at https://mail.haskell.org/pipermail/haskell-cafe/2016-September/124847.html), I look forward to a similarly technical, respectful discussion on our contribution process.
Thanks for all that you (for all values of "you") do to help grow our community and make it stronger.
Richard
-=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Hi, I just wanted to add a few things from a perspective of a GHC newbie. Not everything is a concrete proposal on how to improve things, but I hope it's still useful. First of all, a big +1 on what Moritz said - having everything in one system like Phab would be really nice. But I also want to second what Richard Fung said in another thread - the biggest barrier for involvement for me is understanding the code (i.e., it’s a complex and large project). Yes, Phab/Trac are an additional hassle, but for me not really that significant compared to the task of understanding what’s happening in the compiler (although small, localized contributions might be an exception here!). So let's start with the things that I personally find helpful :-) - Some of the documentation on Trac is great (e.g., "I know kung fu: learning STG by example" [1] is amazing!) - “Notes” in the code (especially the ones that give concrete examples of how we want to transform the code and why!) are super useful. - Modify & compile cycle is super quick when using `make 1` or `make 2` in `compiler/`. - Ability to use `Outputable` instances with `Debug.Trace.trace` works surprisingly well. (Although mapping the output from `Outputable` back to AST can be non-trivial!) Things that I find problematic: - Some of the documentation on Trac is outdated or appears to be a "work in progress" but hasn't been updated in years. So getting a clear idea of what’s the current status, is not always easy. Also, it's not always easy to find... Maybe documentation on the wiki could follow the directory/module structure more closely? (also making it more obvious when it gets out of date) - There's a lot of knowledge that seems to be assumed from the reader. I'm guessing that most of the key concepts are obvious for regular contributors. But this can be quite challenging for newcomers and unfortunately explanations can be spread around across code, papers, etc. (e.g., it took me a while to understand what's the deal with "join-points" and "let-no-escape"). Not sure how to solve this, except for having better documentation... - Validate often fails. Workaround: run `./validate` without a patch and then with the patch. If there are no differences, it's probably unrelated. It'd be much nicer if this wasn't necessary. - Coding style. I personally do find it quite distracting to jump between modules that are using a different style (often wildly different!). It definitely does slow me down. And bad formatting can be actually pretty harmful, e.g., not that long ago, I wasted half an hour just because of a weird formatting of a do-block! [3] Finally, note that coding style is pretty much a standard today, so many people expect it in well maintained codebases and might see the current state as "messy". (And perceptions do matter sometimes!) The solution here would be to adopt an official coding style (e.g., [2]). Anyway, I hope you find this useful. :-) Cheers, Michal [1] https://ghc.haskell.org/trac/ghc/wiki/Commentary/Compiler/GeneratedCode [2] https://github.com/tibbe/haskell-style-guide [3] I was looking at a do-block like this: do { A ; … … … … ; B } where it seems that both A and B should always execute. Except that, after closer examination, there were two blocks present! do { A ; … … foobar $ \x -> do … ; B } They were just indented to make it appear as if there was just one! :-(

Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely: * We currently have *3* wikis: https://wiki.haskell.org/Haskell https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/ It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org in an easily reachable place. * To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too. * https://haskell-lang.org/ has great stuff on it, but its relationship to haskell.org is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org should be seamlessly integrated into haskell.org, i.e. merged into it. Having an endless sea of links on haskell.org is not the same as having content nicely integrated into it, sorted by topic, etc. All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc. Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve... Cheers, S.

We currently have *3* wikis:
https://wiki.haskell.org/Haskellhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals:
· https://wiki.haskell.org/Haskellhttps://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
From: ghc-devs [mailto:ghc-devs-bounces@haskell.org] On Behalf Of Sven Panne
Sent: 27 September 2016 08:46
To: ghc-devs

I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation Alan On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs < ghc-devs@haskell.org> wrote:
We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals:
· https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
*From:* ghc-devs [mailto:ghc-devs-bounces@haskell.org] *On Behalf Of *Sven Panne *Sent:* 27 September 2016 08:46 *To:* ghc-devs
*Subject:* Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhaskell-lang.org%2F&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=9ndNQVeDQy7lPb4qmn13k%2BAtztK8F9Hq%2B2jeXKm9YFU%3D&reserved=0 has great stuff on it, but its relationship to haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 should be seamlessly integrated into haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0, i.e. merged into it. Having an endless sea of links on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers,
S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Thanks for the link Alan. I can personally attest to being intimidated by GHC's wiki when I started contributing. I think having a review mechanism in place would have helped, because then you at least know that one or two other people think your content is clear. On a more minor note, I know the trac wiki has a history feature, but for some reason I find it much less useful than a git history. Perhaps this is just an issue of familiarity. On Tue, Sep 27, 2016, at 07:54, Alan & Kim Zimmerman wrote:
I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation
Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs < ghc-devs@haskell.org> wrote:
We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals:
· https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
*From:* ghc-devs [mailto:ghc-devs-bounces@haskell.org] *On Behalf Of *Sven Panne *Sent:* 27 September 2016 08:46 *To:* ghc-devs
*Subject:* Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhaskell-lang.org%2F&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=9ndNQVeDQy7lPb4qmn13k%2BAtztK8F9Hq%2B2jeXKm9YFU%3D&reserved=0 has great stuff on it, but its relationship to haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 should be seamlessly integrated into haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0, i.e. merged into it. Having an endless sea of links on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers,
S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR. But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push. Is this perhaps an easy improvement we can enact? Note that we’re already moving in this direction with ghc-proposals, which subsumes a large part of what the GHC dev wiki has been used for. -=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
On Sep 27, 2016, at 11:32 AM, Eric Seidel
wrote: Thanks for the link Alan.
I can personally attest to being intimidated by GHC's wiki when I started contributing. I think having a review mechanism in place would have helped, because then you at least know that one or two other people think your content is clear.
On a more minor note, I know the trac wiki has a history feature, but for some reason I find it much less useful than a git history. Perhaps this is just an issue of familiarity.
On Tue, Sep 27, 2016, at 07:54, Alan & Kim Zimmerman wrote:
I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation
Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs < ghc-devs@haskell.org> wrote:
We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals:
· https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
*From:* ghc-devs [mailto:ghc-devs-bounces@haskell.org] *On Behalf Of *Sven Panne *Sent:* 27 September 2016 08:46 *To:* ghc-devs
*Subject:* Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0
https://ghc.haskell.org/trac/ghc
https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhaskell-lang.org%2F&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=9ndNQVeDQy7lPb4qmn13k%2BAtztK8F9Hq%2B2jeXKm9YFU%3D&reserved=0 has great stuff on it, but its relationship to haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 should be seamlessly integrated into haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0, i.e. merged into it. Having an endless sea of links on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers,
S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki.. There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout. I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere. Eric

On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc. It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible. Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them. The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it. Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause. Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Therefore, what about "a search system for multiple wiki sites"?
sorry, less information.
I mean like this.
Google search:
"dependent haskell site:ghc.haskell.org/trac/ghc/wiki OR site:
wiki.haskell.org"
Regards,
Takenobu
2016-09-28 21:29 GMT+09:00 Takenobu Tani
Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

I like your perspective on this
On Wednesday, September 28, 2016, Takenobu Tani
Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
javascript:_e(%7B%7D,'cvml','rae@cs.brynmawr.edu');>: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
javascript:_e(%7B%7D,'cvml','mgsloan@gmail.com');> wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
javascript:_e(%7B%7D,'cvml','eric@seidel.io');> wrote: pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org javascript:_e(%7B%7D,'cvml','ghc-devs@haskell.org'); http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org javascript:_e(%7B%7D,'cvml','ghc-devs@haskell.org'); http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org javascript:_e(%7B%7D,'cvml','ghc-devs@haskell.org'); http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Hi Carter,
Thank you very much :)
We love haskell,
Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
I like your perspective on this
On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

I've spent some time thinking about how and what to synthesize from this conversation. Moritz has captured much of these ideas in the proposal he submitted. Thanks. But that proposal tackles only one part of the problem: what to do in the future. It does not address the insufficiencies of the wiki as it now stands, and these drawbacks seem to be the dangling fibers of this thread. Two specific complaints are that (1) search engines still find out-of-date documentation and (2) the wiki is not discoverable. I agree with both of these, but I can't think of any (easy) way to help either one. For (1), the "obvious" solution is to pull old pages. However, old pages still serve as useful documentary evidence when we need to revisit a decision made in the past. I think simply deleting out-of-date pages may lose useful info. Could we remove the pages from the wiki but keep them somewhere else, beyond the all-seeing eye of Google? Perhaps -- but where? I wouldn't want to keep it somewhere private, lest it be unavailable to the person that needs it. I think clearly labeling out-of-date info as such is the best compromise. For (2), there is an index to the wiki: https://ghc.haskell.org/trac/ghc/wiki/TitleIndex It's long and rambly, but may be of use. I agree that grepping would be nice. Does anyone know if there is a way to extract plaintext from a Trac wiki? I agree that making such a feature available would be helpful. In the future, though, even a git-backed collection will run into discoverability problems, unless someone continually keeps it organized. (It will be greppable, though.) As to the point of shoring up existing infra vs. looking more broadly: I suppose I am interesting in shoring up the existing infra, but I'm considering "existing infra" to include all the platforms I'm aware of. This explicitly includes the idea of dropping, say, Trac entirely and moving exclusively to GitHub. I think that would be a terrible idea, but it's in scope in my thinking. What's *not* in scope (in my thinking) is the idea of creating new tools that do exactly what we want. We're all developers and can imagine wonderful things, but wonderful things do not come cheaply, and we are but poor. So I'm at a loss of what to do about these remaining fibers. Concrete suggestions, anyone? Richard -=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae http://cs.brynmawr.edu/~rae
On Sep 29, 2016, at 7:37 AM, Takenobu Tani
wrote: Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
mailto:carter.schonwald@gmail.com>: I like your perspective on this On Wednesday, September 28, 2016, Takenobu Tani
mailto:takenobu.hs@gmail.com> wrote: Apologies if I’m missing context. Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
>: I'm quite leery of using a new site (readthedocs.org http://readthedocs.org/), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it. Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
> wrote: On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
> wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org <> http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org <> http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org <> http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

On Fri, Sep 30, 2016 at 4:14 AM, Richard Eisenberg
I've spent some time thinking about how and what to synthesize from this conversation. Moritz has captured much of these ideas in the proposal he submitted. Thanks.
But that proposal tackles only one part of the problem: what to do in the future. It does not address the insufficiencies of the wiki as it now stands, and these drawbacks seem to be the dangling fibers of this thread. Two specific complaints are that (1) search engines still find out-of-date documentation and (2) the wiki is not discoverable. I agree with both of these, but I can't think of any (easy) way to help either one.
For (1), the "obvious" solution is to pull old pages. However, old pages still serve as useful documentary evidence when we need to revisit a decision made in the past. I think simply deleting out-of-date pages may lose useful info. Could we remove the pages from the wiki but keep them somewhere else, beyond the all-seeing eye of Google? Perhaps -- but where? I wouldn't want to keep it somewhere private, lest it be unavailable to the person that needs it. I think clearly labeling out-of-date info as such is the best compromise.
+1 to keeping (maybe with "this is old" labels): I would much rather have a page with a series of pointers to how something was done a few years ago than to have no information at all. I'd also like to +1 the fact that having Trac's up-to-date ticket labels (e.g. crossed-out links for completed tickets) is invaluable. Tom
For (2), there is an index to the wiki: https://ghc.haskell.org/ trac/ghc/wiki/TitleIndex It's long and rambly, but may be of use. I agree that grepping would be nice. Does anyone know if there is a way to extract plaintext from a Trac wiki? I agree that making such a feature available would be helpful. In the future, though, even a git-backed collection will run into discoverability problems, unless someone continually keeps it organized. (It will be greppable, though.)
As to the point of shoring up existing infra vs. looking more broadly: I suppose I am interesting in shoring up the existing infra, but I'm considering "existing infra" to include all the platforms I'm aware of. This explicitly includes the idea of dropping, say, Trac entirely and moving exclusively to GitHub. I think that would be a terrible idea, but it's in scope in my thinking. What's *not* in scope (in my thinking) is the idea of creating new tools that do exactly what we want. We're all developers and can imagine wonderful things, but wonderful things do not come cheaply, and we are but poor.
So I'm at a loss of what to do about these remaining fibers. Concrete suggestions, anyone?
Richard
-=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
On Sep 29, 2016, at 7:37 AM, Takenobu Tani
wrote: Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
: I like your perspective on this
On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote: > Yes, I agree with Michael’s observations in the blog post. However, one > thing that’s easier about a wiki is that the editing process is much more > lightweight than making a PR. > > But GitHub has a wonderful feature (that I have rarely used) that > mitigates this problem. Viewing a file in GitHub offers a little
> icon in the top-right. It allows you to make arbitrary changes in
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil the > file and then automates the construction of a PR. The owner of the file > can then accept the PR very, very easily. If the editor has commit > rights, you can make your edits into a commit right away. No need to > fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Hi,
Richard said:
(1) search engines still find out-of-date documentation
(2) the wiki is not discoverable
I know trac is treasure house.
And I realized old pages are valuable for decision.
My concrete suggestion is here:
For (1):
When we find out-of-date documentation, we directly modify head of the
document.
We manually insert a comment like "This content is out-of-date for GHC8.0".
(New contributors easy can do it.)
For (2):
We provide manually-written multiple indexes for different views on a
portal page of the wiki site.
Contributors could maintain each index themselves.
(New comers will choose his favorite index for his exploring.)
Furthermore, we provide a simple search box for multiple wiki sites.
(Please wait for a while. I'll prepare simple-conceptual demonstration with
web.)
Diversity is strength of Haskell community,
Takenobu
2016-09-30 4:14 GMT+09:00 Richard Eisenberg
I've spent some time thinking about how and what to synthesize from this conversation. Moritz has captured much of these ideas in the proposal he submitted. Thanks.
But that proposal tackles only one part of the problem: what to do in the future. It does not address the insufficiencies of the wiki as it now stands, and these drawbacks seem to be the dangling fibers of this thread. Two specific complaints are that (1) search engines still find out-of-date documentation and (2) the wiki is not discoverable. I agree with both of these, but I can't think of any (easy) way to help either one.
For (1), the "obvious" solution is to pull old pages. However, old pages still serve as useful documentary evidence when we need to revisit a decision made in the past. I think simply deleting out-of-date pages may lose useful info. Could we remove the pages from the wiki but keep them somewhere else, beyond the all-seeing eye of Google? Perhaps -- but where? I wouldn't want to keep it somewhere private, lest it be unavailable to the person that needs it. I think clearly labeling out-of-date info as such is the best compromise.
For (2), there is an index to the wiki: https://ghc.haskell.org/ trac/ghc/wiki/TitleIndex It's long and rambly, but may be of use. I agree that grepping would be nice. Does anyone know if there is a way to extract plaintext from a Trac wiki? I agree that making such a feature available would be helpful. In the future, though, even a git-backed collection will run into discoverability problems, unless someone continually keeps it organized. (It will be greppable, though.)
As to the point of shoring up existing infra vs. looking more broadly: I suppose I am interesting in shoring up the existing infra, but I'm considering "existing infra" to include all the platforms I'm aware of. This explicitly includes the idea of dropping, say, Trac entirely and moving exclusively to GitHub. I think that would be a terrible idea, but it's in scope in my thinking. What's *not* in scope (in my thinking) is the idea of creating new tools that do exactly what we want. We're all developers and can imagine wonderful things, but wonderful things do not come cheaply, and we are but poor.
So I'm at a loss of what to do about these remaining fibers. Concrete suggestions, anyone?
Richard
-=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
On Sep 29, 2016, at 7:37 AM, Takenobu Tani
wrote: Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
: I like your perspective on this
On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote: > Yes, I agree with Michael’s observations in the blog post. However, one > thing that’s easier about a wiki is that the editing process is much more > lightweight than making a PR. > > But GitHub has a wonderful feature (that I have rarely used) that > mitigates this problem. Viewing a file in GitHub offers a little
> icon in the top-right. It allows you to make arbitrary changes in
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil the > file and then automates the construction of a PR. The owner of the file > can then accept the PR very, very easily. If the editor has commit > rights, you can make your edits into a commit right away. No need to > fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Dear Takenobu, may I politely direct you to https://github.com/ghc-proposals/ghc-proposals/pull/10, and ask you to add your comments there as well, as that proposal tries to track these changes in a central place through the new ghc-proposal process. Cheers, Moritz
On Sep 30, 2016, at 6:56 PM, Takenobu Tani
wrote: Hi,
Richard said: (1) search engines still find out-of-date documentation (2) the wiki is not discoverable
I know trac is treasure house. And I realized old pages are valuable for decision.
My concrete suggestion is here:
For (1): When we find out-of-date documentation, we directly modify head of the document. We manually insert a comment like "This content is out-of-date for GHC8.0". (New contributors easy can do it.)
For (2): We provide manually-written multiple indexes for different views on a portal page of the wiki site. Contributors could maintain each index themselves. (New comers will choose his favorite index for his exploring.)
Furthermore, we provide a simple search box for multiple wiki sites. (Please wait for a while. I'll prepare simple-conceptual demonstration with web.)
Diversity is strength of Haskell community, Takenobu
2016-09-30 4:14 GMT+09:00 Richard Eisenberg
: I've spent some time thinking about how and what to synthesize from this conversation. Moritz has captured much of these ideas in the proposal he submitted. Thanks. But that proposal tackles only one part of the problem: what to do in the future. It does not address the insufficiencies of the wiki as it now stands, and these drawbacks seem to be the dangling fibers of this thread. Two specific complaints are that (1) search engines still find out-of-date documentation and (2) the wiki is not discoverable. I agree with both of these, but I can't think of any (easy) way to help either one.
For (1), the "obvious" solution is to pull old pages. However, old pages still serve as useful documentary evidence when we need to revisit a decision made in the past. I think simply deleting out-of-date pages may lose useful info. Could we remove the pages from the wiki but keep them somewhere else, beyond the all-seeing eye of Google? Perhaps -- but where? I wouldn't want to keep it somewhere private, lest it be unavailable to the person that needs it. I think clearly labeling out-of-date info as such is the best compromise.
For (2), there is an index to the wiki: https://ghc.haskell.org/trac/ghc/wiki/TitleIndex It's long and rambly, but may be of use. I agree that grepping would be nice. Does anyone know if there is a way to extract plaintext from a Trac wiki? I agree that making such a feature available would be helpful. In the future, though, even a git-backed collection will run into discoverability problems, unless someone continually keeps it organized. (It will be greppable, though.)
As to the point of shoring up existing infra vs. looking more broadly: I suppose I am interesting in shoring up the existing infra, but I'm considering "existing infra" to include all the platforms I'm aware of. This explicitly includes the idea of dropping, say, Trac entirely and moving exclusively to GitHub. I think that would be a terrible idea, but it's in scope in my thinking. What's *not* in scope (in my thinking) is the idea of creating new tools that do exactly what we want. We're all developers and can imagine wonderful things, but wonderful things do not come cheaply, and we are but poor.
So I'm at a loss of what to do about these remaining fibers. Concrete suggestions, anyone?
Richard
-=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
On Sep 29, 2016, at 7:37 AM, Takenobu Tani
wrote: Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
: I like your perspective on this On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context. Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it. Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little pencil icon in the top-right. It allows you to make arbitrary changes in the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
————————————————— Moritz Angermann +49 170 54 33 0 74 moritz@lichtzwerge.de lichtzwerge GmbH Raiffeisenstr. 8 93185 Michelsneukirchen Amtsgericht Regensburg HRB 14723 Geschäftsführung: Moritz Angermann, Ralf Sangl USt-Id: DE291948767 Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte Informationen. Wenn Sie nicht der richtige Adressat sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie bitte sofort den Absender und vernichten Sie diese Mail. Das unerlaubte Kopieren sowie die unbefugte Weitergabe dieser Mail ist nicht gestattet. This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden.

Dear Moritz,
Oh, thank you for teaching me.
I'll write to it.
Thanks,
Takenobu
2016-09-30 20:06 GMT+09:00 Moritz Angermann
Dear Takenobu,
may I politely direct you to https://github.com/ghc- proposals/ghc-proposals/pull/10, and ask you to add your comments there as well, as that proposal tries to track these changes in a central place through the new ghc-proposal process.
Cheers, Moritz
On Sep 30, 2016, at 6:56 PM, Takenobu Tani
wrote: Hi,
Richard said: (1) search engines still find out-of-date documentation (2) the wiki is not discoverable
I know trac is treasure house. And I realized old pages are valuable for decision.
My concrete suggestion is here:
For (1): When we find out-of-date documentation, we directly modify head of the document. We manually insert a comment like "This content is out-of-date for GHC8.0". (New contributors easy can do it.)
For (2): We provide manually-written multiple indexes for different views on a portal page of the wiki site. Contributors could maintain each index themselves. (New comers will choose his favorite index for his exploring.)
Furthermore, we provide a simple search box for multiple wiki sites. (Please wait for a while. I'll prepare simple-conceptual demonstration with web.)
Diversity is strength of Haskell community, Takenobu
2016-09-30 4:14 GMT+09:00 Richard Eisenberg
: I've spent some time thinking about how and what to synthesize from this conversation. Moritz has captured much of these ideas in the proposal he submitted. Thanks. But that proposal tackles only one part of the problem: what to do in the future. It does not address the insufficiencies of the wiki as it now stands, and these drawbacks seem to be the dangling fibers of this thread. Two specific complaints are that (1) search engines still find out-of-date documentation and (2) the wiki is not discoverable. I agree with both of these, but I can't think of any (easy) way to help either one.
For (1), the "obvious" solution is to pull old pages. However, old pages still serve as useful documentary evidence when we need to revisit a decision made in the past. I think simply deleting out-of-date pages may lose useful info. Could we remove the pages from the wiki but keep them somewhere else, beyond the all-seeing eye of Google? Perhaps -- but where? I wouldn't want to keep it somewhere private, lest it be unavailable to the person that needs it. I think clearly labeling out-of-date info as such is the best compromise.
For (2), there is an index to the wiki: https://ghc.haskell.org/trac/ ghc/wiki/TitleIndex It's long and rambly, but may be of use. I agree that grepping would be nice. Does anyone know if there is a way to extract plaintext from a Trac wiki? I agree that making such a feature available would be helpful. In the future, though, even a git-backed collection will run into discoverability problems, unless someone continually keeps it organized. (It will be greppable, though.)
As to the point of shoring up existing infra vs. looking more broadly: I suppose I am interesting in shoring up the existing infra, but I'm considering "existing infra" to include all the platforms I'm aware of. This explicitly includes the idea of dropping, say, Trac entirely and moving exclusively to GitHub. I think that would be a terrible idea, but it's in scope in my thinking. What's *not* in scope (in my thinking) is the idea of creating new tools that do exactly what we want. We're all developers and can imagine wonderful things, but wonderful things do not come cheaply, and we are but poor.
So I'm at a loss of what to do about these remaining fibers. Concrete suggestions, anyone?
Richard
-=-=-=-=-=-=-=-=-=-=- Richard A. Eisenberg Asst. Prof. of Computer Science Bryn Mawr College Bryn Mawr, PA, USA cs.brynmawr.edu/~rae
On Sep 29, 2016, at 7:37 AM, Takenobu Tani
wrote: Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context. Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it. Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote:
Yes, I agree with Michael’s observations in the blog post. However, one thing that’s easier about a wiki is that the editing process is much more lightweight than making a PR.
But GitHub has a wonderful feature (that I have rarely used) that mitigates this problem. Viewing a file in GitHub offers a little
icon in the top-right. It allows you to make arbitrary changes in
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil the file and then automates the construction of a PR. The owner of the file can then accept the PR very, very easily. If the editor has commit rights, you can make your edits into a commit right away. No need to fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
————————————————— Moritz Angermann +49 170 54 33 0 74 moritz@lichtzwerge.de
lichtzwerge GmbH Raiffeisenstr. 8 93185 Michelsneukirchen
Amtsgericht Regensburg HRB 14723 Geschäftsführung: Moritz Angermann, Ralf Sangl USt-Id: DE291948767
Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte Informationen. Wenn Sie nicht der richtige Adressat sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie bitte sofort den Absender und vernichten Sie diese Mail. Das unerlaubte Kopieren sowie die unbefugte Weitergabe dieser Mail ist nicht gestattet. This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden.

Main discussion is here ( https://github.com/ghc-proposals/ghc-proposals/pull/10). BTW, I prepared a conceptual web page about following.
Furthermore, we provide a simple search box for multiple wiki sites. (Please wait for a while. I'll prepare simple-conceptual demonstration with web.)
Here is a rapid prototyping for searching multiple wiki sites. [1] [1]: https://takenobu-hs.github.io/haskell-wiki-search Regards, Takenobu

Thank you so much. I know I've said it before. But the slides / notes
you've taken the time to write and circulate before have been truely great.
How can I and others help encourage you and others to keep up the great
work on that side?
Good synthesis notes that help orientate new and old contributors for
systems they don't know or have forgotten is a powerful resource.
I hope my encouragement helps. But either way it's a skill / focus that
takes time to develop and is worth celebrating / thanking.
As always, happy to be a resource to help, but 👍 to you Takenobu! :)
On Saturday, October 1, 2016, Takenobu Tani
Main discussion is here (https://github.com/ghc- proposals/ghc-proposals/pull/10).
BTW, I prepared a conceptual web page about following.
Furthermore, we provide a simple search box for multiple wiki sites. (Please wait for a while. I'll prepare simple-conceptual demonstration with web.)
Here is a rapid prototyping for searching multiple wiki sites. [1]
[1]: https://takenobu-hs.github.io/haskell-wiki-search
Regards, Takenobu

Hi Carter,
Thank you, I'm glad to hear it :)
Haskell community is beautiful and great.
Regards,
Takenobu
2016-10-02 3:41 GMT+09:00 Carter Schonwald
Thank you so much. I know I've said it before. But the slides / notes you've taken the time to write and circulate before have been truely great.
How can I and others help encourage you and others to keep up the great work on that side?
Good synthesis notes that help orientate new and old contributors for systems they don't know or have forgotten is a powerful resource.
I hope my encouragement helps. But either way it's a skill / focus that takes time to develop and is worth celebrating / thanking.
As always, happy to be a resource to help, but 👍 to you Takenobu! :)
On Saturday, October 1, 2016, Takenobu Tani
wrote: Main discussion is here (https://github.com/ghc-propos als/ghc-proposals/pull/10).
BTW, I prepared a conceptual web page about following.
Furthermore, we provide a simple search box for multiple wiki sites. (Please wait for a while. I'll prepare simple-conceptual demonstration with web.)
Here is a rapid prototyping for searching multiple wiki sites. [1]
[1]: https://takenobu-hs.github.io/haskell-wiki-search
Regards, Takenobu

We all do!.
And I really appreciate your clear positive suggestions around "what are we
trying to understand or ask our selves"
no matter what conclusions we come to this day / month / year, its
something we will need to revisit (and should) every once in a while.
change happens, as does "growth" (for various notions of growth :) )
On Sep 29, 2016 7:37 AM, "Takenobu Tani"
Hi Carter,
Thank you very much :)
We love haskell, Takenobu
2016-09-28 22:29 GMT+09:00 Carter Schonwald
: I like your perspective on this
On Wednesday, September 28, 2016, Takenobu Tani
wrote: Apologies if I’m missing context.
Potential contributors need information from wiki.
I feel current wiki’s problems are following:
(a) reachability
"Where is the page I need?"
(b) outdated pages
"Is this page up-to-date?"
(c) update method
"How Can I update the page?"
About (a):
It's difficult to find pages they need. Maybe reasons are following:
* We have multiple wiki sites.
* Desired contents structure is different for each member.
So single wiki site is not enough from latter.
Therefore, what about "a search system for multiple wiki sites"?
About (b):
Haskell's evolution is fast.
New contributor encounters sometimes outdated pages.
But they don't still know how to correct them.
Therefore, what about putting "outdated mark" to the page by them?
They can easily contribute.
And if possible, they send update request with any way.
We’ll preferentially update many requested pages.
About (c):
We have multiple wiki sites. Someone is unfamiliar about them.
Github is one of the solutions for new contents.
But I don't have idea about this for current contents.
Regards,
Takenobu
2016-09-28 10:51 GMT+09:00 Richard Eisenberg
: I'm quite leery of using a new site (readthedocs.org), as it creates yet another platform for contributors to understand. Reducing the number of platforms has been a fairly clearly-stated goal of these recent conversations, as I've read it.
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
Richard
On Sep 27, 2016, at 5:58 PM, Michael Sloan
wrote: On Tue, Sep 27, 2016, at 09:06, Richard Eisenberg wrote: > Yes, I agree with Michael’s observations in the blog post. However, one > thing that’s easier about a wiki is that the editing process is much more > lightweight than making a PR. > > But GitHub has a wonderful feature (that I have rarely used) that > mitigates this problem. Viewing a file in GitHub offers a little
> icon in the top-right. It allows you to make arbitrary changes in
On Tue, Sep 27, 2016 at 9:18 AM, Eric Seidel
wrote: pencil the > file and then automates the construction of a PR. The owner of the file > can then accept the PR very, very easily. If the editor has commit > rights, you can make your edits into a commit right away. No need to > fork, pull and push.
Indeed, GitHub also supports git-backed wikis, so you can have nicely rendered and inter-linked pages *and* have the option for web-based or git-based editing. Though, based on my limited experience with GitHub wikis, I wonder if they would scale to the size of GHC's wiki..
I agree, I don't think GitHub wikis are sufficient for GHC. We've tried using GitHub wikis, and found that they were clunkier than just having wiki / docs in your repo. GHC would probably want to have a separate docs repo, as otherwise the commit history will get filled with commits related to proposals, etc.
It may be worth considering a similar approach with the GHC documentation. We've had great success in stack with using https://readthedocs.org/ . The way this works is that you have a branch that readthedocs points at ("stable"), which provides the current version to display. I realize that ghc would want to have multiple versions of the docs up, but I'm sure that's feasible.
Github itself has pretty nice markdown rendering, and the ability to edit directly. Note that there is no GitHub lock-in here - it is just a collection of markdown files, organized however you like them.
The risk with such a migration is that the old wiki(s?) don't get fully migrated and shut down. If that happens, then information will be even more spread out and hard to find. Perhaps we can use pandoc to automatically migrate much of the wiki content to markdown? It probably will not be a lossfree conversion.
There's also a tool called gitit (https://github.com/jgm/gitit) that seems to offer the same set of features, but apparently with a more traditional (and I assume customizable) layout.
I think having the option for simple, immediate edits or peer-reviewed edits (the peer-review is much more important to me than having an explicitly file-based system) would be a big win. Perhaps there's even a trac module that implements something like this? Then we could decouple it from the question/task of migrating the existing content elsewhere.
Eric _______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

On 2016-09-30 19:26, Carter Schonwald wrote:
We all do!.
I dont. (Sorry, just had to put that Monty Python joke in there. At least I *think* it was MP?) Obviously, yes, we all *really* *REALLY* like Haskell, otherwise we wouldn't be arguing about it, would we? ;) Regards,

On 2016-09-28 at 03:51:22 +0200, Richard Eisenberg wrote: [...]
Despite agreeing that wikis are sometimes wonky, I thought of a solid reason against moving: we lose the Trac integration. A Trac wiki page can easily link to tickets and individual comments, and can use dynamic features such as lists of active tickets. These are useful and well-used features. I don't know what's best here, but thinking about the real loss associated with moving away from these features gives me pause.
I'd like to emphasize this point; Trac's main strength, design philosophy, and selling point is its tight integration between SCM, Wiki and Issue tracking and resulting synergies (same markup features, extensions, syntax usable seamless), whereas the issue tracking part is its strongest feature. If you rip away its Wiki (and replace it by something decoupled/non-integrated as e.g. GitHub's Git-backed Wiki[1]), you weaken it to the point where it becomes quite harder to argue to keep Trac at all. It's already sub-optimal we spread discussions/information across Trac and Phabricator (you often have to read both, the Diff discussions and the associated Trac ticket discussion to get the full picture); I doubt a 3rd more or less isolated tool which weakens cohesion would improve things. [1]: Personally, I consider GitHub's Wiki quite weak and inconvenient to use. It's stylesheet is not as optimised as Trac's and structuring the content is also significantly worse than with Trac. And finally GH-flavoured Markdown is very limiting compared to Trac's rich extensible wiki syntax; Github's Wiki doesn't even recognize #123 or Git-shas like 993d20a2e9b8fb29a (and then provide mouse-over hoover texts with a title of the respective referenced commit or ticket); you have to paste full urls and manually include a title. So IMO Github's wiki is not suitable for GHC's use at all. A highly customized/forked Gitit instance, however, may be a more reasonable alternative, but then the question is who is gonna customize, implement and maintain it. Or we can drop the idea of a wiki altogether, and go for statically generated docs. Then we could just keep the wiki-content as restructedText (which btw is more expressive and extensible than .md) and have sphinx generated output. But then that's a totally different medium compared to a Wiki... However, I'm still missing a compelling reason in this discussion to justify the cost of changing the status-quo.

For me the biggest problem is that each of the three Wiki's has a different markup syntax. So the mental motivation to do anything is tempered by having to look up everything to make sure you are using the right markup for *this* Wiki. Reducing it to one, wherever it is, would help a lot. Alan

Friends, after the recent discussion here and on #ghc, I’ve taken the liberty to extract a small part of this into a proposal[1]. In essence this does not cover *all* of the wiki, but the commentary and documentation part, after Herbert mentioned that would be something he could see happening. So let’s see if we can make this happen! Cheers, Moritz -- [1]: https://github.com/ghc-proposals/ghc-proposals/pull/10

Eric Seidel
Thanks for the link Alan.
I can personally attest to being intimidated by GHC's wiki when I started contributing. I think having a review mechanism in place would have helped, because then you at least know that one or two other people think your content is clear.
On a more minor note, I know the trac wiki has a history feature, but for some reason I find it much less useful than a git history. Perhaps this is just an issue of familiarity.
I agree, Trac's history feature is quite painful to use. I think that the issue runs deeper than just familiarity. Being restricted comparing revisions in a pairwise manner poses quite a usability problem. Git is simply far more powerful in this area which is one of the advantages that the new proposals process has relative to the Trac wiki. Thankfully, this power isn't strictly necessary for most of the non-proposal content currently in the Wiki. Cheers, - Ben

Interesting article. Michael suggests using markdown in repo-controlled files rather than a wiki. I can see the force of that. Maybe we should consider it.
Simon
From: Alan & Kim Zimmerman [mailto:alan.zimm@gmail.com]
Sent: 27 September 2016 15:54
To: Simon Peyton Jones

Michael’s arguments are compelling. Manuel
Simon Peyton Jones via ghc-devs
: Interesting article. Michael suggests using markdown in repo-controlled files rather than a wiki. I can see the force of that. Maybe we should consider it.
Simon <> From: Alan & Kim Zimmerman [mailto:alan.zimm@gmail.com] Sent: 27 September 2016 15:54 To: Simon Peyton Jones
Cc: Sven Panne ; ghc-devs Subject: Re: How, precisely, can we improve? I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwww.yesodweb.com%2Fblog%2F2015%2F08%2Fthoughts-on-documentation&data=01%7C01%7Csimonpj%40microsoft.com%7C7ff5e6e47ba5499a774308d3e6e631c2%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=uXvFVL2YlOPej5%2Brxms7oUL91OD%2FpqDD9VLaOYtL%2FjQ%3D&reserved=0 Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs
mailto:ghc-devs@haskell.org> wrote: We currently have *3* wikis: https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/ https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals: · https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon <> From: ghc-devs [mailto:ghc-devs-bounces@haskell.org mailto:ghc-devs-bounces@haskell.org] On Behalf Of Sven Panne Sent: 27 September 2016 08:46 To: ghc-devs
mailto:ghc-devs@haskell.org> Subject: Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/ https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhaskell-lang.org%2F&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=9ndNQVeDQy7lPb4qmn13k%2BAtztK8F9Hq%2B2jeXKm9YFU%3D&reserved=0 has great stuff on it, but its relationship to haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 should be seamlessly integrated into haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0, i.e. merged into it. Having an endless sea of links on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers, S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org mailto:ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmail.haskell.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fghc-devs&data=01%7C01%7Csimonpj%40microsoft.com%7C7ff5e6e47ba5499a774308d3e6e631c2%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=6YMRMy74y45Vudt%2F2GvIEOj%2BautOYf7H4Uw%2BaDUMYbM%3D&reserved=0
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion: - Configure the wiki to display the date of last edit prominently. - If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date. And that's it! I think that solves the problem. The reason this solves the problem is that the ghc-proposals process is already en route to providing the git-backed files that have been floated as the alternative to a wiki. Thus, language features, etc., will be memorialized through the ghc-proposals process. As I understand it, that process already requires the proposal to be updated to a description of the feature as the feature is implemented and refined. We will be left with a nice git repo of feature descriptions. The wiki can remain as a place for less permanent discussions (such as pre-proposals) or pages that use the nice dynamic features of Trac. Is this proposal possible to implement? Does it solve the wiki problem sufficiently? Sometimes, solutions are easy. :) Richard
On Sep 28, 2016, at 10:30 PM, Manuel M T Chakravarty
wrote: Michael’s arguments are compelling.
Manuel
Simon Peyton Jones via ghc-devs
mailto:ghc-devs@haskell.org>: Interesting article. Michael suggests using markdown in repo-controlled files rather than a wiki. I can see the force of that. Maybe we should consider it.
Simon <> From: Alan & Kim Zimmerman [mailto:alan.zimm@gmail.com mailto:alan.zimm@gmail.com] Sent: 27 September 2016 15:54 To: Simon Peyton Jones
mailto:simonpj@microsoft.com> Cc: Sven Panne mailto:svenpanne@gmail.com>; ghc-devs mailto:ghc-devs@haskell.org> Subject: Re: How, precisely, can we improve? I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fwww.yesodweb.com%2Fblog%2F2015%2F08%2Fthoughts-on-documentation&data=01%7C01%7Csimonpj%40microsoft.com%7C7ff5e6e47ba5499a774308d3e6e631c2%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=uXvFVL2YlOPej5%2Brxms7oUL91OD%2FpqDD9VLaOYtL%2FjQ%3D&reserved=0 Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs
mailto:ghc-devs@haskell.org> wrote: We currently have *3* wikis: https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/ https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals: · https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon <> From: ghc-devs [mailto:ghc-devs-bounces@haskell.org mailto:ghc-devs-bounces@haskell.org] On Behalf Of Sven Panne Sent: 27 September 2016 08:46 To: ghc-devs
mailto:ghc-devs@haskell.org> Subject: Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fwiki.haskell.org%2FHaskell&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=fxYacdt9XklXJaGetQABBI%2BG3IgnlJmB2r1EL54I1HU%3D&reserved=0 https://ghc.haskell.org/trac/ghc https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/ https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ https://na01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fhaskell-lang.org%2F&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=9ndNQVeDQy7lPb4qmn13k%2BAtztK8F9Hq%2B2jeXKm9YFU%3D&reserved=0 has great stuff on it, but its relationship to haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell-lang.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=G9e%2BVDuPTtZHZl%2BGd2fFShUznQjDa158JENjoMiD0VY%3D&reserved=0 should be seamlessly integrated into haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0, i.e. merged into it. Having an endless sea of links on haskell.org https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fhaskell.org&data=01%7C01%7Csimonpj%40microsoft.com%7C28109c89abb14244f87908d3e6aa6198%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=%2F8JlCXTwn%2FB8EyrW4BkY0QTS57X%2BFvs4BSXijqCbiNA%3D&reserved=0 is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers, S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org mailto:ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs https://na01.safelinks.protection.outlook.com/?url=http%3A%2F%2Fmail.haskell.org%2Fcgi-bin%2Fmailman%2Flistinfo%2Fghc-devs&data=01%7C01%7Csimonpj%40microsoft.com%7C7ff5e6e47ba5499a774308d3e6e631c2%7C72f988bf86f141af91ab2d7cd011db47%7C1&sdata=6YMRMy74y45Vudt%2F2GvIEOj%2BautOYf7H4Uw%2BaDUMYbM%3D&reserved=0
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org mailto:ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age). There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago. Regards,

Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs

Why not just do the better thing to begin with rather than obligating
people to think to use this feature? Most, even those who know it's an
option, aren't going to think to do this in the heat of trying to
track down an answer to something.
On Wed, Sep 28, 2016 at 11:08 PM, Moritz Angermann
Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com

Chris, I’m all in favor of a better system! My only intention was to point to a solution that might help with the current system, right now. I’ve come to use that feature quite frequently even outside of this specific use case, as many of the results are often full of interesting yet stale information. Anyhow, I don’t want to obligate anyone to do anything, and if this was perceived that way, I’m truly sorry. Cheers, Moritz
On Sep 29, 2016, at 12:24 PM, Christopher Allen
wrote: Why not just do the better thing to begin with rather than obligating people to think to use this feature? Most, even those who know it's an option, aren't going to think to do this in the heat of trying to track down an answer to something.
On Wed, Sep 28, 2016 at 11:08 PM, Moritz Angermann
wrote: Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com

Makes sense, no problem!
I think my main personal complaints with docs have been:
Poor discoverability — neither wikis nor search solve this, I want a
dir listing.
Slow search — almost every wiki has slow search. bouncing out to
google is annoying. just let me grep.
Broken links — this is particularly annoying as unis like to shut down
student accounts hosting papers. I had to do some archaeology on an
obscure Chinese FTP server to find some of Don Stewart's papers and
slides recently.
I believe there can be a convincing solution to all of this and more.
On Wed, Sep 28, 2016 at 11:33 PM, Moritz Angermann
Chris,
I’m all in favor of a better system! My only intention was to point to a solution that might help with the current system, right now.
I’ve come to use that feature quite frequently even outside of this specific use case, as many of the results are often full of interesting yet stale information.
Anyhow, I don’t want to obligate anyone to do anything, and if this was perceived that way, I’m truly sorry.
Cheers, Moritz
On Sep 29, 2016, at 12:24 PM, Christopher Allen
wrote: Why not just do the better thing to begin with rather than obligating people to think to use this feature? Most, even those who know it's an option, aren't going to think to do this in the heat of trying to track down an answer to something.
On Wed, Sep 28, 2016 at 11:08 PM, Moritz Angermann
wrote: Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com
-- Chris Allen Currently working on http://haskellbook.com

That is an interesting way to interact with the wiki, I had never thought about using it that way! So what you are proposing is a version controlled text based documentation system, precisely you can download the wiki and use your own cli/editor finding/indexing tools on it? This would of course be covered by almost any of the static side generation tools that work off of git I assume. I’m still uncertain how to accommodate Richards dynamic features into this? And I believe he’s not the only one who relies on them? Regarding the stale wiki page issue, scanning the history for files could potentially provide a list of “old” items, and eventually one could just delete them from master (automatically?)
On Sep 29, 2016, at 12:37 PM, Christopher Allen
wrote: Makes sense, no problem!
I think my main personal complaints with docs have been:
Poor discoverability — neither wikis nor search solve this, I want a dir listing.
Slow search — almost every wiki has slow search. bouncing out to google is annoying. just let me grep.
Broken links — this is particularly annoying as unis like to shut down student accounts hosting papers. I had to do some archaeology on an obscure Chinese FTP server to find some of Don Stewart's papers and slides recently.
I believe there can be a convincing solution to all of this and more.
On Wed, Sep 28, 2016 at 11:33 PM, Moritz Angermann
wrote: Chris,
I’m all in favor of a better system! My only intention was to point to a solution that might help with the current system, right now.
I’ve come to use that feature quite frequently even outside of this specific use case, as many of the results are often full of interesting yet stale information.
Anyhow, I don’t want to obligate anyone to do anything, and if this was perceived that way, I’m truly sorry.
Cheers, Moritz
On Sep 29, 2016, at 12:24 PM, Christopher Allen
wrote: Why not just do the better thing to begin with rather than obligating people to think to use this feature? Most, even those who know it's an option, aren't going to think to do this in the heat of trying to track down an answer to something.
On Wed, Sep 28, 2016 at 11:08 PM, Moritz Angermann
wrote: Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote:
Here's a pre-proposal (which could be formalized into a proper proposal) to address the wiki discussion:
- Configure the wiki to display the date of last edit prominently.
- If the date of last edit is sufficiently long ago (1 year?) loudly warn the reader that the content may be out-of-date.
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com
-- Chris Allen Currently working on http://haskellbook.com

I was thinking of what Richard was describing as shoring up the
insufficiencies of the existing infra, rather than something to be
directly targeted in any possible alternative.
Hypothetically could be made automatic or a git hook, if you wanted
things like last-modified timestamps injected into the documents. I
don't have strong feelings on this other than to say that there are
simpler ways to represent and serve documentation that let people use
whatever layer on top they want.
For example, if someone _did_ want the readthedocs specifically, they
could mirror the repo into the RTD branch and point it at the docs
directory or similar.
Git repos mean not being blocked by trac slowness/downtime, the
content being more widely mirrored, all kinds of nice to be
potentially had.
On Thu, Sep 29, 2016 at 12:01 AM, Moritz Angermann
That is an interesting way to interact with the wiki, I had never thought about using it that way!
So what you are proposing is a version controlled text based documentation system, precisely you can download the wiki and use your own cli/editor finding/indexing tools on it?
This would of course be covered by almost any of the static side generation tools that work off of git I assume.
I’m still uncertain how to accommodate Richards dynamic features into this? And I believe he’s not the only one who relies on them?
Regarding the stale wiki page issue, scanning the history for files could potentially provide a list of “old” items, and eventually one could just delete them from master (automatically?)
On Sep 29, 2016, at 12:37 PM, Christopher Allen
wrote: Makes sense, no problem!
I think my main personal complaints with docs have been:
Poor discoverability — neither wikis nor search solve this, I want a dir listing.
Slow search — almost every wiki has slow search. bouncing out to google is annoying. just let me grep.
Broken links — this is particularly annoying as unis like to shut down student accounts hosting papers. I had to do some archaeology on an obscure Chinese FTP server to find some of Don Stewart's papers and slides recently.
I believe there can be a convincing solution to all of this and more.
On Wed, Sep 28, 2016 at 11:33 PM, Moritz Angermann
wrote: Chris,
I’m all in favor of a better system! My only intention was to point to a solution that might help with the current system, right now.
I’ve come to use that feature quite frequently even outside of this specific use case, as many of the results are often full of interesting yet stale information.
Anyhow, I don’t want to obligate anyone to do anything, and if this was perceived that way, I’m truly sorry.
Cheers, Moritz
On Sep 29, 2016, at 12:24 PM, Christopher Allen
wrote: Why not just do the better thing to begin with rather than obligating people to think to use this feature? Most, even those who know it's an option, aren't going to think to do this in the heat of trying to track down an answer to something.
On Wed, Sep 28, 2016 at 11:08 PM, Moritz Angermann
wrote: Just a quick note: Google provides the “Date range” filter found under search options. This allows to narrow down the date range.
On Sep 29, 2016, at 11:55 AM, Bardur Arantsson
wrote: On 2016-09-29 04:43, Richard Eisenberg wrote: > Here's a pre-proposal (which could be formalized into a proper proposal) > to address the wiki discussion: > > - Configure the wiki to display the date of last edit prominently. > > - If the date of last edit is sufficiently long ago (1 year?) loudly > warn the reader that the content may be out-of-date. >
I see at least one major issue with this: Search engines don't care if you write "THIS MAY BE OUT OF DATE" on the page. It's a perennial problem that search engines keep linking out of date material just because such material tends to be linked more (simply because of age).
There are few tings as infuriating as going through a bunch of search results and getting pages from 10 years ago.
Regards,
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com
-- Chris Allen Currently working on http://haskellbook.com
-- Chris Allen Currently working on http://haskellbook.com

I’d like to see a git based ascii markup based tool as well. Simon pointed out that there are inherent complexities coming with wikis. I don’t think changeing those would be necessarily solved with such an approach. As Takenobu pointed out, a core part of the interface should be search. Looking at another big wiki, many of us have probably used, wikipedia: I don’t think I’m alone in querying wikipedia through duckduckgo or google using “wiki <search term>”. However, this requires me to know what I’m searching for or at least have an idea what I’m looking for, and only from there I can discover new things. For an alien technology, where I might not actually *know* the terms I’m looking for, some form ob browsing by some kind of “Tag” could be helpful to narrow down what I’m looking for. With a new approach I would like to see Search and Tagging being central features to the UI. Cheers, Moritz
On Sep 29, 2016, at 10:30 AM, Manuel M T Chakravarty
wrote: Michael’s arguments are compelling.
Manuel
Simon Peyton Jones via ghc-devs
: Interesting article. Michael suggests using markdown in repo-controlled files rather than a wiki. I can see the force of that. Maybe we should consider it.
Simon
From: Alan & Kim Zimmerman [mailto:alan.zimm@gmail.com] Sent: 27 September 2016 15:54 To: Simon Peyton Jones
Cc: Sven Panne ; ghc-devs Subject: Re: How, precisely, can we improve? I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation
Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs
wrote: We currently have *3* wikis: https://wiki.haskell.org/Haskell https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals: · https://wiki.haskell.org/Haskell is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
From: ghc-devs [mailto:ghc-devs-bounces@haskell.org] On Behalf Of Sven Panne Sent: 27 September 2016 08:46 To: ghc-devs
Subject: Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ has great stuff on it, but its relationship to haskell.org is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org should be seamlessly integrated into haskell.org, i.e. merged into it. Having an endless sea of links on haskell.org is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers, S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
————————————————— Moritz Angermann +49 170 54 33 0 74 moritz@lichtzwerge.de lichtzwerge GmbH Raiffeisenstr. 8 93185 Michelsneukirchen Amtsgericht Regensburg HRB 14723 Geschäftsführung: Moritz Angermann, Ralf Sangl USt-Id: DE291948767 Diese E-Mail enthält vertrauliche und/oder rechtlich geschützte Informationen. Wenn Sie nicht der richtige Adressat sind oder diese E-Mail irrtümlich erhalten haben, informieren Sie bitte sofort den Absender und vernichten Sie diese Mail. Das unerlaubte Kopieren sowie die unbefugte Weitergabe dieser Mail ist nicht gestattet. This e-mail may contain confidential and/or privileged information. If you are not the intended recipient (or have received this e-mail in error) please notify the sender immediately and destroy this e-mail. Any unauthorized copying, disclosure or distribution of the material in this e-mail is strictly forbidden.

I tend to agree, particularly as it would permit automated processing
and conversion of the documentation much more readily than a website
really ever has.
I don't think I've ever used a public wiki that enforced broken link
checking, whereas that's a sundry CI check for static markdown
documentation.
Markdown files can become anything somebody wants, including a web
server hosting it as HTML documentation that looks however they want.
This approach doesn't prevent separating docs for the community vs.
implementors either. Just a subdirectory if you wanted.
On Wed, Sep 28, 2016 at 9:30 PM, Manuel M T Chakravarty
Michael’s arguments are compelling.
Manuel
Simon Peyton Jones via ghc-devs
: Interesting article. Michael suggests using markdown in repo-controlled files rather than a wiki. I can see the force of that. Maybe we should consider it.
Simon
From: Alan & Kim Zimmerman [mailto:alan.zimm@gmail.com] Sent: 27 September 2016 15:54 To: Simon Peyton Jones
Cc: Sven Panne ; ghc-devs Subject: Re: How, precisely, can we improve? I think this is relevant to the dicussion: http://www.yesodweb.com/blog/2015/08/thoughts-on-documentation
Alan
On Tue, Sep 27, 2016 at 4:22 PM, Simon Peyton Jones via ghc-devs
wrote: We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/
I didn’t even know about the third of these, but the first two have clearly differentiated goals:
· https://wiki.haskell.org/Haskell is about user-facing, and often user-generated, documentation. Guidance about improving performance, programming idioms, tutorials etc.
· https://ghc.haskell.org/trac/ghc is about GHC’s implementation, oriented to people who want to understand how GHC works, and how to modify it.
I think this separation is actually quite helpful.
I agree with what you and others say about the difficulty of keeping wikis organised. But that’s not primarily a technology issue: there is a genuinely difficult challenge here. How do you build and maintain up-to-date, navigable, well-organised information about a large, complex, and rapidly changing artefact like GHC? A wiki is one approach that has the merit that anyone can improve it; control is not centralised. But I’d love there to be other, better solutions.
Simon
From: ghc-devs [mailto:ghc-devs-bounces@haskell.org] On Behalf Of Sven Panne Sent: 27 September 2016 08:46 To: ghc-devs
Subject: Re: How, precisely, can we improve? Just a remark from my side: The documentation/tooling landscape is a bit more fragmented than it needs to be IMHO. More concretely:
* We currently have *3* wikis:
https://wiki.haskell.org/Haskell https://ghc.haskell.org/trac/ghc https://phabricator.haskell.org/w/
It's clear to me that they have different emphases and different origins, but in the end this results in valuable information being scattered around. Wikis in general are already quite hard to navigate (due to their inherent chaotic "structure"), so having 3 of them makes things even worse. It would be great to have *the* single Haskell Wiki directly on haskell.org in an easily reachable place.
* To be an active Haskell community member, you need quite a few different logins: Some for the Wikis mentioned above, one for Hackage, another one for Phabricator, perhaps an SSH key here and there... Phabricator is a notable exception: It accepts your GitHub/Google+/... logins. It would be great if the other parts of the Haskell ecosystem accepted those kinds of logins, too.
* https://haskell-lang.org/ has great stuff on it, but its relationship to haskell.org is unclear to me. Their "documentation" sub-pages look extremely similar, but haskell-lang.org has various (great!) tutorials and a nice overview of common libraries on it. From an external POV it seems to me that haskell-lang.org should be seamlessly integrated into haskell.org, i.e. merged into it. Having an endless sea of links on haskell.org is not the same as having content nicely integrated into it, sorted by topic, etc.
All those points are not show-stoppers for people trying to be more active in the Haskell community, but nevertheless they make things harder than they need to be, so I fear we lose people quite early. To draw an analogy: As probably everybody who actively monitors their web shop/customer site knows, even seemlingy small things moves customers totally away from your site. One unclear payment form? The vast majority of your potential customers aborts the purchase immediately and forever. One confusing interstitial web page? Say goodbye to lots of people. One hard-to-find button/link? A forced login/new account? => Commercial disaster, etc. etc.
Furthermore, I'm quite aware of the technical/social difficulties of my proposals, but that shouldn't let us stop trying to improve...
Cheers, S.
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
_______________________________________________ ghc-devs mailing list ghc-devs@haskell.org http://mail.haskell.org/cgi-bin/mailman/listinfo/ghc-devs
-- Chris Allen Currently working on http://haskellbook.com
participants (16)
-
Alan & Kim Zimmerman
-
Bardur Arantsson
-
Ben Gamari
-
Carter Schonwald
-
Christopher Allen
-
Eric Seidel
-
Herbert Valerio Riedel
-
Manuel M T Chakravarty
-
Michael Sloan
-
Michal Terepeta
-
Moritz Angermann
-
Richard Eisenberg
-
Simon Peyton Jones
-
Sven Panne
-
Takenobu Tani
-
Tom Murphy