opensourcefellows / open-source-mentorship Goto Github PK
View Code? Open in Web Editor NEWInspiring the next generation of open source contributors and maintainers
License: Creative Commons Zero v1.0 Universal
Inspiring the next generation of open source contributors and maintainers
License: Creative Commons Zero v1.0 Universal
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name:
GitHub Handle:
Bio:
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link:
Notion Card Link: https://programequity.notion.site/CI-and-CD-with-GitHub-Actions-across-Clouds-b01a7ce28ef34e2cbbe110d23ff456cc
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Time: November 15th 1:30-2:30 pm pt
Zoom: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Open source maintainers try the best they can, actions are automations that can add workflows that bring us together in our collaboration. Thats the theme as we ramp with the tasks below.
User story: what kind of Action would make people more welcome to this project with either
Collaboration : Including communication and engagement tools
When: Thursday, Feb 29th, 2024
Time: 12:15 - 1pm PST
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Outline of session:
Hi Mentors๐
I want to extend an opportunity for you to take part in our Git Mentored session from Advocats and Program Equity. ๐ As part of our ongoing commitment to enabling open source maintainers from all backgrounds - especially early careers - we're excited to offer an hour 1:1 micro-mentoring session. This is an opportunity for attendees and our community partners to engage with industry experts (aka Hubbers) on career pathing and feedback. Please note, that this is open to all Hubbers and does not require a technical background.
Workflow:
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name:
GitHub Handle: @joenicastro @teakopp
Bio:
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link: https://www.eventbrite.com/e/hipaa-oauth-access-controls-tickets-532731964647?aff=ebdsoporgprofile
Notion Card Link: https://programequity.notion.site/HIPAA-Oauth-Access-Controls-af5b1b94be174bafa661817a76c14bd7
What is a Hack Pod?
Day of: Nov 8th 11:30-1:00 pm pt
Zoom: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Description
Theres always more documentation that can be added, how can new comers help any open source project and how can Copilot accelerate that? What to expect during a Hack Pod
Spec
User story: what functions, tests, or even workflows could use more explaining.
Prompt Engineering:
"what does this do" while highlighting the code
"refactor to make more readable" will add comments to the code
Resources:
Tasks: https://github.com/orgs/ProgramEquity/projects/8/views/19
Collaborate via zoom breakouts with fellows in a live workshop https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Once you sign up by commenting below, we'll confirm you with a calendar invite and add you to #advocats-content
Introduce yourself and background, ask fellow to do the same
Ask about what has been exciting to contribute to? (Potential topic)
Goal: create aย 30 second story board. Here's a checklist:
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name: Charlie Gerard, Cecil Phillips
Bio:
LinkedIn:
https://www.linkedin.com/in/cecil-phillip
https://www.linkedin.com/in/charliegerard
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link: https://www.eventbrite.com/e/test-driven-development-with-stripe-tickets-531656808827?aff=ebdsoporgprofile
Notion Card Link: https://www.notion.so/programequity/Test-Driven-Development-With-Stripe-40de27d593d748e08fdf47296807eab5
Title: How to Welcome first-time contributors to your repo and why it is important to do so
- What is a Welcome Message?
- Why use Welcome Messages?
- How to create Welcome Message?
- What is Github App?
- Configure yml
- Testing
- Summary and call to action
Timeline:
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Presenter: Ruby Sattar, Senior Developer Advocate, Student Programs @ Postman
LinkedIn: https://www.linkedin.com/in/rubydotgif/
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link: https://www.eventbrite.com/e/working-with-apis-with-postman-tickets-531615746007?aff=ebdsoporgprofile
Notion Card Link: https://www.notion.so/programequity/Working-With-APIs-Postman-dd8dd1af5c1a44b69ca5a08723a7ff3f
Extra Resources:
https://blog.postman.com/http-cats-learn-http-status-codes/
https://learning.postman.com/
www.postman.com/student-program
A Hack Pod is a 1-2 hour engagement between our GitHub teams and a customer/partner as we uncover places we can create reference architectures that act as starting points for customer adoption. Open source fellows (maintainers of this repo) drive the projects to completion/maintain them.
๐ This Hack Pod is planned for mid-April from 12-1:30 pm PT.
What is expected of me as a participant?
On Game Day of the Hack Pod we'll convene on Zoom and then fan out in breakout rooms. Each track will have its own breakout and a few additional rooms will be available for areas customers feel passionate about.
Agenda:
How we hack: Each track breakout room (e.g., SCA/Dependabot) will consist of 2 leads, 2 maintainers and 6-8 customers. Maintainers are there to go 1:1 as needed in extra rooms.
Roles:
What are we hacking on?
This Hack Pod focuses on jumpstarting JPMC's understanding of security through the following:
SCA/Dependabot and how to update your code post PR @momartinjazz @manishapriya94
CodeQL examples @pwntester
Actions that integrate with other tooling for DAST, reporting, and other use cases @therealkujo @CallMeGreg
Timeline:
1. Rough Draft
Fellow & Topic | Reviewer 1 | Reviewer 2 |
@rsensenig brainstorm | @lclindeman | @ktravers |
@SAUMILDHANKAR brainstorm | @ghostinhershell | @mscoutermarsh |
@yoyoyojoe brainstorm | @lclindeman | @mscoutermarsh |
@Alex-is-Gonzalez brainstorm | @UnicodeRogue | @GreCodes |
@beverand brainstorm | @ghostinhershell | @ktravers |
@masmei brainstorm | @UnicodeRogue | @GreCodes |
Resources:
Onboarding Deck
When: Thursday, April 6th 2023
Time: 1-2 pm pt
Outline of session:
Hi Hubbers ๐
I want to extend an opportunity for you to take part in our Git Mentored session from Advocats and Program Equity. ๐ As part of our ongoing commitment to enabling open source maintainers from all backgrounds - especially early careers - we're excited to offer an hour 1:1 micro-mentoring session. This is an opportunity for attendees and our community partners to engage with industry experts (aka Hubbers :MLH: ) on career pathing and feedback. Please note, that this is open to all Hubbers and does not require a technical background.
Who: OSS Mentors and MLH students
What: Provide attendees with an informal opportunity for mentoring via Zoom ๐ป
Topics | Discussion Notes |
---|---|
Career Pathing | Mentors/Mentees share their personal and professional journeys and discuss areas of interest. Provide resume feedback, ask the mentee their 3-5 year planning goals, plans to achieve their goals, and discuss skills necessary to achieve these goals; what type of training should your mentee receive to grow in this field? ย Be specific and give specific resources. |
Comment below to sign up
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name:
GitHub Handle:
Bio:
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link:
Notion Card Link: https://programequity.notion.site/Securing-Your-Open-Source-Workflow-with-GitHub-Security-Lab-and-Snyk-36173ea5919c4922be0ac11f16fff56f
Name: Chitra Kapoor
GitHub Handle:
Bio: Solutions Engineering at LaunchDarkly
LinkedIn: https://www.linkedin.com/in/chitra-k
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Notion Card Link: https://programequity.notion.site/Feature-Management-with-Deployments-with-LaunchDarkly-061fc508716144cbb6587c7776343c33
Do we want this internal to org, customer or pair with fellows?
How many hours? 2-4
How many participants? We typically recommend 1 maintainer to 5 participants
What are project areas?
What is a HackPod?
A 2-3 hour hacking session with open source fellows for customers or partners to embody the full GitHub experience and create reference architectures
[ Add picture ]
Event Roadmap
Operations:
Create reference architecture with potential workflows with AWS
Teams that are scoping issues and weighing in on implementation guides:
Will ship from scoped issues
Problem statement expanded:
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Wednesday, February 15th, 11:30 -1 pm pt
https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Event Details: 40-80$ of Benevity donations
Goal: Improve Amplify's documentation and use it to provide a good model of documentation and OSS maintainership for MLH fellows
As part of our ongoing Open Source Mentorship program, fellows have been working on Amplify. We'd like to clean up and organize the documentation, add some things to improve the contributor workflow, and start working on documenting the app's API endpoints and third party API usage using OpenAPI
Timeline:
Questions to consider:
Whoโs reading this? Where are they in your dev journey? What do they need to know before they can dive into this story?
This post is mainly for developers with Node.js and Express experience who are looking to add authentication to an application. Some understanding with sessions, encryption and authentication concepts would help.
If people could leave with just one action, what would it be?
Implementing authentication is a crucial task for any application. Using Passport.js gives a balance of security, simplicity and scalability. The local strategy delivers secure password login flow, and allows the flexibility to extend authentication features for the future.
Were there surprises or alternative problem solving you want to give a heads up to?
There are many other Passport.js strategies that we could have implemented. But we chose the local strategy for its flexibility, simplicity and scalability for the future. An auth middleware file was also implemented to help redirect admins to the correct pages when they are logged in. If admins are not logged in, the middleware is used to redirect them to the login page to sign in so that certain pages can be accessed.
Outline Structure:
Why is security important for any application and what do we consider when implementing it?
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name:
GitHub Handle:
Bio:
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link:
Notion Card Link:
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Topic for blog post
Adding Auth0 to the Amplify app
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Resources:
Use cases for reference architecture
When: Thursday, April 6th 2023
Time: 1-2 pm pt
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Outline of session:
Hi Hubbers ๐
I want to extend an opportunity for you to take part in our Git Mentored session from Advocats and Program Equity. ๐ As part of our ongoing commitment to enabling open source maintainers from all backgrounds - especially early careers - we're excited to offer an hour 1:1 micro-mentoring session. This is an opportunity for attendees and our community partners to engage with industry experts (aka Hubbers :MLH: ) on career pathing and feedback. Please note, that this is open to all Hubbers and does not require a technical background.
Who: OSS Mentors and MLH students
What: Provide attendees with an informal opportunity for mentoring via Zoom ๐ป
Topics | Discussion Notes |
---|---|
Career Pathing | Mentors/Mentees share their personal and professional journeys and discuss areas of interest. Provide resume feedback, ask the mentee their 3-5 year planning goals, plans to achieve their goals, and discuss skills necessary to achieve these goals; what type of training should your mentee receive to grow in this field? ย Be specific and give specific resources. |
Questions to consider:
Whoโs reading this? Where are they in your dev journey? What do they need to know before they can dive into this story?
If people could leave with just one action, what would it be?
Were there surprises or alternative problem-solving you want to give a heads up to?
Talking points
Why does software need security/authentication/authorization?
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name: Ian Candy
GitHub Handle: @ipc103
LinkedIn:
Name: Jรผrgen Efeish
GitHub Handle: @jefeish
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link: https://www.eventbrite.com/e/documentation-for-open-source-projects-tickets-531614702887?aff=erelexpmlt
Notion Card Link: https://www.notion.so/programequity/Documentation-For-Open-Source-Projects-ab792338802e494c8e491ccd128d65af
see outline here: https://github.com/ProgramEquity/open-source-mentorship/blob/main/Workshops/documentation_for_open_source.md
Name: Liran Tal
GitHub Handle: @lirantal
Bio:
Liran Tal is an award-winning software developer, security researcher, and open source champion in the JavaScript community. He's an internationally recognized GitHub Star, acknowledged for his open source advocacy, and has received the OpenJS Foundation's Pathfinder for Security for his work on Node.js security. His contributions to developer security education include leading OWASP projects, building supply chain security tools, participation in CNCF and OpenSSF initiatives, and authoring books such as O'Reilly's Serverless Security. He leads the developer advocacy team at Snyk.io and is on a mission to empower developers with better application security skills.
LinkedIn: https://www.linkedin.com/in/talliran/
Name:
GitHub Handle:
Bio:
LinkedIn:
Zoom Link: https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
Eventbrite link: https://www.eventbrite.com/e/securing-your-open-source-workflow-with-github-security-lab-and-snyk-tickets-532730861347?aff=ebdsoporgprofile
Notion Card Link: https://programequity.notion.site/Securing-Your-Open-Source-Workflow-with-GitHub-Security-Lab-and-Snyk-36173ea5919c4922be0ac11f16fff56f
Slide link: https://docs.google.com/presentation/d/1tuZfMqUDvzSqVvcfws-2pODoQJXwWIA2lMiuDDkanmU/edit?usp=sharing
Demo Steps
// function to generate a random number
// start typing
function randomNum() // to see copilot jump into action
// You can hover over the suggested code to accept the solution or seek more solutions if available.
// That's one way, you can also start typing comments directly
// write a function to multiply 2 numbers
function multi // and it should come up with auto suggestions
// Let's say we want to accept the suggestion and also write the output to console:
console.log // And it'll auto complete it for me, you can run it from the terminal node index
// We can switch to something a little more fun. There is always a need to work with dates:
// create a function to get current date
function getData() { // accept and wait a bit after hitting return
// it gets a nice output format for us too with additional information
// let's log it by starting to type 'console.log' or comment write output to console
// Now letโs say we wanted to get yesterdayโs date, start writing the comment // output
// the current date
// The completed sequence would look like below:
// create a function to get the current date
function getDate() {
var date = new Date();
var day = date.getDate();
var month = date.getMonth() + 1;
var year = date.getFullYear();
return day + "/" + month + "/" + year;
}
// output the current date
console.log(getDate());
// run it from the terminal by typing node index
// Let's improve on this. Now we want a function to get yesterday's date
// type: //create a function to get yesterday's date
// Accept 'tab' through each line
// Now after output of current date just start the comment with // and it'll automatically
// write out the comment to get yesterday's date. This is an example of Copilot
// learning the context and synthesizing the suggestions based on context
// Now let's try updating the format of the output for current date
// output the current date
console.log("Today's date: " + getDate());
// output the yesterday's date
console.log("Yesterday's date: " + getYesterday());
// Notice the only code I have written so far is this, rest were all generated by Copilot
// Including format of the dates
// Ok so what if we wanted to update the format, but I don't want to look up
// JavaScript syntax?
// Start typing: // print the date in format or just // after console.log to see the magic
// Then perhaps output yesterday's date in different format, just type //. What happens?
// Magic, it seems like Copilot knows what I want as soon as I start thinking about it
// Completed sequence looks like below:
// output the current date
console.log("Today's date: " + getDate());
// output the yesterday's date
console.log("Yesterday's date: " + getYesterday());
// output the current date in a different format
console.log("Today's date: " + getDate().split("/").reverse().join("-"));
// output the yesterday's date in a different format
console.log("Yesterday's date: " + getYesterday().split("/").reverse().join("-"));
// Ok let's try something different
// Story: I returned from a trip to Europe recently and the temperatures there were
// all in degrees celsius. So I'd hear 34 degrees today, or 36 degrees today
// but to me all it meant was hot, I didn't know exactly how hot. I could use a temperature
// converter to convert celsius to Fahrenheit and then I'd know.
// So let's build it, start typing the comment below:
// convert celcius to fahrenheit
// Accept the suggestions, then write another comment to output the result
// Accept the suggestion and run it to see it in action
// Wow 34 degrees is 93.2 and it was humid, no wonder I was melting
// Let's try 37 which was the max I faced.
// Yup, pretty hot.
// Let's try something different. Let's say I wanted to generate some data, but I didn't
// know what to start with, and I don't want to think. I want to be guided
// just to get it going, let's try, write the comment below:
// Generate some random data
// Accept the way through
// Write a comment to output the data
// Aah, I see I have an array of 100 random numbers. Interesting
// So this gives me an idea
// What if I wanted to create an array of names? Maybe I want to work with strings
// Let's try create an array of names, accept the change
// Great!
// output a random name from the array? Try it
// run node index from the terminal to see results
// Ok, that's just 4 names, ok I'm running out of ideas, so if I want to remain
// in this coding mode, maybe a function?
// Let's see what Copilot thinks I would want to do next?
// Start typing // create a function in the next line
// Wow nice, it's formalizing the process for me. It seems the next logical
// step given I'd want this process to be repeatable to package this
// in a function, let's try, nice!
// Now let's create an array of numbers
var numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
// create an array of colors
// Ok now what's interesting here, is notice it's choosing var by default for me.
// Let's say I want to use const instead of var. Let me go ahead and make that
// change. Now let's create another array of words.
// Notice what happened, Copilot changed it's suggestion and came up with
// const, instead of var. It's learning my style on the fly, based on the context
//Let's try again with numbers, the suggested response should
// be as below:
// create an array of numbers
const numbers = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10];
// You can extend this to classes as well. For simplicity let's create a calculator
// class, accept through a few methods, when you want to stop, start typing class
// create a calculator class
// add a method to add two numbers
// add a method to subtract two numbers
// add a method to multiply two numbers
// add a method to divide two numbers
// Now you see the suggestion has the 4 methods that my comment specified
// You can use it
// The completed sequence looks like below:
// create a calculator class
// add a method to add two numbers
// add a method to subtract two numbers
// add a method to multiply two numbers
// add a method to divide two numbers
class Calculator {
constructor() {
this.value = 0;
}
add(num) {
this.value += num;
}
subtract(num) {
this.value -= num;
}
multiply(num) {
this.value *= num;
}
divide(num) {
this.value /= num;
}
}
// create a new instance of the calculator class
const calc = new Calculator();
// add two to the calculator
calc.add(2);
// output the result
console.log(calc.value);
// subtract 5 from the result
calc.subtract(5);
// output the result
console.log(calc.value);
// checkout action from marketplace autolabel
// build workflow and fill in auth pieces
So that concludes our first look at GitHub Copilot. Any questions?
Copilot docs - includes getting started
Copilot feature page
Copilot GA post
Are we workshop ready?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
User story: what kind of Action would make people more welcome to this project with either
Collaboration : Including communication and engagement tools
2022-02-22
Maintainers for reference are assigned
Pair Hour Mentors: assign yourself in each task when its ready to review
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
This is a draft to be worked on further.*
Resources:
Timeline:
- ๐ Week 4: Create an outline by 3/2
- ๐ฐ Week 7: Rough draft due by 3/16
- Mentor reviews by 3/30
- Week 9: Final version due 4/7
I think I'm going to go with Idea No. 2 and save Idea No. 1 for another day, but just keeping it here as notes (it was the first idea that came up).
Topic: What makes good documentation?
Inspired by Documentation for Open Source Projects
Start
Intro paragraph:
Middle
Helpful examples/concepts:
End
Summary:
Additional Resources:
Topic: TDD: Creating tests for Stripe
Inspired by Test Driven Development with Stripe
Also this is an issue that I'm working on and what I'm hoping to be more familiar with
Start
Intro paragraph:
Middle
End
Summary
Additional Resources:
Hashtags?
Questions to consider:
Sample Topics for your blog post
- Creating tests for Stripe/Cicero/Twilio
- Using Vuetify and V-cards
- Debugging a PR test failure affecting entire codebase and creating an issue for it
- System Design/Architecture design for caching capability
- Implementing Text to Speech
- Configuring secrets for APIs in codespaces
- Building Actions for [security|community|CI| etc]
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Draft: How to test a Stripe API (with permissions to comment)
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Questions to consider:
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Hi Hubbers,
We're asking your participation in an hour workshop. We are looking for 12-16 volunteers who can give actionable feedback to our early career open source fellows - count towards volunteer hours in Benevity!
Please sign up by dropping your name in comments, if you'd like to be part of additional workshops or pair hours - fill out this form
Join slack channel #octo7-advocats and make sure to watch this repo! Here's how to log hours in Benevity to get donation credits
Hi and welcome to Content Lab! Here is a self paced guide to ensure you get feedback as you publish your technical blog.
Resources:
Timeline:
Questions to consider:
Sample Topics for your blog post
Example Outlines
What makes good documentation on open source?
- Could this be a list? (3 pieces of documentation thats easy to check for and add to the project to add immediate value?
- What inspired you from the Tech documentation workshop?
- What would you help encourage other first time contributors to do?
- Is a learning curve for everyone? And whats the balance between good documentation and too much documentation? Choice architecture
- What is each space used for? Wiki vs Discussion vs Pages
- How do we search and find?
Reference: https://blackgirlbytes.dev/conquering-the-fear-of-contributing-to-open-source
Reference issue/PR for photos
Conclusion: Documentation is always changing, will always be needed`
Questions to answer across draft
- Why is this helpful for a reader?
- What problem does this help them solve?
- What kind of experience should the reader have or that you will provide so theyโre up to speed
- What larger problem is this solving?
- Were there other ways of solving this problem - what made you choose the one that you did?
- What were the positive tradeoffs? (Did it save time? Save hours? Was more secure?)
- What is the best way to present the content (i.e. code snippets, graphics) ?
- What additional resources can they provide the reader if they want more information?
- Is there a call to action?
Name:
GitHub Handle:
Bio:
LinkedIn:
https://github.zoom.us/j/97013759503?pwd=aDd5NmNKQTNsbGlLQWhuSm4vVEFGdz09
No response
https://programequity.notion.site/Resume-Review-47fde41e28bb427a9a3cd576f05f12d0
No response
No response
A declarative, efficient, and flexible JavaScript library for building user interfaces.
๐ Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
An Open Source Machine Learning Framework for Everyone
The Web framework for perfectionists with deadlines.
A PHP framework for web artisans
Bring data to life with SVG, Canvas and HTML. ๐๐๐
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
Some thing interesting about web. New door for the world.
A server is a program made to process requests and deliver data to clients.
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Some thing interesting about visualization, use data art
Some thing interesting about game, make everyone happy.
We are working to build community through open source technology. NB: members must have two-factor auth.
Open source projects and samples from Microsoft.
Google โค๏ธ Open Source for everyone.
Alibaba Open Source for everyone
Data-Driven Documents codes.
China tencent open source team.