Skip to content

Add quick-link buttons for contributing - #17825

Merged
tacaswell merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-contribute-buttons
Jul 5, 2020
Merged

tacaswell merged 1 commit into
matplotlib:masterfrom
timhoffm:doc-contribute-buttons

Conversation

@timhoffm

@timhoffm timhoffm commented Jul 2, 2020

Copy link
Copy Markdown
Member

PR Summary

This PR adds button to the top of the Developers Guide:

image

Motivation

The Developers Guide is linked from "Contributing" in the main menu. The buttons provide quick links to the most common operations users want to do when contributing.

Technical notes

@timhoffm timhoffm added this to the v3.4.0 milestone Jul 2, 2020
@QuLogic

QuLogic commented Jul 3, 2020

Copy link
Copy Markdown
Member

Instead of fixed width, can we do padding: 0 1em;?

@dorafc

dorafc commented Jul 3, 2020 •

Copy link
Copy Markdown
Contributor

Instead of changing from fixed width buttons to adding consistent padding, maybe change "contribute documentation" to "Write Documentation" It's quicker to read (smaller words! yay!) and ensures there's comfortable white space around the button text

Edit: Also, not repeating the word "Contribute" will visually make the two buttons more distinctive

@timhoffm
timhoffm force-pushed the doc-contribute-buttons branch from 7974795 to e697abd Compare July 4, 2020 21:20
@timhoffm

timhoffm commented Jul 4, 2020

Copy link
Copy Markdown
Member Author

I've applied both; padding: 0 1em; and "Write documentation".

I'm not too worried about style anyway at the moment. This is intended as a first step in a series of PRs that reorganize parts of the docs and make relevant information easier accessible. It may well be that there is further fine-tuning down the road.

@tacaswell
tacaswell merged commit c30f762 into matplotlib:master Jul 5, 2020
@timhoffm
timhoffm deleted the doc-contribute-buttons branch July 5, 2020 21:33
timhoffm added a commit to timhoffm/matplotlib that referenced this pull request Jul 6, 2020
vrthra pushed a commit to uds-se/matplotlib that referenced this pull request Jul 9, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants