Add "Improve this page" button to let users easily make quick changes. #98

Merged
merged 5 commits into from Mar 23, 2012

Conversation

Projects
None yet
2 participants
Member

eco commented Mar 6, 2012

Screenshot of "Improve this page"

The goal of this change is to lower the barrier of entry for users to contribute to D's documentation. It essentially turns the website into a moderated wiki. How it works is for each page it links to a special URL on GitHub that will offer to fork the repository, open an online text editor, and create a pull request in one easy process. I've used this method successfully several times to make changes to phobo's documentation and website documentation.

While adding it to the Phobos std.ddoc I also added the Page wiki link.

Find some text you'd like to change and try it out. You can also try it out without actually submitting the pull request if you can't find anything to tweak.

This relies on the now-merged dmd pull request 787 which added a necessary macro to Ddoc. Whoever generates the docs (Andrei?) will need to use a version of dmd that contains that change in order to use this pull request.

eco added some commits Mar 3, 2012

@eco eco Initial "Edit this page on GitHub" 6a27899
@eco eco Add "Improve this page" to tools section
Also change the verbiage of the "Comment on this page" link to the wiki and
make it use the same new style of button as the "Improve this page" link.
395e132
@eco eco Merge branch 'master' of https://github.com/D-Programming-Language/d-… 45b60f4
@eco eco Add to phobos "Improve this page" and "Page wiki" 580ee5a
Member

eco commented Mar 16, 2012

@WalterBright Andrei asked me to prod you both here and on the newsgroup about getting your thoughts on this.

Owner

andralex commented Mar 23, 2012

OK, Walter and I would be glad to try this. One thing though - could you please make the buttons smaller? If they're like in the screenshot you sent, they're too big. Thanks!

Member

eco commented Mar 23, 2012

Smaller tool buttons

How's that? See what it looks like on an actual page here: http://gnuk.net/d/index.html

Owner

andralex commented Mar 23, 2012

Still a bit too prominent (margins too wide, buttons too large. But I'll approve as is and will mess with it later.

@andralex andralex added a commit that referenced this pull request Mar 23, 2012

@andralex andralex Merge pull request #98 from eco/edit-online
Add "Improve this page" button to let users easily make quick changes.
24f7615

@andralex andralex merged commit 24f7615 into dlang:master Mar 23, 2012

Member

eco commented Mar 23, 2012

@andralex Regarding the changes you just made (I can't leave GitHub comment on the commits for whatever reason), I had added a tooltip to the wiki button as you have done but took it out because it goes offscreen on every page but the front page (it doesn't on the front page due to the twitter sidebar). My CSS knowledge is a bit too weak to know how to fix that problem offhand so I just left it out.

Member

eco commented Mar 23, 2012

@andralex Oh, and I forgot to mention you'll want to mirror your change to std.ddoc too.

Member

eco commented Mar 24, 2012

@andralex Just created pull request 104 fixes these two issues.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment