New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update DropdownMenu readme #13410

Merged
merged 5 commits into from Jan 22, 2019

Conversation

Projects
None yet
4 participants
@melchoyce
Copy link
Contributor

melchoyce commented Jan 21, 2019

Updating documentation to describe the use and functionality of the DropdownMenu component.

Thanks to @sarahmonster, @jasmussen, and @kjellr for helping draft this.

melchoyce added some commits Jan 17, 2019

Update DropdownMenu readme
Adding documentation to describe the use and functionality of the DropdownMenu component.

Thanks @sarahmonster and @jasmussen for drafting this.

@melchoyce melchoyce requested a review from kjellr Jan 21, 2019


## Usage
![An expanded DropdownMenu, containing a list of MenuItems.](https://wordpress.org/gutenberg/files/2019/01/DropdownMenuExample.png)

This comment has been minimized.

@gziolo

gziolo Jan 22, 2019

Member

I see that is a common way of handling images for docs. I'm wondering if it wouldn't be better to keep them on GitHub instead. This would make it open for everyone. At the moment there is a very small group of maintainer who can override the existing files or add new ones.

This comment has been minimized.

@kjellr

kjellr Jan 22, 2019

Contributor

That would definitely be easier to update — the reason we've been hosting them over on wp.org is that images uploaded to GitHub are blocked from appearing on the mirror over at https://wordpress.org/gutenberg/handbook/ 😞

This comment has been minimized.

@melchoyce

melchoyce Jan 22, 2019

Author Contributor

Yeah, we've had a couple conversations about this 😞 I think there's also a worry that the images will bloat the repo. Would love to find a more sustainable solution!

This comment has been minimized.

@gziolo

gziolo Jan 23, 2019

Member

Right, it makes a lot of sense. I think there still are some images referenced. I remember seeing @nosolosw using GitHub hosted image. I will have to double check whether it works.

This comment has been minimized.

@gziolo

gziolo Jan 23, 2019

Member

It looks like it is possible. See this page:
https://wordpress.org/gutenberg/handbook/designers-developers/developers/tutorials/plugin-sidebar-0/plugin-sidebar-1-up-and-running/

However I agree that it might negatively impact the download size of repository. It is also not clear how URL should look like. I see something like this in the source:
https://raw.githubusercontent.com/WordPress/gutenberg/master/docs/designers-developers/assets/sidebar-up-and-running.png

This comment has been minimized.

@nosolosw

nosolosw Jan 23, 2019

Member

Yeah, I've asked about that a few times. I think the tutorials I wrote all use the Github raw CDN because that was what I had access to and what other doc folks were doing. It's a bit tricky because you have to use the image URL for when the image is deployed to master (so you don't see it during reviews). 🤷‍♂️

@gziolo

gziolo approved these changes Jan 22, 2019

Copy link
Member

gziolo left a comment

This should be reviewed also by a designer but from my perspective this looks great 👍

@gziolo gziolo added this to the Documentation & Handbook milestone Jan 22, 2019

@kjellr

kjellr approved these changes Jan 22, 2019

Copy link
Contributor

kjellr left a comment

LGTM! Thanks, Mel.

@melchoyce melchoyce merged commit 6f6181e into WordPress:master Jan 22, 2019

1 check passed

continuous-integration/travis-ci/pr The Travis CI build passed
Details
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment