hackforla
Update the Web Developer wiki page
Overview
As a developer, I want the Web Developer wiki page to be up to date and an informative resource for developers interested in joining our team and for current developers on the team. For this issue, we will update the Web Developer wiki page.
Action Items
- [x] We are currently in the process of moving the old wiki to the new website-wiki repo, so we will not be making any changes or additions to the old wiki at this time. Thus, we will be adding wiki content through a different process now. Read How to Contribute to the Wiki
- [x] For an example of a good role-based wiki page, see UI UX Researcher wiki page
- [x] Take a look at what is in the developer pre-work checklist. Is there anything on the pre-work checklist that could be useful on the Web Developer wiki page?
- [x] Take a look at the files in our Wiki. Is there anything there that would be good to link to on the Web Developer wiki pages?
- [x] Update the Web Developer wiki page
- [x] Include information about issue progression: All developers should progress from two good first issues to small to medium and then another medium or large issue. Afterward, a developer can pick any medium or large size issue to work on.
Resources/Instructions
- Web Developer wiki page
- Developer pre-work checklist
- Wiki
- For an example of a good role-based wiki page, see UI UX Researcher wiki page
Hi @JessicaLucindaCheng.
Good job adding the required labels for this issue. The merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.
Additional Resources:
![github-actions[bot] avatar](https://avatars.githubusercontent.com/in/15368?v=4 "Published by a pub.dev verified publisher"){kind=small}
@ExperimentsInHonesty @Providence-o I normally wouldn't assign myself to an issue in the New Issue Approval column. However, since updating the Web Developer Wiki page was asked to be done ASAP during our Dev/PM meeting on [2022-Feb-05] (https://github.com/hackforla/website/issues/2607#issuecomment-1030273048), I have gone ahead and assigned myself and @SAUMILDHANKAR to this issue, so we can start working on it ASAP.
@SAUMILDHANKAR I have already updated with what I think should go in here but I wasn't sure whether some links under Getting Started should go under Other Helpful Resources (and vice versa): https://github.com/hackforla/website/wiki/Web-Developer
Also, I didn't add a line to contact Technical Leads if they have questions because the UX Researcher one doesn't include that and I couldn't figure out where to fit it.
@ mention me in a comment below when you are ready for me to take a look at the Web Developer Wiki page again.
@JessicaLucindaCheng Thanks for updating the page. I checked all the links, redirecting fine. Thank you.
@SAUMILDHANKAR The links redirected fine. That wasn't a problem. The problem for me was figuring out what content should be in the Getting Started section and which should be in the Other Helpful Resources section. Currently, I think we have too much in the Getting Started section, since it is geared towards people just starting out. When you are done editing it, let me know because I want to make some changes.
@SAUMILDHANKAR The links redirected fine. That wasn't a problem. The problem for me was figuring out what content should be in the Getting Started section and which should be in the Other Helpful Resources section. Currently, I think we have too much in the Getting Started section, since it is geared towards people just starting out. When you are done editing it, let me know because I want to make some changes.
@JessicaLucindaCheng I have made some changes to make the Getting Started section more concise. Please take a look. Thank you.
@SAUMILDHANKAR
@JessicaLucindaCheng I have made some changes to make the Getting Started section more concise. Please take a look. Thank you. It looks great! Thanks for all the work you put into it! I'm going to put it in our PM/Dev meeting agenda, so the PMs can take a look at it.
@Providence-o @ExperimentsInHonesty Can you please take a look at the Web Developer wiki page and give us feedback?
- Progress: Finished with updating the Web Developer wiki page and awaiting feedback from PMs
- Blockers: none
- Availability: Will update based on feedback from PMs
- ETA: Will update based on feedback from PMs
@Providence-o @ExperimentsInHonesty Can you please take a look at the Web Developer wiki page and give us feedback?
Notes:
- [x] Under 'progress through issues' bullet point, all the size issues listed should be itemized (with bullet points)
- [x] The 'Getting started' section should show the exact steps they need to take to join the team
- [ ] The wiki page should provide an overview of the devs lifecycle: from creating a good first issue to becoming a lead
Progress: Have started second draft of page but not done with editing it yet Blockers: none Availability: Not sure ETA: Sat, Mar 26, 2022
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, March 29, 2022 at 12:20 AM PST.
Progress: Have started second draft of page but not done with editing it yet Blockers: none Availability: Not sure ETA: Tue, Apr 26, 2022
To ask PM about Web Developer wiki page:
- [x] I wanted to include a link to Software Lifecycle Diagram. Did this get moved? I don't have access.
- [ ] Question about:
The wiki page should provide an overview of the devs lifecycle: from creating a good first issue to becoming a lead
Does a link to Being a Part of the Hack for LA Team suffice? Or did you want us to edit the Being a Part of the Hack for LA Team wiki to be more specific, such as including checklists within that wiki page?
Brainstorming maybe including something like the following in Being a Part of the Hack for LA Team wiki page
Junior Developers Junior developers should aim for completing the following at a minimum before moving onto another team.
- [ ] Pre-work developer checklist
- [ ] Self-assign and complete
- [ ] 1 good first issue
- [ ] 1 good second issue
- [ ] 1 small complexity issue
- [ ] 1 medium complexity issue
- [ ] 1 large complexity issue or another medium complexity issue
- [ ] Review at least 10 prs. General rule: For every pr you open/create, you review at least 2 prs. Aim for:
- [ ] Review 2 good first issue prs
- [ ] Review 2 good second issue prs
- [ ] Review 2 small complexity prs
- [ ] Review 2 medium complexity prs
- [ ] Review 2 large complexity prs or 2 more medium complexity prs
To Become a Lead Everything a junior developer does and the following:
- [ ] Lead Sunday demos: pr reviews, issue creation, progress updates
- [ ] Create issues as they come up - How to create Github issues
- [ ] Answer questions and help other devs with their blockers
- [ ] Volunteer to be a notetaker during meetings
@SAUMILDHANKAR I'm done editing the Web Developer wiki page for now. I tried implementing the requests in this https://github.com/hackforla/website/issues/2746#issuecomment-1046104161 while keeping in mind the conversations about the wiki we had during previous meetings, such as making the page shorter and dividing the contents of the page into different pages where possible.
Please make any further edits as you see fit.
@SAUMILDHANKAR I'm done editing the Web Developer wiki page for now. I tried implementing the requests in this #2746 (comment) while keeping in mind the conversations about the wiki we had during previous meetings, such as making the page shorter and dividing the contents of the page into different pages where possible.
Please make any further edits as you see fit.
@JessicaLucindaCheng Thanks for editing the wiki page. Just finished my edits as well. Will add it to our tech leads agenda for further discussion. Thanks.
Notes from PM:
- [ ] (Saumil) Remove duplicate steps in the getting started section in the wiki page that is already in the pre-work.
- [ ] (Saumil) In regards to the devs' lifecycle requested by PM, we will edit the how to Being a part of the hack for la team wiki page.
- [ ] Ask other developers what they want on the how to Being a part of the hack for la team wiki page or what changes do they want during the team meetings.
- [ ] (Jessica) Move resources to resources list wiki
- [ ] The resources section should have links to the resources wiki page's section for all members and for developers specifically.
- [ ] (Jessica) I wanted to include a link to Software Lifecycle Diagram. Did this get moved? I don't have access.--> Ans: It doesn't exist anymore so remove link.
- [ ] (Jessica) Move information that applies to all members to join us wiki page or a new wiki page
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, April 19, 2022 at 12:20 AM PST.
- Progress: 80% done. Need to remove anything that is repeated in the Getting Started section that is already in the pre-work. Also, need to move resources to a different Wiki page and link back to Web Developer page.
- Blockers: None
- Availability: Not sure
- ETA: Hopefully, Saturday, April 30, 2022
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, May 3, 2022 at 12:20 AM PST.
Progress: 80% done. Need to remove anything that is repeated in the Getting Started section that is already in the pre-work. Also, need to move resources to a different Wiki page and link back to Web Developer page. Blockers: None Availability: Not sure ETA: Hopefully, Saturday, May 14, 2021
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, May 17, 2022 at 12:21 AM PST.
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, May 24, 2022 at 12:21 AM PST.
- Progress: 75% done. Still needs to be done:
- [ ] Remove anything that is repeated in the Getting Started section that is already in the pre-work.
- [ ] Move resources to a different Wiki page and link back to Web Developer page.
- [ ] See if anything in About the Website Development Team is duplicated elsewhere and can be removed, not needed, or should be placed somewhere else.
- Blockers: None
- Availability: Not sure
- ETA: Ongoing
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures: "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, June 7, 2022 at 12:21 AM PST.
- Progress: 75% done. Still needs to be done:
- [ ] Remove anything that is repeated in the Getting Started section that is already in the pre-work.
- [ ] Move resources to a different Wiki page and link back to Web Developer page.
- [ ] See if anything in About the Website Development Team is duplicated elsewhere and can be removed, not needed, or should be placed somewhere else.
- Blockers: None
- Availability: Not sure
- ETA: Ongoing
@SAUMILDHANKAR, @JessicaLucindaCheng
Please add update using the below template (even if you have a pull request). Afterwards, remove the 'To Update !' label and add the 'Status: Updated' label.
- Progress: "What is the current status of your project? What have you completed and what is left to do?"
- Blockers: "Difficulties or errors encountered."
- Availability: "How much time will you have this week to work on this issue?"
- ETA: "When do you expect this issue to be completed?"
- Pictures (optional): "Add any pictures of the visual changes made to the site so far."
If you need help, be sure to either: 1) place your issue in the developer meeting discussion column and ask for help at your next meeting, 2) put a "Status: Help Wanted" label on your issue and pull request, or 3) put up a request for assistance on the #hfla-site channel.
You are receiving this comment because your last comment was before Tuesday, June 21, 2022 at 12:20 AM PST.
- Progress: 75% done. Still needs to be done:
- [ ] Remove anything that is repeated in the Getting Started section that is already in the pre-work.
- [ ] Move resources to a different Wiki page and link back to Web Developer page.
- [ ] See if anything in About the Website Development Team is duplicated elsewhere and can be removed, not needed, or should be placed somewhere else.
- Blockers: None
- Availability: Not sure
- ETA: Get as much done by Sat, July 9, 2022, but not sure if I will complete everything and have sign off by PM