OpenSourceFellows / open-source-mentorship

Inspiring the next generation of open source contributors and maintainers
https://www.notion.so/programequity/ProgramEquity-Open-Source-Fellows-5f4dfc06109842779b81e8166c056334
Creative Commons Zero v1.0 Universal
13 stars 0 forks source link

✍️ @Konny's Blog #49

Open KonnyGuo opened 7 months ago

KonnyGuo commented 7 months ago

Timeline:

📋 Adding Authentication to Amplify with Passport.js

Requirements

Questions to consider:

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`

To Do: when you complete the requirements, add "outline ready" label on your issue

📰 Blog Rough draft: Format into a google doc

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?

To do: when you complete the requirements, add "draft ready" label on your issue

unnamedrd commented 5 months ago

@KonnyGuo did you have a link to a blog?

KonnyGuo commented 5 months ago

@unnamedrd sorry about that, I forgot to attach my link. Here is the link to the blog: https://docs.google.com/document/d/14by2NcBWglWQ5qrbY-qMMb5iERDLEN6M1vbnK2IP6sE/edit?usp=sharing

unnamedrd commented 5 months ago

No problem Konny! Thanks for adding that.

unnamedrd commented 5 months ago

@KonnyGuo You're a talented writer! I do have some comments, and have requested write access to the doc.

KonnyGuo commented 5 months ago

@unnamedrd you should have access now. Let me know if it works for you.

KonnyGuo commented 5 months ago

@unnamedrd I made edits based on the comments you provided. Feel free to take a look over it and see if everything is all good. https://docs.google.com/document/d/14by2NcBWglWQ5qrbY-qMMb5iERDLEN6M1vbnK2IP6sE/edit?usp=sharing