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

Wikimania 2022 Prep and Documentation #187

Closed
2 tasks done
andrewtavis opened this issue Jul 29, 2022 · 32 comments
Closed
2 tasks done

Wikimania 2022 Prep and Documentation #187

andrewtavis opened this issue Jul 29, 2022 · 32 comments
Assignees
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested

Comments

@andrewtavis
Copy link
Member

andrewtavis commented Jul 29, 2022

Terms

Issue

This issue is a discussion of what needs to happen prior, during and after Scribe-iOS' participation in the 2022 Wikimania Hackathon. Throughout this issue the page Scribe at Wikimania Hackathon 2022 will be made as documentation in the project's Wiki.

@andrewtavis andrewtavis added documentation Improvements or additions to documentation good first issue Good for newcomers question Further information is requested help wanted Extra attention is needed labels Jul 29, 2022
@andrewtavis
Copy link
Member Author

@SaurabhJamadagni, made this issue so that we can talk about the Hackathon :) You can find information for how to prepare in the page I created in the Wiki. I'll signup soon and connect with them on if we can have a slot in the initial presentation of projects to work on 😊

Let me know if this issue and the wiki page seem sufficient to help us coordinate on this. GitHub also has discussions, but then I don't really find them appealing and don't have them activated on projects.

@andrewtavis
Copy link
Member Author

Generally the interest from Wikimedia in the past has been progress on Scribe-Android, so I might work to clear out the directories that have extra files and add a background behind the keys.

@SaurabhJamadagni
Copy link
Collaborator

Let me know if this issue and the wiki page seem sufficient to help us coordinate on this. GitHub also has discussions, but then I don't really find them appealing and don't have them activated on projects.

Hi @andrewtavis, I hope you had a great past week :)

I think this would be sufficient for coordinating throughout the hackathon. In case we need to discuss something in more detail, we could always jump on a call. This should be perfectly fine for now. I am not very sure how helpful I'll be with issues for Scribe-Android, but I'll help out as much as I can 😅

Is there anything you would like me to do in preparation for the hackathon?

@andrewtavis
Copy link
Member Author

The week was very nice, @SaurabhJamadagni! Hope the same for you :)

You’re 100% not expected to work on Scribe-Android! Best if you work in here 😊That’s just a reminder for me.

To start, what are some of the issues you’re thinking you’d like to work on during the hackathon? From there we can do a call to plan the work for them?

@SaurabhJamadagni
Copy link
Collaborator

To start, what are some of the issues you’re thinking you’d like to work on during the hackathon? From there we can do a call to plan the work for them?

Some of the issues I would like to work on @andrewtavis are issue #22 and issue #136. These two seem interesting and I think would make a nice addition to the future versions of Scribe. Are they something we can look into? I am very curious about how autocomplete works in keyboards. So it should also be a learning opportunity. Let me know if you had any particular issues in mind as well :)

@andrewtavis
Copy link
Member Author

andrewtavis commented Aug 3, 2022

Hi @SaurabhJamadagni 👋😊

Very sorry that you're hearing from me so late! I had quite the busy weekend, and there's lots to do this the new job and other endeavors. Your issue suggestions are ones that are quite important, but I'm not sure if it's exactly what we can achieve at the hackathon.

Specifically, in reflecting I blocked #22 as we need to have #33 finished first so that the iPad key layouts are done and ready for the pulldown mechanics. iPad users are also a small fraction of the total, so I wouldn't prioritize this now. Hope this makes sense!

As far as #136, this very much so, but then this is extremely difficult as it would require adding and running a predictive model after each key press. I personally am not really sure how to start with this issue 😅 There are many issues in here that are very long term. I also realized that it was -priority-, which was misleading. It's just that I'm excited about it, but that label did need to be removed. We'll get to it sooner rather than later, but right now would be a stretch with how much time I have to dedicate to Scribe 😊

Let me throw some issues out and you can let me know what you think :)

For something more challenging, we could work towards being able to do #3 - the most sought after feature at this point:

  • This would require us discussing how the mechanics would work, as the command bar wouldn't be present unless the user was executing a command
  • I could make a baseline issue for this where we'd suggest words from the combination of all the grammar JSONs that we have
    • We'd basically be changing the text of the Translate, Conjugate, and Plural buttons as the user types and then insert the word when the button is pressed
    • The change in styling during suggesting would be that we'd make the buttons themselves transparent and just have the text be present to the user
    • The predictive model for the suggestions would just be the next word alphabetically at first (example below isn't alphabetical 🙂)
    • What this would be going towards is the following, where this would be after the user types "Ze":

Autosuggest

Aside from the above, here are some simple ones with impact:

@SaurabhJamadagni
Copy link
Collaborator

Yes @andrewtavis, you make great points about the issues I listed. We can absolutely get to them later. 😊

The simple issues that you have listed seem to be a great starting point. Issue #3 seems like a great feature to implement as the hero item for the hackathon. Implementing it would be a large step towards a great user experience. The predictive model you have proposed also seems like a logical step.

Just to clarify, the coloration that is being performed is on the basis of gender and not the command state. Is that correct? Also, will the autocomplete be functional when a command state is selected?

@andrewtavis
Copy link
Member Author

Glad that you agree, @SaurabhJamadagni 😊 Again your suggestions were very valid, but I'm just trying to figure out the best use of our time at the moment :)

Answers to your questions:

  • Yes the coloration within Coloration of nouns in autocomplete and suggest #164 is based on gender :)
  • I would say for the MVP the autocomplete would not be functional for the command state. Let's have a discussion about how best to implement that, with your suggestions being very welcome. With the command bar spanning the rest of the screen, we wouldn't have the space to also present suggestions in another field, but we could potentially - later on - do say some greyed out text to complete what the user is typing, and if they press space then it's entered for them? How does that sound?

Looking forward to all this!

@SaurabhJamadagni
Copy link
Collaborator

I would say for the MVP the autocomplete would not be functional for the command state. Let's have a discussion about how best to implement that, with your suggestions being very welcome. With the command bar spanning the rest of the screen, we wouldn't have the space to also present suggestions in another field, but we could potentially - later on - do say some greyed out text to complete what the user is typing, and if they press space then it's entered for them? How does that sound?

Yes, I was going to suggest something similar @andrewtavis. We can work on extending the functionality during command states later when we understand and implement the basic mechanics. Currently, I like the implementation of having the suggestions in the command bar. It seems clear and very direct. The problem with the space bar implementation in my opinion is that we also have to implement undo functionality. For example, if a user just wanted the space and not the word completion, when they press delete we must store the previous word. That should increase complexity. So currently the suggestions in the command bar seem like a great step to go in. Of course, the functionality can be modified and extended later as you have in mind.

I am looking forward to working on this too! Excited for the event :)

@andrewtavis
Copy link
Member Author

All sounds good :) Let's look to do the planning call next week, @SaurabhJamadagni! Let me know when you're available and what your preferred chat app is (Google Meet, Zoom, Jitsi). I'm not available on Monday, but maybe Wednesday?

@SaurabhJamadagni
Copy link
Collaborator

Yes @andrewtavis, absolutely! Sorry for the delayed response. I had a few college assignments to complete. I am available on Wednesday any time between 08:30-13:00 (GMT). Else next I can jump on a call any time directly after 17:00 (GMT) 😅

Do let me know whichever time is convenient for you. Also I understand GMT is the timezone neither of us use, but I just thought it would be simpler. I was assuming you go by the Central European Time. Is that correct? I used GMT right now as I wasn't sure. So let me know if it's a bit of an odd timing. I can definitely adjust.

Google meet would be great as that is my most used platform. But I am perfectly fine with zoom :)

@andrewtavis
Copy link
Member Author

No worries on the timing! Hope your studies are going well 👏

Let’s do after 17:00 GMT, as I’ll be at work during the other times :) Using that time frame does make sense, btw, but as you’ll see in the Wikimedia circles folks usually say UTC for it 😊

For Google Meet, can you send an email to the one in my GitHub and I’ll send along a meeting link with a time?

Hope you have a great weekend!

@SaurabhJamadagni
Copy link
Collaborator

Hi @andrewtavis, I have sent the email to the address from your GitHub profile as you asked. I absolutely forgot to tell you yesterday 😅. I hope you have received it.

@andrewtavis
Copy link
Member Author

Hi @SaurabhJamadagni, did receive your mail :) Will reply later tonight with a link for tomorrow after I'm done with work and have some things for the hackathon finished 😊

@andrewtavis
Copy link
Member Author

andrewtavis commented Aug 10, 2022

@SaurabhJamadagni, I scheduled the session for 14:30 UTC on the 13th 🚀 You can check the schedule to see it, and here's the task for it on Phabricator (Phabricator is the task tracking software that Wikimedia uses). Let me know if you have any suggestions :)

I'll read through the schedule tomorrow to figure out what I'll attend :)

Again, nice meeting you tonight!

@andrewtavis
Copy link
Member Author

I also added us to the pre-hackathon showcase where I might talk a bit about Spanish, as there's a Spanish language group meeting right after, and will add it to the final showcase when we've made a bit of progress :)

@andrewtavis
Copy link
Member Author

Also, here's the presentation for the hackathon session. Let me know if you have any suggestions :)

@SaurabhJamadagni
Copy link
Collaborator

Thanks for sharing the presentation @andrewtavis. Excited for the session! Thanks for taking the time out to conduct it :)

It was an absolute joy to speak with you yesterday as well :)

@andrewtavis
Copy link
Member Author

andrewtavis commented Aug 11, 2022

Ok, so I finally got into Pheedloop 😅 Apparently my adblocker was screwing up the whole process of registering/logging in. As far as hackathon sessions, an organizer told me that the links to the Jitsi rooms will be posted to the Wiki shortly, so we'll be attending through those.

I said that I'd send along some interesting sessions that I'll attend. I'll say "Hack" if it's hackathon related, and just "Wikimania" if it's the main sessions.

Friday:

  • Hack: Hackathon Opening Ceremony (16-17 UTC)
    • I'll talk about the plan for Scribe during the hackathon here
  • Hack: Hackathon social (17-17:30 UTC)
  • Hack: How to organize a local Hackathon (19:30-20 UTC)

Saturday:

Sunday:

@SaurabhJamadagni
Copy link
Collaborator

Thanks for sharing this @andrewtavis! I can see a few sessions that would interest me among these. I am still confused on how to join these though. I can't find the Scribe session or the Wikidata session on the pheedloop event platfrom in the Sessions tab. Will the Jitsi link be posted on the schedule page or in pheedloop? 😅

@andrewtavis
Copy link
Member Author

andrewtavis commented Aug 12, 2022

There have been some issues with Pheedloop apparently, @SaurabhJamadagni (their first time using it). We were supposed to have a Technical Sessions and a Social Sessions space that we can find on Pheedloop, and then the schedule for the hackathon is here. That schedule gets updated as we go, and now has the links to the Jitsi rooms at the top of the schedule :)

For the Scribe and Wikidata sessions, we'll be in the Technical Sessions room, which can be found in the agenda.

Sorry for the confusion on this! Seems like there were a few hickups, but then this is why it's nice to know the people :)

@andrewtavis
Copy link
Member Author

@SaurabhJamadagni, just checking, you're planning on joining starting tomorrow, correct? I'll just plan on working on #188 this evening and then let you know what I get to. From there we can connect when I wake up in the morning 😊

@SaurabhJamadagni
Copy link
Collaborator

@SaurabhJamadagni, just checking, you're planning on joining starting tomorrow, correct? I'll just plan on working on #188 this evening and then let you know what I get to. From there we can connect when I wake up in the morning 😊

Absolutely @andrewtavis! I'll just go through the codebase tonight in preparation for tomorrow. Have a good evening. I'll check in with you tomorrow 😊

@andrewtavis
Copy link
Member Author

60 or so people at the hackathon opening ceremony, so we should have a nice group for tomorrow :)

@SaurabhJamadagni
Copy link
Collaborator

@andrewtavis what's the plan for the showcase? I don't need to have a presentation handy right? 😅

@andrewtavis
Copy link
Member Author

andrewtavis commented Aug 14, 2022

I can just talk about it if you want me to, or if you'd like you can talk about your part of creating the function :) Up to you :)

@SaurabhJamadagni
Copy link
Collaborator

SaurabhJamadagni commented Aug 14, 2022

I can give it a shot! I am currenlty on someone else's internet right now. So if I face any problems, you can take it from there.

@andrewtavis
Copy link
Member Author

Are you in there though? I don't see you :)

@SaurabhJamadagni
Copy link
Collaborator

I think I am now. I had joined a different link before 😂

@andrewtavis
Copy link
Member Author

Well done 😊

@SaurabhJamadagni
Copy link
Collaborator

I didn't know I could speak that fast @andrewtavis 🤣

It was super fun working with you on this hackathon! Looking forward to getting more stuff done! Thanks for all your help 😊

@andrewtavis
Copy link
Member Author

Pleasure working with you as well, @SaurabhJamadagni! Let's be in touch on #188 and #194 this coming week, but no stress on them :)

I updated the Wiki with info on results from the hackathon, so let's close this and take the rest to the issues themselves :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants