Plots2: Add popover to list authors on wiki page headings

Created on 5 Dec 2019  ยท  20Comments  ยท  Source: publiclab/plots2

Hi, this is a first-timers-only issue. This means we've worked to make it more legible to folks who either haven't contributed to our codebase before, or even folks who haven't contributed to open source before.

If that's you, we're interested in helping you take the first step and can answer questions and help you out as you do. Note that we're especially interested in contributions from people from groups underrepresented in free and open source software!

We know that the process of creating a pull request is the biggest barrier for new contributors. This issue is for you ๐Ÿ’

If you have contributed before, consider leaving this one for someone new, and looking through our general help wanted issues. Thanks!

๐Ÿค” What you will need to know.

Nothing. This issue is meant to welcome you to Open Source :) We are happy to walk you through the process.

What is to be done.

Wiki pages now have this great header showing Authors, Revisions, and the talk page:

image

Let's make it so you can click the Authors item and see a Bootstrap popover listing the authors' usernames.

The code for that is here:

https://github.com/publiclab/plots2/blob/6d417a384801e4c20b77c4d6360788f19a78b41c/app/views/wiki/_header.html.erb#L34-L36

We can get the authors listing using node.authors, as shown here:

https://github.com/publiclab/plots2/blob/6d417a384801e4c20b77c4d6360788f19a78b41c/app/models/node.rb#L278-L280

And for each one, we could do the following so that their names are clickable and lead to their profile pages!

<ul>
  <% node.authors.each do |author| %>
  <li><a href="/profile/<%= author.username %>">@<%= author.username %></a></li>
  <% end %>
</ul>

That code can go inside the popover!

๐Ÿ“‹ Step by Step

  • [ ] ๐Ÿ™‹ Claim this issue: Comment below. If someone else has claimed it, ask if they've opened a pull request already and if they're stuck -- maybe you can help them solve a problem or move it along!

  • [ ] ๐Ÿ“ Update the file $FILENAME in the $REPO repository (press the little pen Icon) and edit the line as shown below.

See this page for some help in taking your first steps!

Below is a "diff" showing in red (and a -) which lines to remove, and in green (and a +) which lines to add:

$DIFF
  • [ ] ๐Ÿ’พ Commit your changes

  • [ ] ๐Ÿ”€ Start a Pull Request. There are two ways how you can start a pull request:

  1. If you are familiar with the terminal or would like to learn it, here is a great tutorial on how to send a pull request using the terminal.

  2. You can also edit files directly in your browser and open a pull request from there.

  • [ ] ๐Ÿ Done Ask in comments for a review :)

Please keep us updated

๐Ÿ’ฌโฐ - We encourage contributors to be respectful to the community and provide an update within a week of claiming a first-timers-only issue. We're happy to keep it assigned to you as long as you need if you update us with a request for more time or help, but if we don't see any activity a week after you claim it we may reassign it to give someone else a chance. Thank you in advance!

If this happens to you, don't sweat it! Grab another open issue.

Is someone else already working on this?

๐Ÿ”—- We encourage contributors to link to the original issue in their pull request so all users can easily see if someone's already started on it.

๐Ÿ‘ฅ- If someone seems stuck, offer them some help! Otherwise, take a look at some other issues you can help with. Thanks!

๐Ÿค”โ“ Questions?

Leave a comment below!

HTML Ruby feature first-timers-only help wanted

All 20 comments

If no one is working on this I'd like to claim this.

Hmm...Could I ask for help? It seems I got stuck.
How can I set the HTML tags for the content of popover?
I edited line 34 to be:

<span rel="tooltip" data-placement="left"><%= number_with_delimiter(@node.authors.length)  %> Authors</span> |

and I was about to set the popover content

<ul>
          <% @node.authors.each do |author| %>
            <li><a href="/profile/<%= author.username %>">@<%= author.username %></a></li>
          <% end %>
</ul>

to data-content but I have no idea how to do so.

I managed to get out of the stuck myself.

Here's progress: Screencast and Commit.
As you see in the screencast, the popover vanishes when we move the cursor to the author's link. This is not what we intended but I have no idea how to fix this behavior. @gauravano @SidharthBansal @IshaGupta18 @ananyaarun @pydevsg @sashadev-sky @cesswairimu Could you help me out? Thanks.

Hey @takitsuse, wow..this is so great :tada: ...could you please open a pull request on plots2?( Here is a link to open a pull request against your branch go https://github.com/publiclab/plots2/compare/master...takitsuse:add-popover-to-list-authors and click on "create a pull request" _just incase its your first time opening a pr_). Also could you kindly try adding 2 or three authors just to see how that will look like.Thanks so much for working on this

Created PR. Thanks for your guidance!

Is anyone working on this?...Can I take it?

Yes, someone else is working on it. Please try any other issue.

how can i be notified if some new issue is opened

Hi all - apologies for slow reply here. This is available for anyone to claim!

Hi @jywarren , i would like to claim this issue

Go ahead @chanukya-y :)

Hi @chanukya-y - just noting that there is a good start in https://github.com/publiclab/plots2/pull/6934 that you could build on!

Hii @jywarren , can I work on this issue as a first timer?

Is this issue open right now? May I work on it?

Hi @madhhuurrii are by chance working on this or still interested, sorry I missed your comment..If not, please let @Priyaraj17 know Thanks you both

No @cesswairimu,I am not working on this issue

thanks, @Priyaraj17 you can take this one. thanks

Sure I will start with it.

@cesswairimu Can you please review the PR https://github.com/publiclab/plots2/pull/9372

Was this page helpful?
0 / 5 - 0 ratings

Related issues

grvsachdeva picture grvsachdeva  ยท  3Comments

keshavsethi picture keshavsethi  ยท  3Comments

grvsachdeva picture grvsachdeva  ยท  3Comments

first-timers[bot] picture first-timers[bot]  ยท  3Comments

noi5e picture noi5e  ยท  3Comments