Skip to content

How to Contribute to the Wiki

Mugdh Chauhan edited this page Nov 27, 2024 · 67 revisions

Instructions

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 wiki at this time.

Creating a new wiki page

  • If you are creating a new page, please draft the content of your wiki page in a new comment in your issue and then add a link to your comment in the Content to be added/edited in the new website-wiki repo section below, so we know to add or edit the content you wrote up to the new website-wiki repo.

Editing a wiki page

  • If you are editing an existing wiki page, please copy and paste the contents of the wiki page in a new comment in your issue. Then, in the comment you just created, you can edit the wiki page's content and then add a link to your comment in the Content to be added/edited in the new website-wiki repo section below, so we know to add or edit the content you wrote up to the new website-wiki repo.

Content to be added/edited in the new website-wiki repo

Page (title/link) New Location Additional Notes/Links
Testing updated issue templates
How to review GHA Pull Requests GHA wiki page's new section
About the website development team Revised to remove "good second issue"
Web Developer Revised to remove "good second issue"
Being a Part of the Hack for LA Dev Team Revised to remove "good second issue"
How to read and interpret labels Revised to remove "good second issue"
How to review Pull Requests Revised to remove "good second issue"
HFLA Google Apps Script Development/Review Process
DR: img tag Standardize HTML img tag PR
DR: Updating Hack for LA Website’s Device Width Breakpoints to Account for Fractional Widths
DR: New HFLA Code of Conduct
DR: Creating a reusable component for project pages with Problem, Solution, and Impact sections
DR: Feasibility of the custom "Share your WINS" form
DR: Update Step 0 of "How to Review Pull Requests"
DR: Investigate Use of GitHub Bundler for testing HfLA website locally
DR: VS Code Spell Checker Extension
DR: Create a wiki for milestone information
DR: Card with the Letter on About page has square edges
DR: Updated Program Areas so Projects are Linked to Project Pages - revised to remove "good second issue"
GHA: Adding Missing Labels to Issues
GHA: Ask for Preliminary Update
HFLA GitHub Actions
GHA: Issue Trigger
DR: Adding the "primary" and "secondary" labels to the header and footer navigation menus
HFLA: Accidentally creates an issue from a checkbox
project.md file template Revised to add instructions above title: Link to old Wiki page
Credits page details Revised to add instructions on how to write credits for composite images
DR: img tag with additional edits Pending: Permalinks need to be changed to code blocks in website-wiki
Feasibility and DR: use of CodeQL for VS Code
GHA: add update label weekly
WINS Apps Script Development Guide This doc includes a link to Testing Wins in a test repository and should replace the current page https://github.com/hackforla/website/wiki/Steps-for-developers-working-on-issues-related-to-wins-page
HfLA GitHub Actions
How to remove unwanted files during the Pull Request process
How to manage spell check warnings
DR: The "Hack for LA's GitHub Actions" Wiki guide needs additional explanation #6537 Updates an existing issue (4790) in the queue for updating this Wiki page
How to resolve CodeQL alerts
Create wiki page providing guidance how to test the WINS page
How to make SVGs and other images WCAG compliant Adds section Use an outer SVG with "aria-label" or "aria-labelledby"
GHA: "Schedule Monthly" and
"WR Schedule Monthly" workflow
Information regarding the "Schedule Monthly" and "WR Schedule Monthly" workflows
GHA: github data Revised the GHA wiki page github-data and added two new sections
GHA: "Update Label Directory" workflow Information regarding the "Update Label Directory" workflow
How to Customize the Fill Color of an SVG Icon
Maintaining GitHub secrets Would likely fit best on the GitHub Actions page
DR: Preventing Unintended GitHub Pages Deployment on Forked Repositories
How to work off of a feature branch In "Step 2: Update your branch with upstream changes", change git pull {NAME OF REMOTE} {FEATURE BRANCH NAME} to git pull upstream {FEATURE BRANCH NAME} in order to clarify the instructions.
Projects-Check Page Wiki Instructions for how to use the Projects-Check Page
Clone this wiki locally