search

edgi-govdata-archiving / web-monitoring

Documentation and project-wide issues for the Website Monitoring project (a.k.a. "Scanner")
Creative Commons Attribution Share Alike 4.0 International
105 stars 17 forks source link

Comments on Trello board: EDGI: Web Monitoring Project - Onboarding #44

Closed KrzysztofMadejski closed 5 years ago

KrzysztofMadejski commented 7 years ago

Ping @patcon

KrzysztofMadejski commented 7 years ago

https://trello.com/c/yRMYHQie/13-get-memberized-on-our-github-teams has a task Consider setting your new memberships to "Public" (See "People" tab on org profile) -- Hooray for future job interview cred! @b5 @titaniumbones you're set to private on https://github.com/orgs/archivers-space/people ;-)

patcon commented 7 years ago

Oh! This is great feedback, @KrzysztofMadejski! Unfortunately, I wasn't advertising the board after our sprint, so it wasn't quite ready for usage yet (though I'm certain I poorly communicated this to the devs, so my fault there). So I'm truly sorry for any time I caused you to waste. But again, you comments are REALLY helpful! and hopefully despite the missing pieces, you still found it helpful!

It seems I need the equivalent of a "master"/"develop" branch on Trello, as some of these cards we stubs so that I didn't forget to add content later...! But that def shouldn't happen when people are actively depending on it.

From now on, I will work on another board and transfer cards to that one only when complete :+1:

patcon commented 7 years ago

For now, I'm going to clearly mark the incomplete cards (to avoid taking anyone else's time for granted), and I'll flesh them out asap.

patcon commented 7 years ago

Great call @KrzysztofMadejski. Added the heroku link to the trello card, and the video description.

  • TODO it's not clear where to get spreadsheet links

@lightandluck what's your suggestion here? I'm unclear on the flow :)

  1. Are the sample spreadsheets still appropriate to use?
    • If so, can we add back auto-filled defaults like we used to have?
  2. Is this video still a resource you'd recommend onboarding with?
  3. Should we bother to address where the actual URLs will come from? (or even just hint that "how to get them" will be better addressed in the 50-minutes analyst training video?)

https://trello.com/c/ZoaSMbpy/8-explore-the-live-app > there is nothing the explore :|

Any thoughts on how we could make this a better experience?

most of the links connect to Versionista, but it asks for login

@danielballan Does versionista have a really low-level readonly access? Maybe we could provide some sort of limited access credentials on the trello board? (or perhaps the videos are good enough)

If not, should we better explain this in the trello card or interface?

Split How to help? into analyst and webdev

Glad to hear this thought. This has come up @titaniumbones and I, but I don't think we've spoke with Maya and Toly, who currently liase with analysts and bring them up to speed. We should get their thoughts, for sure.

I'd link Trello onboarding in How to help?

That's a great idea! I'd love to address your pain points first, but open to others' input on this!

cc: @mayaad @lightandluck @Mr0grog @danielballan

lightandluck commented 7 years ago
  1. Are the sample spreadsheets still appropriate to use?

No, we shouldn't be focusing on the spreadsheets anymore. The gapi app was meant to be a transitional prototype to be on parity with the analyst workflow. We were hoping to get some use and feedback but after speaking with the admin team, they would like v0 to be more fleshed out before trying to switch people over. Namely, having comparable diff services to remove the need for linking out to versionista.

  1. Is this video still a resource you'd recommend onboarding with?

No, the video was only meant to show an analyst quickly how to use the gapi app. Both the gapi app and video should be deprecated and not used for onboarding. We should direct people interested in UI to the React app.

  1. Should we bother to address where the actual URLs will come from?

For the UI, all data is coming from web-monitoring-db: urls, annotations, diffs, etc. We can certainly address that. Anyone interested should go to staging and play with the API. Now, how the DB gets all that data is a better question for Mr0grog.

We should remember that even though web-monitoring is split into different projects, they are meant to work together as a single app. The UI is just a thin layer to work with the DB in a friendly way. DB and processing are the most important parts and understanding that relationship helps think about the project.

IMHO, Understanding the data coming from DB, how to get it and what it represents should be more important during onboarding instead of looking at the UI.

Any thoughts on how we could make this a better experience?

Unfortunately, users can't see the Versionista links without our login credentials, which can't be given out freely. This issue elaborates on that with some helpful screenshots.

I think the best way to get a good sense of the why and how of web-monitoring would be the first 20ish minutes of the dev onboarding video which is a really good overview. Then the 50min analyst training video (sorry I don't have a link), which breaks down the current analyst process. Then, whether the person was more interested in DB or UI, they could either watch the rest of the dev onboarding except last 20ish minutes of Q&A or the UI+Analyst meeting (part1, part2). Honestly, I recommend watching everything. (At 1.5x speed helps!)

The analyst meeting will probably grow stale over the next couple months because in it we're talking about immediate problems which hopefully will be solved soon. It's not comprehensive, but gives a good sense of current needs and some of the workflow on the admin side. The dev onboarding should be more evergreen barring some monumental change.

patcon commented 7 years ago

Thanks @lightandluck! The last 2 paragraphs will be particularly helpful. I'll mine this for next steps tomorrow

(I just added your helpful summary from before as a TOC in the dev onboarding video description (new url in EDGI YouTube account instead of my personal one btw, so update your links if needed). So also belated thanks for that!)

stale[bot] commented 5 years ago

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in seven days if no further activity occurs. If it should not be closed, please comment! Thank you for your contributions.