Documentation for projects-check page

[blulady]

Dependency

• [x] #4427
• [x] #3636
• [x] #5677

Overview

We need to document for the dev and product teams how the https://www.hackforla.org/projects-check page works

Details

• This issue was created in response to this issue #2502, and the pr made it possible https://github.com/hackforla/website/pull/3452

Action Items

• [ ] Create documentation on the projects-check hidden page for the Wiki. That page will contain:
  • [ ] Info about all files used to build the page
  • [ ] How the page should be used
  • [ ] Screenshots showing the page being used
• [ ] The Wiki is still in the process of being updated, therefore see How to Contribute to the Wiki and "Creating a new wiki page"
• [ ] Add link to the instructions created to this issue: https://github.com/hackforla/website/issues/4262

Resources/Instructions

• https://www.hackforla.org/projects-check/
• https://github.com/hackforla/website/issues/2502
• https://github.com/hackforla/website/pull/3452
• This issue is part of an epic: #4434

[github-actions[bot]]

Hi @blulady.

Please don't forget to add the proper labels to this issue. Currently, the labels for the following are missing: Size, Role, Feature

NOTE: Please ignore the adding proper labels comment if you do not have 'write' access to this directory.

To add a label, take a look at Github's documentation here.

Also, don't forget to remove the "missing labels" afterwards. To remove a label, the process is similar to adding a label, but you select a currently added label to remove it.

After the proper labels are added, the merge team will review the issue and add a "Ready for Milestone" label once it is ready for prioritization.

Additional Resources:

• Wiki: How to create issues
• Wiki: How to read and interpret labels

[ExperimentsInHonesty]

• [x] Product team is going to add it to their monthly actives to check each this page to see if any of the language or technologies are not properly assigned and then reach out to projects

• [ ] Add the following example to the wiki file on how to use the project's-check page

E.g., currently 12 projects are using dockerfile, but only 6 have docker listed under technologies.  One of the projects has docker listed on technologies but because they don't have a docker file, it does not show up on the docker file results
https://www.hackforla.org/projects-check/?languages=Dockerfile
https://www.hackforla.org/projects-check/?technologies=Docker

[JessicaLucindaCheng]

This issue needs to be edited by a lead to reflect our migration to the website-wiki repo. For more info, read How to Contribute to the Wiki.

[t-will-gillis]

• Removing Dependency, adding Ready for Dev Lead, and moving to "New Issue Approval" due to merging of #4427

[ExperimentsInHonesty]

This issue can't be worked on yet, because the filters are not showing all the data. Will create an ER.

• ER created #5677

[github-actions[bot]]

Hi @mSharifHub, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[github-actions[bot]]

Hi @Limeload, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[Limeload]

i. Availability: 5pm-8pm CST from 7/1 - 7/5 ii. ETA: 7/5

[ExperimentsInHonesty]

@Limeload I have moved this issue to the in progress column. In the future when you assign yourself an issue, please move it there.

[HackforLABot]

Hi @irais-valenzuela, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:- i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?) ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[irais-valenzuela]

Availability: Thursday and Friday ETA: Next Week Friday

[HackforLABot]

@irais-valenzuela

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.

1. Progress: "What is the current status of your project? What have you completed and what is left to do?"
2. Blockers: "Difficulties or errors encountered."
3. Availability: "How much time will you have this week to work on this issue?"
4. ETA: "When do you expect this issue to be completed?"
5. 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 Questions/In Review column of the Project Board 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. Please note that including your questions in the issue comments- along with screenshots, if applicable- will help us to help you. Here and here are examples of well-formed questions.

_{You are receiving this comment because your last comment was before Tuesday, August 27, 2024 at 12:04 AM PST.}

[irais-valenzuela]

Availability: Apologies had a family emergency this week. Will work on this early next week. ETA: Next Week

[irais-valenzuela]

Progress: Went through dependencies to get familiarized with projects-check page. Started writing the documentation for first few items. Will continue next week. Availability: M-F ETA: Friday

[irais-valenzuela]

Hey @t-will-gillis, just wanted to clarify when the ticket says to write documentation on how to use the projects-check page—should this be more of a UI walkthrough (focused on interaction and user flow) or explaining the technical purpose and how the page supports testing filters? Thanks for your guidance!

[t-will-gillis]

Hey @irais-valenzuela Since this is for the internal "Projects-Check" page, my thought is that the focus should be geared towards explaining the technical purpose more so than UI

[ExperimentsInHonesty]

This issue needs a cleanup