Skip to content

Create documentation for projects-check page #3487

@blulady

Description

@blulady

Dependency

Overview

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

Details

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 internally by product teams and others, for example:

      • 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
      • This should be added as an example in the Wiki:
      E.g., currently 12 projects are using 'Dockerfile', but only 6 have 'Docker' listed under technologies. One of the projects has 'Docker' listed in technologies but because they don't have a 'Dockerfile', it does not show up on the 'Dockerfile' results:
      https://www.hackforla.org/projects-check/?languages=Dockerfile
      https://www.hackforla.org/projects-check/?technologies=Docker
      
    • 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: Review project data to determine reclassifying requirements for their Technologies and Tools. #4262

Resources/Instructions

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    Status

    Done

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions