Develop an onboarding script
Is your feature request related to a problem? Please describe. As a new developer, I would like to have a Python script that will print a greeting message whenever it is run. The greeting message should provide a warm welcome to whoever runs it and provide a list of useful links to places where someone new to the PHLASK project can learn more about:
- Our mission
- Our Development, Design, Data, and Civic circles
- What each circle is doing
- How to reach out to our team
- Our meeting rhythm
- Our technology stack
Describe the solution you'd like A python script that prints a message with the items described above.
Describe alternatives you've considered N/A
Additional context N/A
@gcardonag, @RNR1, @freelyPheobe, @tomporvaz (Tom, I hope this is your correct handle)...
I just realized something. First of all, to catch you up, Gabe. We had a discussion, re: the necessity of this ticket/feature, which originated from a qn from me to Ron, re: where should I station (so to speak) the script?
We thought out-loud via a disc'n, and Ron and others suggested that this feature might be redundant, given the current existence of a "Read Me".
As for my realization:
Instead of merely a script--text, Python, whatever, how about a sub-directory with debugging "lessons learned," including code snippets, etc.? Obviously, this sub-dir wouldn't affect the rendering of the app's substantive code.
Idk if I'm making sense. I guess the bottomline qn is: does that kind of feature/tool already exist? As in, a sub-directory or script-set--to welcome new devs, and to help them with debugging? If "no," then Fran and Tom, I take back my artificial self-imposed late-Jan ('24) deadline. But I will have to create the feature/tool, then close the ticket. And I guess thereafter, all devs can add to it as needed--as in, re: "lessons learned," code snippets, etc.
FCOL, could some1 plz tell me I'm making [at least an iota] of sense?! (LOL...) @mandyshri101: Feel free to also pitch in, bro! (LOL...) Unless you're gonna say: "Um, Seif, sorry! Your idea is c^^p / s^^t!" (1 last LOL / ROFL)
Thx, folkx.
@dibleauzah to update scope of ticket
To elaborate on this one, the intent of this was to evolve it into some Slack automation that would kick in when someone joins the #phlask_dev Slack channel and provide this information via DM! That way folks could get onboarding-type information without waiting until our onboarding standup. It would also start to serve as a script for anyone to be able to take over dev circle onboarding in the future.
@tomporvaz, @freelyPheobe, @gcardonag, @dibleauzah, @RNR1: Here's the PR I just created, with a clear explanation of the purposes and evolution of the ticket's tasks. Thanks.
PR title and link: Creating utilities sub-directory and its README file #379
Sorry if the edits keep pinging y'all. I just wanted to add: please let me know if I can/should edit the comment for further clarity or detail. Thanks again.
Hi folks. @tomporvaz, @freelyPheobe, @gcardonag / @RNR1 & @affabillyty:
It looks like the last PR (#379) was not approved / completed?
Remember @vontell, you helped me fix an issue with it--I have a brain-freeze at the mo.-though, remembering the exact nature of the isssue.
But @tomporvaz, @gcardonag / @RNR1, the PR's purpose is to push the creation of the (sub-)directory that will host the new dev-onboarding and bug/best-practice resources and documentation.
I hope I'm not missing something? As in, plz alert me to anything I need to do, to help move things along.
Thanks, Seif.
Hey @dibleauzah , prior to merging the directory, has any of the content been generated for the directory? I think it could go all at once.
@affabillyty: I believe the approach that was approved earlier by the group--during the last discussion we had about it--I believe @gcardonag in particular "stamped his approval" on it (that approach), was:
"Baby steps" / step-by-step approach; step 1: create the sub-dir at the root level, which would host the new resources. And this PR--which @vontell helped me with, pushes that new dir. Let me find it on my local machine--I'll add a screenshot here for reference.
Alert: @affabillyty, @gcardonag, @tomporvaz / @freelyPheobe
CC: @vontell
Here's the sub-directory we created; i.e., "Utilities," at the repo's root--Gabe, Idk if you recall, but you're the one who oh-so-kindly guided me, re: where to put it, and what to call it.
(Pic Attached.)
Awaiting conveners' check and comment/approval for PR: https://github.com/phlask/phlask-map/pull/396
Details of PR:
- I created a couple of the new sub-DIRs to house the tech-stack docs.
- I also created the new debugging "lessons-learned" file (in RTF format).
@RNR1 Please take a looksie, in case Gabe's hands are full (?).
And fyi, @tomporvaz / @freelyPheobe / @affabillyty
Thanks, everyone.
@RNR1 & @gcardonag Please see PR for my response to Ron.
@tomporvaz & @freelyPheobe / @affabillyty, please note: I just left the comment below on the current relevant PR for this ticket. As soon as it (the PR) is approved, I'll continue pushing other updates.
//=====// My latest comment on PR-396:
// Link: https://github.com/phlask/phlask-map/pull/396
A quick gentle check-in / reminder, folks. I know how overwhelming the Tuesday hack-night seshes often are for you, the conveners. So I just wanted to gently remind you of this PR. Per my response to you Ron, your concern is valid, but the purpose of the sub-DIR matches with what you're saying. IOW, the plan is for it to also house re-usable code scripts, etc., per your concern.
End of Comment. //=====//
Hi, folks. Just a quick update ahead of today's--May 7, 2024--hack-night meetup: I'm still working on this ticket--no "blockers" or problems (/issues) to report. Just a general request to please bear with as I continue the work.
Thanks, Seif.
Brief Update:
I just shared my latest progress via the dev-circle's Slack channel. My request is for anyone with relevant advice to please (kindly) offer it. Most importantly though, I hope @gcardonag and I/myself will manage to consistently carve out some time regularly, to keep working on the ticket.
Thanks, folks.
--Seif.
@dibleauzah Hey Sorry, I was travelling at the time you tagged me.
Just sent an update-msg via the relevant Slack group chat to @tomporvaz; the group also includes @gcardonag & @affabillyty.
Just took myself off this ticket. Leaders [ and/or @affabillyty & @tomporvaz ] : please feel free to re-assign it. Thanks.