Some mentoring guide updates#538
Uh oh!
There was an error while loading. Please reload this page.
Conversation
Plain HTML links are not automatically hyperlinked in the rendered site. So, correct them this by using Markdown link syntax while using this opportunity to also add some more information about the links. While at it, also add a link to Charvi's blog source repository.
…tors The information about notifying the mailing list and the mentors about new blogs seem to be mixed together which made it a bit hard to understand the paragraph during a first read. So, better split them to distinguish them. This hopefull makes the text better readable.
The syntax used for an ordered list isn't one that is recognized by the Markdown parser used for the generated site. So, the list is rendered in HTML as though it is not a list thus needing change done in bda6f86 (Mentoring-Program-Guide: make lines break, 2021-06-14). Change the syntax for the list to use the proper Markdown syntax for an ordered list. As this makes the fix mentioned in the commit above unnecessary, that change has been reverted too.
chriscool commented Jan 28, 2022
Yeah, it could be. I need to take a look at this. Maybe after reviewing this PR... |
Mentoring-Program-Guide.md Outdated
| # Conclusion | ||
| Hope you got an idea about how things usually go during the internship. |
There was a problem hiding this comment.
Maybe "internship/GSoC/mentoring period" as "internship" is for Outreachy only. In general it was not easy when writing this and other such docs to make sure the terms would work for Outreachy, GSoC and possibly other future programs. Maybe somewhere we should have some kind of internal docs/dictionary listing the terms we should use.
There was a problem hiding this comment.
Maybe somewhere we should have some kind of internal docs/dictionary listing the terms we should use.
Yeah. That would be good to have. I'll try and see if I could find the time to come up with this one.
Mentoring-Program-Guide.md Outdated
| are a bit different than what is described here. Typically your mentors | ||
| will expect that you become more autonomous. | ||
| Wishing you luck during the internship! |
There was a problem hiding this comment.
Same thing about "internship".
BTW maybe we should already work on scripts detecting and possibly replacing some terms.
There was a problem hiding this comment.
BTW maybe we should already work on scripts detecting and possibly replacing some terms.
Yeah. If we have a glossary, this is definitely a good next step.
Mentoring-Program-Guide.md Outdated
| Hope you got an idea about how things usually go during the internship. | ||
| As a reminder, don't be surprised if your mentors ask for things that | ||
| are a bit different than what is described here. Typically your mentors | ||
| will expect that you become more autonomous. |
There was a problem hiding this comment.
I like it! Maybe:
"Typically your mentors will expect that you become more autonomous over time and will adjust things depending on how autonomous you already are".
| abilities and dedication. A good example is Matheus' GSoC blog posts: | ||
| https://matheustavares.gitlab.io/tags/gsoc/ | ||
| [Matheus Tavares' GSoC posts](https://matheustavares.gitlab.io/tags/gsoc/) |
chriscool commented Jan 28, 2022
Except the few nits in the conclusion, this looks great to me! Thanks! |
Use mentoring program generic words in the conclusion and rephrase a sentence based on Christian's feedback.
sivaraam commented Jan 28, 2022
Thanks Christian! I've made changes based on your suggestions. Kindly take a look. I'll see if I could find time to look into that glossary for program generic terms that we could use. |
chriscool commented Jan 30, 2022
Thanks again @sivaraam ! |
2 participants
I happened to give the mentoring guide a read and noted some things that could be improved. I've done changes for those which are tracked via this PR. Do take a look and let me know your thoughts.
One thing I wanted to note. There's the following line in the guide:
But there doesn't appear to be any mention about students deciding their best time to update blog and send notifications before that. Would it be a good idea to mention that before in the section about "Regular updates" ?