publiclab / community-toolbox

Tools to understand and welcome people into a contributor community
https://code.publiclab.org
MIT License
142 stars 196 forks source link

Add "permalink" anchor links to page subsections #461

Open jywarren opened 3 years ago

jywarren commented 3 years ago

We have a nice menu now to link down to subsections on the page, using id attributes and URL hashes, like this:

https://code.publiclab.org/#fto-author

The code for the menu looks like this:

https://github.com/publiclab/community-toolbox/blob/eeecfa61f4f2187464c7f7936f4ac5473a3e182e/index.html#L79-L82

Let's make each header into a link as well, so they're easy to "deep link" to, so you get right to the correct section. This will require adding an A tag around the text of each header, like <a href="#fto-author">...</a>, similarly to the above.

However, some sections get edited live by JavaScript, for example to update the counts, in sections like this, "Stale issues (COUNT)":

image

For those, we need to see if making that section into a link breaks this functionality, or if we need to adjust other areas of code to accommodate them being links.

This is therefore a little more complex than a first-timers-only issue! We'd still love help on it however!

TildaDares commented 3 years ago

@jywarren I'd love to work on this.

jywarren commented 3 years ago

We'd love your help with it! Did you want to try to install it and make the change as described, and see if it indeed breaks the counting systems? Thanks!!!

On Tue, Apr 27, 2021, 3:47 PM Tilda Udufo @.***> wrote:

@jywarren https://github.com/jywarren I'd love to work on this.

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/community-toolbox/issues/461#issuecomment-827881014, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6JZY35V3IVYT55DFHTLTK4IFZANCNFSM43VGGUYA .

TildaDares commented 3 years ago

@jywarren I replaced this https://github.com/publiclab/community-toolbox/blob/main/src/UI/issuesUI.js#L37 with

$('#stale-head').html('<a href="#stale-head">Stale Issues ('+issuesLen+'+)</a>');

The change does not break the count functionality

https://user-images.githubusercontent.com/63427719/116331209-2a9a0700-a7c7-11eb-8482-bac467cf1291.mov

jywarren commented 3 years ago

Oh that's awesome!!! Would you like to open a PR for this? Your solution looks really good.

On Tue, Apr 27, 2021 at 9:13 PM Tilda Udufo @.***> wrote:

@jywarren https://github.com/jywarren I replaced this https://github.com/publiclab/community-toolbox/blob/main/src/UI/issuesUI.js#L37 with

$('#stale-head').html('Stale Issues ('+issuesLen+'+)');

The change does not break the count functionality

https://user-images.githubusercontent.com/63427719/116331209-2a9a0700-a7c7-11eb-8482-bac467cf1291.mov

— You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub https://github.com/publiclab/community-toolbox/issues/461#issuecomment-828066312, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAAF6J5I6MMF55VL7F6REK3TK5OKZANCNFSM43VGGUYA .

vedant-z commented 1 year ago

@jywarren Is this issue still open. If so I would like to work on this.