Skip to content
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

Documenting Ember add-on #638

Closed
alexlafroscia opened this issue May 2, 2018 · 13 comments
Closed

Documenting Ember add-on #638

alexlafroscia opened this issue May 2, 2018 · 13 comments
Assignees

Comments

@alexlafroscia
Copy link
Contributor

I've written an Ember add-on to integration Emotion into Ember apps, called ember-emotion. I would love to add it to the documentation so that people in the Ember community know that it's an option when looking at Emotion's website.

Would you be interested in me adding it to the Packages section of the documentation site even though it isn't an "official" package that's part of your organization? Would you be interested moving the repo under your umbrella?

@tkh44
Copy link
Member

tkh44 commented May 2, 2018

I have no problem linking to it in the readme, put in a PR and we'll get it merged 👍

@mitchellhamilton do you see any problems with moving ember emotion to the emotion-js org? I'm most worried about the expectation of maintenance, but it's not the biggest deal.

@alexlafroscia
Copy link
Contributor Author

I have no problem linking to it in the readme, put in a PR and we'll get it merged

It's actually in the README already -- it was the docs site I was asking about.

I'm most worried about the expectation of maintenance, but it's not the biggest deal.

Totally understandable, and I don't mind keeping it under my name. It's more that from the consumer's standpoint, it seems more "legit" if it's actually within the emotion Github organization.

@emmatown
Copy link
Member

emmatown commented May 4, 2018

I'm not big on adding it to the packages section since it could make people think it's official and make people open issues about it on this repo and etc.

What we could do though is add a Community page to the docs where there are links to ember-emotion and other projects related to emotion so those projects are more visible but it's clear that they're from the community.

@alexlafroscia
Copy link
Contributor Author

That sounds like a good solution to me!

@Ailrun
Copy link
Member

Ailrun commented Jun 11, 2018

@alexlafroscia
Do you have markdown document about ember-emotion for our document? I'm now changing Packages into Official Packages and adding Third Party Packages.
If you have appropriate document, please share it with us. I'd really appreciate it.

@alexlafroscia
Copy link
Contributor Author

Cool! I'd love to provide something. What kind of information are you looking for about my Ember addon?

My README has quite a bit of Markdown already, but I can distill that down as it's probably too much.

https://github.com/alexlafroscia/ember-emotion

@Ailrun
Copy link
Member

Ailrun commented Jun 11, 2018

@alexlafroscia Yes, "distilling that down" is actually what I meant. Could you do that? Thank you for your contribution for emotion community!

@Ailrun Ailrun self-assigned this Jun 11, 2018
@alexlafroscia
Copy link
Contributor Author

alexlafroscia commented Jun 11, 2018

This is basically just the top few sections of the readme, and a link to the README for more information. That's probably the right amount of information for the website; just enough to install and get started:

https://github.com/alexlafroscia/ember-emotion/blob/emotion-site-docs/docs/emotion-docs.md

@alexlafroscia
Copy link
Contributor Author

Thanks for being willing to feature third-party packages on the main website, by the way! Makes it feel more worthwhile to put the effort into it when my package feels like part of the community.

@Ailrun
Copy link
Member

Ailrun commented Jun 11, 2018

@alexlafroscia I uploaded a PR for it. See #715.

@Ailrun
Copy link
Member

Ailrun commented Jun 12, 2018

@alexlafroscia, @mitchellhamilton make an awesome repository for emotion, https://github.com/emotion-js/awesome-emotion.
And he already listed your package too.

@alexlafroscia
Copy link
Contributor Author

Awesome!

@stale
Copy link

stale bot commented Aug 11, 2018

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 7 days if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Aug 11, 2018
@stale stale bot closed this as completed Aug 18, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

4 participants