Chat With Us On Zulip button #2270

Closed
timabbott opened this Issue Nov 10, 2016 · 20 comments

Projects

None yet

6 participants

@timabbott
Member

When chatting with folks who run other open source projects, basically the only thing people like about Gitter is that they have a nice badge/button to chat with the community on Gitter. We should add a similar button/badge for Zulip that projects using Zulip can easily link to their Zulip server instance on their GitHub or documentation with a pretty button.

I think for v1 it should literally just be a pretty badge/button that links back to e.g. https://chat.zulip.org, but it could be interesting to have a version that could show the number of users in the organization (for privacy reasons I would want to restrict that feature to realms that are open for anyone to join).

@programo

Like the "join chat" badge here: https://github.com/gitterHQ/desktop

@AmoliShah

In which file is this feature to be added?

@timabbott
Member

Maybe zerver/views/realm.py? Don't have strong feelings.

@AmoliShah

ok.Thanks.

@timabbott timabbott added this to the Zulip roadmap milestone Nov 18, 2016
@KaiCode2

@timabbott I'm considering taking this task on. I mocked up a basic concept for the badge. Any feedback?
join the chat on zulip

@anirudhjain75
Contributor

Cool @KaiCode2

@KaiCode2

Finished a basic badge. You can check out this repo to see it in a readme context.

I'll claim the GCI task and open a PR once my current task is reviewed.

@anirudhjain75
Contributor

@KaiCode2 Pardon me, I too was working on this.

@anirudhjain75
Contributor

@KaiCode2 But I can do one thing ill use your .png file.

@KaiCode2

@anirudhjain75 Ah, well this is a predicament. Do you have the task claimed? it is listed as open on my browser therefore I took it upon myself to prematurely commence development on it. I suppose it would have been wise to assign this issue to myself via github to avoid any confusion.

How far are you through development? Are you in need of the assets?

@anirudhjain75
Contributor
anirudhjain75 commented Dec 18, 2016 edited

I have made the button on the readme file and awaiting review @KaiCode2 Yeah I've Claimed it.

@femnad
femnad commented Dec 18, 2016

OK, so @KaiCode2 posted their mock in this thread and @anirudhjain75 used it in their pull request. Even though it wasn't an official submission I think it's not fair to use @KaiCode2's mock-up like this, don't you agree @anirudhjain75?

Even though your contributions is not only for winning the contest, they are done as part of a contest so I have to make sure that everyone "plays" fairly.

Also do any of you (@KaiCode2 and @anirudhjain75) had plans for v2 as proposed by Tim?

@anirudhjain75
Contributor
anirudhjain75 commented Dec 18, 2016 edited

Nope @femnad and okay I made my own.

@anirudhjain75
Contributor

icon
I know this looks bit different but this is all I could think of making. 😄

@KaiCode2

@anirudhjain75 Feel free to use the assets I created. Better to put them to use then not 😛

@KaiCode2

I'm not sure how you're creating your assets however if you're on a mac and use keynote I can send you me designing environment full or various assets you can tweak and export. If you're making a dynamic button it may also serve as a decent base rendering for a script to overlay text onto.

@anirudhjain75
Contributor

@KaiCode2 Due to @femnad 's objection I've created my own but anyway thanks a lot, You're one was a good inspiration.

@KaiCode2

@anirudhjain75 haha, thanks. Good luck on the task.

@anirudhjain75
Contributor

@KaiCode2 Could you explain me the function of the button please ?

@KaiCode2

@anirudhjain75 To my understanding the objective of the button is essentially the same as a Gitter button. Gitter uses a "join the chat on gitter" button all over the web and people can simply click the link and be jumped directly into a gitter site (Check this link out for an example). In my repo, I mimicked what gitter does by wrapping the image in a link. Making it dynamic (ie. showing number of users in a stream) will require some code to render different buttons, shouldn't be more than a few lines imho.

<side note>
might be worth squashing your commits and not mention this issue in each. Somewhat clutters the feed.
</side note>

@showell showell added a commit that closed this issue Dec 21, 2016
@anirudhjain75 @showell anirudhjain75 + showell Create "join chat" button for Zulip.
The image that we are using can be found in the zulip repository
in the directory`static/images/help` named as chat-with-zulip-button.

We use the new button in the readme, and we also provide instructions
on how to embed the button in other sites in the help docs.

Fixes: #2270
db894b9
@showell showell closed this in db894b9 Dec 21, 2016
@Juanvulcano Juanvulcano added a commit to Juanvulcano/zulip that referenced this issue Dec 22, 2016
@anirudhjain75 @Juanvulcano anirudhjain75 + Juanvulcano Create "join chat" button for Zulip.
The image that we are using can be found in the zulip repository
in the directory`static/images/help` named as chat-with-zulip-button.

We use the new button in the readme, and we also provide instructions
on how to embed the button in other sites in the help docs.

Fixes: #2270
c4d614c
@picapi picapi added a commit to picapi/zulip that referenced this issue Dec 22, 2016
@anirudhjain75 @picapi anirudhjain75 + picapi Create "join chat" button for Zulip.
The image that we are using can be found in the zulip repository
in the directory`static/images/help` named as chat-with-zulip-button.

We use the new button in the readme, and we also provide instructions
on how to embed the button in other sites in the help docs.

Fixes: #2270
f9b4807
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment