OurTechCommunity / catchup

The OTC CatchUp web app and workflows.
https://catchup.ourtech.community
MIT License
15 stars 9 forks source link

Automate linking Twitter handles in `attendees.adoc` #139

Closed tusharnankani closed 1 year ago

tusharnankani commented 1 year ago

Let's automate!

Problem

Currently, we manually link respective Twitter handles in /summary/sessions/<session_num>/attendees.adoc.

  1. Create attendees.adoc
  2. Add a filler format
  3. Paste the list of names (Full Name) from the csv of attendees given by the extension
  4. Manually format it in: . link:<twitter_url>[Full Name^]

Idea

The idea is to automate step 4^ by doing the following steps:

Do only once:

To automate linking attendees.adoc for every CatchUp:

tusharnankani commented 1 year ago

PoC (Sample Proof of Concept): tusharnankani/jsonexp

Give it a shot. This creates a global map.

Now, we need to edit the attendees.adoc file accordingly.

tusharnankani commented 1 year ago

I wish GitHub had a nudge feature. Nudging @OurTechCommunity/core to take a look.

SirusCodes commented 1 year ago

PoC (Sample Proof of Concept): tusharnankani/jsonexp

Give it a shot. This creates a global map.

Now, we need to edit the attendees.adoc file accordingly.

After this I don't feel that it should be difficult to get info from map and add links to attendees.adoc

HarshKapadia2 commented 1 year ago

PoC (Sample Proof of Concept): tusharnankani/jsonexp

Give it a shot. This creates a global map.

Now, we need to edit the attendees.adoc file accordingly.

Thank you so much for raising an issue and for the PoC, Tushar!

The PoC looks fine for now and there will be some changes in the PoC to fit to this repo later on, but I was wondering what we're planning to do after having everything in the map. How are we going to use that data? If we have attendees.adoc for every summary, then why do we need to global store? What is changing?

I think the context behind the idea and what the idea is, is missing. Can you please give more details? Thank you!

SirusCodes commented 1 year ago

@HarshKapadia2 We will use this global store to generate attendees.adoc from CSV (This is the goal)

HarshKapadia2 commented 1 year ago

Ah okay, that makes sense.

How are we going to handle people with the same name though?

HarshKapadia2 commented 1 year ago

Oh and mapping aliases to real names will have to be handled, because not everyone joins meets with their real names. The display name might also have some numbers and/or other symbols attached to the attendee's name as well, which will have to be removed or handled in some way.

tusharnankani commented 1 year ago

The PoC looks fine for now and there will be some changes in the PoC to fit to this repo later on, but I was wondering what we're planning to do after having everything in the map. How are we going to use that data? If we have attendees.adoc for every summary, then why do we need to global store? What is changing?

The script will just run once for all attendees.adoc. Then, we'll have a global JSON ready.

We'll use that to update the list of names.

HarshKapadia2 commented 1 year ago

We'll use that to update the list of names.

Huh?

tusharnankani commented 1 year ago

How are we going to handle people with the same name though?

It's first name plus last name that's mapped to the handle.

People with alt accounts can be handled manually. This script is to ease the manual task. Not replace it.

tusharnankani commented 1 year ago

We'll use that to update the list of names.

Huh?

Right now in files changed we have attendees.adoc. Just a list of names.

Now we just need to create a script that links the name. Our original format.

HarshKapadia2 commented 1 year ago

How are we going to handle people with the same name though?

It's first name plus last name that's mapped to the handle.

People with alt accounts can be handled manually. This script is to ease the manual task. Not replace it.

We have multiple people with the same first and last names (Eg: Anas Khan) that we will have to handle manually.

Oh wait so this is not going to happen dynamically while building, but before it, to generate attendees.adoc from a file with just the names. Ah okay. Got you.

We'll use that to update the list of names.

Huh?

Right now in files changed we have attendees.adoc. Just a list of names.

Now we just need to create a script that links the name. Our original format.

I understood what you're trying to do from the message above and this is why, providing proper contexts and ideas initially saves time for everyone. Everyone is in different contexts all the time, so sometimes it is difficult to catch on to someone else's intuition and motivation.

tusharnankani commented 1 year ago

I understood what you're trying to do from the message above and this is why, providing proper contexts and ideas initially saves time for everyone. Everyone is in different contexts all the time, so sometimes it is difficult to catch on to someone else's intuition and motivation.

You're right. Apologies. I created the issue as soon as I wrote the PoC. I thought it was self explanatory.

I should have been more empathetic. Sorry once again.

HarshKapadia2 commented 1 year ago

I created the issue as soon as I wrote the PoC. I thought it was self explanatory.

Completely understandable and I do this quite a bit as well. I've been trying to be more aware of this fact.

I should have been more empathetic. Sorry once again.

No problem at all!

tusharnankani commented 1 year ago

Script tested 🎉

https://github.com/tusharnankani/jsonexp/commit/bd616edfcb46a3e61524f7a44588eb2890be197c

119th's attendees.adoc (#138) was automated by https://github.com/OurTechCommunity/catchup/pull/138/commits/98fb95a8a7f4ed510437e7682838550b9e5e6fcd

Please test and take a final look at:

Our final map.json was created by keeping these files in /summary.

HarshKapadia2 commented 1 year ago

Nice! Well done, Tushar!

Looking forward to the PR to include this in our repo!

PranavDani commented 1 year ago

Neat work. I liked how things were discussed here and promptly acted on. I used the two files for this week's summary as well.

Excellent work, Tushar!