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

Add popover to list authors on wiki page headings #6923

Open
jywarren opened this issue Dec 5, 2019 · 9 comments
Open

Add popover to list authors on wiki page headings #6923

jywarren opened this issue Dec 5, 2019 · 9 comments

Comments

@jywarren
Copy link
Contributor

@jywarren jywarren commented Dec 5, 2019

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:

<%= number_with_delimiter(@node.authors.length) %> Authors |
<a rel="tooltip" title="View all revisions for this page." data-placement="top" href="/wiki/revisions/<%= @node.slug_from_path %>"><%= @node.revisions.length %> <%= t('wiki.revisions.revisions') %></a> |
<a href="/talk/<%= @node.slug_from_path %>" rel="tooltip" title="Practice in a realtime doc." data-placement="top"><%= t('wiki.show.talk') %></a>

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

plots2/app/models/node.rb

Lines 278 to 280 in 6d417a3

def authors
revisions.collect(&:author).uniq
end

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!

@takitsuse

This comment has been minimized.

Copy link

@takitsuse takitsuse commented Dec 7, 2019

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

@takitsuse

This comment has been minimized.

Copy link

@takitsuse takitsuse commented Dec 7, 2019

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.

@takitsuse

This comment has been minimized.

Copy link

@takitsuse takitsuse commented Dec 7, 2019

I managed to get out of the stuck myself.

@takitsuse

This comment has been minimized.

Copy link

@takitsuse takitsuse commented Dec 7, 2019

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.

@cesswairimu

This comment has been minimized.

Copy link
Collaborator

@cesswairimu cesswairimu commented Dec 7, 2019

Hey @takitsuse, wow..this is so great 🎉 ...could you please open a pull request on plots2?( Here is a link to open a pull request against your branch go 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

@takitsuse

This comment has been minimized.

Copy link

@takitsuse takitsuse commented Dec 7, 2019

Created PR. Thanks for your guidance!

@pianeta051

This comment has been minimized.

Copy link
Contributor

@pianeta051 pianeta051 commented Dec 12, 2019

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

@SidharthBansal

This comment has been minimized.

Copy link
Member

@SidharthBansal SidharthBansal commented Dec 13, 2019

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

@Johongirr

This comment has been minimized.

Copy link

@Johongirr Johongirr commented Dec 15, 2019

how can i be notified if some new issue is opened

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
7 participants
You can’t perform that action at this time.