Skip to content

Commit

Permalink
Initial code commit
Browse files Browse the repository at this point in the history
- uses an alpine image with a recent python version.
- uses cache mounts to increate rebuild speed and reduce image size.
- uses poetry to manage dependencies.
- gha generates project documentation on code push.
- LICENSE and README file are being imported into the docs.
- gha builds and uploads docker images on code push.
- uses multiplatform builds to support regular PCs (amd64) as well
  as those with Apple silicon (arm64).
  • Loading branch information
fyliu committed Nov 16, 2023
1 parent c8b8227 commit e5b2f78
Show file tree
Hide file tree
Showing 41 changed files with 2,508 additions and 136 deletions.
17 changes: 17 additions & 0 deletions .dockerignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
__pycache__/
*.py[cod]
docs
scripts
.git
.gitignore
.dockerignore
Dockerfile
docker-compose.yml
pyproject.toml
poetry.lock
mkdocs.yml
README.md
*.swp
temp_dir
LICENSE
.github
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ about: Simple action that will make it possible to add project to hackforla.org
title: ''
labels: enhancement
assignees: ''

---

### Overview

By adding the project's logo/image to your project's primary repository, we will be able to dynamically deliver up to date information about your project to the hackforla.org website. Also when people add the link to the repository in LinkedIn or Slack, or other social media it will automatically use the image as well as the description, improving the link's chances of getting clicked on.

### Action Items

Add project's logo/image to your primary Github repository using the instructions below. You should use the same image as is on the hackforla.org website, or if another image is desired, please replace both with the same image.

### Resources/Instructions

Tip: Your image should be a PNG, JPG, or GIF file under 1 MB in size. For the best quality rendering, we recommend keeping the image at 640 by 320 pixels.
Read Github's [Customizing your repository's social media preview](https://help.github.com/en/articles/customizing-your-repositorys-social-media-preview)
4 changes: 3 additions & 1 deletion .github/ISSUE_TEMPLATE/blank-issue.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ about: Consistent formatting make Issues concise and easy to navigate
title: ''
labels: ''
assignees: ''

---

### Overview

REPLACE THIS TEXT -Text here that clearly states the purpose of this issue in 2 sentences or less.

### Action Items

REPLACE THIS TEXT -If this is the beginning of the task this is most likely something to be researched and documented.

REPLACE THIS TEXT -If the issue has already been researched, and the course of action is clear, this will describe the steps. However, if the steps can be divided into tasks for more than one person, we recommend dividing it up into separate issues, or assigning it as a pair programming task.

### Resources/Instructions

REPLACE THIS TEXT -If there is a website which has documentation that helps with this issue provide the link(s) here.
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ about: Add Open Graph Markup tags to header
title: Control what appears when you paste your sites link in social media sites
labels: enhancement, question
assignees: ''

---

### Overview

When your website is shared on slack, facebook, twitter, etc. It should automatically display with an image and title instead of just the URL.

### Action items

Identify what to put in the following fields:
og:url
g:type
Expand All @@ -24,4 +25,5 @@ using the standards set forth in the instructions.
Add content to header and test with the tool provided in the instructions.

### Instructions

[A Guide to Sharing for Webmasters](https://developers.facebook.com/docs/sharing/webmasters#markup)
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/create-agenda.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,14 @@ about: Assign issue to all team members day after meetup in prep for next meetup
title: ''
labels: documentation, help wanted, question
assignees: ''

---

### Overview

This issue tracks the agenda for our weekly meetings

#### Issue Template

```
## [Date ] Meeting Agenda
Expand Down Expand Up @@ -39,7 +40,8 @@ This issue tracks the agenda for our weekly meetings
### Task Items
```

### Links to other agenda issues for your team
### Links to other agenda issues for your team

(so that you can easily post on their agendas items that come up at yours)

### Previous Meetings (link to each comment with the date)
34 changes: 18 additions & 16 deletions .github/ISSUE_TEMPLATE/create-project-card-for--project-name-.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,32 @@
---
name: Create project card for [project name]
name: Create project card for \[project name\]
about: Gather information to add this project to HackforLA's website
title: ''
labels: documentation, good first issue, question
assignees: ''

---

### Overview

Provide collateral for the HackforLA website

### Action Items
- [ ] Gather items
- [ ] 600 x 400 image
- [ ] Alt image text
- [ ] 1500 x 700 hero image (please do not put project title on hero image)
- [ ] Alt image text
- [ ] Name of project
- [ ] A blurb about your project
- [ ] Links (github, slack channel url, Testing Site, Live Site, etc.)
- [ ] Any resources for a Getting Started link (a link to a wiki, readme(s) or both)
- [ ] What you are looking for skills wise
- [ ] Partner(s)
- [ ] Location
- [ ] Status
- [ ] Add project Card to website

- [ ] Gather items
- [ ] 600 x 400 image
- [ ] Alt image text
- [ ] 1500 x 700 hero image (please do not put project title on hero image)
- [ ] Alt image text
- [ ] Name of project
- [ ] A blurb about your project
- [ ] Links (github, slack channel url, Testing Site, Live Site, etc.)
- [ ] Any resources for a Getting Started link (a link to a wiki, readme(s) or both)
- [ ] What you are looking for skills wise
- [ ] Partner(s)
- [ ] Location
- [ ] Status
- [ ] Add project Card to website

### Resources/Instructions

See project cards on the hackforla.org website for examples
3 changes: 0 additions & 3 deletions .github/ISSUE_TEMPLATE/custom.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,4 @@ about: Describe this issue template's purpose here.
title: ''
labels: ''
assignees: ''

---


29 changes: 15 additions & 14 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,29 +4,30 @@ about: Suggest an idea for this project
title: 'Feature Suggestion: '
labels: documentation, product
assignees: ''

---

### Overview
Please write a user story for this feature suggestion in the following format: As a ______, I want to do X for Y reason and replace this text with it.

Please write a user story for this feature suggestion in the following format: As a \_\_\_\_\_\_, I want to do X for Y reason and replace this text with it.

### Action Items

- [ ] Define your Feature Suggestion
- [ ] What is the feature you are suggesting?
- [ ] Is this feature urgent
- [ ] if so why?
- [ ] How long do you expect it take to implement this issue?
- [ ] Who is needed to implement this feature (Could you implement it yourself?)
- [ ] Design
- [ ] Front End
- [ ] Back End
- [ ] Database
- [ ] What problem does this feature solve?
- [ ] What technologies are needed for this feature?
- [ ] What is the feature you are suggesting?
- [ ] Is this feature urgent
- [ ] if so why?
- [ ] How long do you expect it take to implement this issue?
- [ ] Who is needed to implement this feature (Could you implement it yourself?)
- [ ] Design
- [ ] Front End
- [ ] Back End
- [ ] Database
- [ ] What problem does this feature solve?
- [ ] What technologies are needed for this feature?

### Resources/Instructions
If there is a website which has documentation that helps with this issue provide the link(s) here:

If there is a website which has documentation that helps with this issue provide the link(s) here:

**Additional context**
Add any other context or screenshots about the feature request here.
12 changes: 8 additions & 4 deletions .github/ISSUE_TEMPLATE/lighthouse--accessibility---forms.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,24 @@
---

name: 'Lighthouse: Accessibility - Forms'
about: Instructions for creating or improving forms to make them accessible when visitors
use screen readers AKA Form <input> elements must have labels
use screen readers AKA Form <input> elements must have labels
title: 'Lighthouse: Accessibility - Forms'
labels: ''
assignees: ''

---

### Overview

In order for your sites form(s) to be usable by visitors using screen readers all the form <input> elements need labels. There are specific details and exceptions, which can be found in the instructions below.

### Action Items
### Action Items

*If your site already has forms* review the instructions and document the changes needed to bring your form(s) into WCAG compliance, by commenting on this issue.
*If your site does not have forms* review the instructions and design new forms using the WCAG standards.
*If your site does not have forms* review the instructions and design new forms using the WCAG standards.

### Instructions
Deque University

Deque University
https://dequeuniversity.com/rules/axe/3.2/label
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/lighthouse--accessibility---links.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ about: AKA Links must have discernible text
title: 'Lighthouse: Accessibility - Links'
labels: ''
assignees: ''

---

### Overview

The formatting of links can make them readable or unreadable by screen readers. Which includes creating programmatic events for links without making them device specific (e.g., onfocus() instead of onmouseover(), etc.), and other ways of making sure all links are visible by screen readers.

### Action Items

*If your site already has links* review the instructions and document the changes needed to bring your link(s) into WCAG compliance, by commenting on this issue.
*If your site does not have links yet* review the instructions and design all new links using the WCAG standards.
*If your site does not have links yet* review the instructions and design all new links using the WCAG standards.

### Instructions

Deque University
https://dequeuniversity.com/rules/axe/3.2/link-name
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ about: Instructions for addressing the cross-origin linking vulnerabilities
title: 'Lighthouse Issue: Cross-origin destinations are unsafe'
labels: ''
assignees: ''

---

### Overview
Links to cross-origin destinations are unsafe both from a security and performance perspective.

Links to cross-origin destinations are unsafe both from a security and performance perspective.

### Action Item
Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in [cross-origin destinations are unsafe]
(https://developers.google.com/web/tools/lighthouse/audits/noopener) .

Run [Lighthouse](https://developers.google.com/web/tools/lighthouse/) and then follow the instructions in \[cross-origin destinations are unsafe\]
(https://developers.google.com/web/tools/lighthouse/audits/noopener) .

## Summary of instructions
When using *target=_blank* also adding *rel="noopener"* to the tag ensures that new page runs in a separate process.

When using *target=\_blank* also adding *rel="noopener"* to the tag ensures that new page runs in a separate process.
14 changes: 8 additions & 6 deletions .github/ISSUE_TEMPLATE/lighthouse--how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,26 @@ about: Provides overview of how to use Lighthouse and links to additional resour
title: 'Lighthouse: How To'
labels: ''
assignees: ''

---

### Overview

Lighthouse is an open-source, automated tool for improving the quality of web pages. You can run it against any web page, public or requiring authentication. It has audits for performance, accessibility, progressive web apps, and more. Hack For LA recommends that you run the tests and evaluate what changes you might want to make on your website to improve performance and accessability.

### How To Use

Lighthouse is in the Audits panel of the Chrome DevTools. To run a report:

1. Download Google Chrome for Desktop.
2. In Google Chrome, go to the URL you want to audit. You can audit any URL on the web.
3. Open Chrome DevTools.
4. Click the Audits tab.
5. Click Perform an audit. DevTools shows you a list of audit categories. Leave them all enabled.
6. Click Run audit. After 60 to 90 seconds, Lighthouse gives you a report on the page.
1. In Google Chrome, go to the URL you want to audit. You can audit any URL on the web.
1. Open Chrome DevTools.
1. Click the Audits tab.
1. Click Perform an audit. DevTools shows you a list of audit categories. Leave them all enabled.
1. Click Run audit. After 60 to 90 seconds, Lighthouse gives you a report on the page.

For more information go to :
https://developers.google.com/web/tools/lighthouse/

### Tip

You will want to re-run lighthouse on any code changes before integrating them into your site. Sometimes the specific suggestions it makes, do not actually result in improved performance or can actually harm performance.
6 changes: 4 additions & 2 deletions .github/ISSUE_TEMPLATE/lighthouse--image-optimization.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,17 @@ about: Instructions for optimizing images
title: 'Lighthouse: Image Optimization'
labels: ''
assignees: ''

---

### Overview

When you run the lighthouse review it may suggest some specific image optimizations such as choosing another image format and making those changes may or may not improve your sites actual performance.

### Action Items
Run lighthouse on a local version of the website and then apply suggested changes and retest locally before determining if you want to keep the changes.

Run lighthouse on a local version of the website and then apply suggested changes and retest locally before determining if you want to keep the changes.

### Instructions/Resources

Google's Tools for Web Developers: [Optimize Images](https://developers.google.com/web/tools/lighthouse/audits/optimize-images)
Read [closed issue #111](https://github.com/hackforla/website/issues/111) from when HackforLA.org did our audit, to see why we decided not to do the image optimization
10 changes: 8 additions & 2 deletions .github/ISSUE_TEMPLATE/onboard---offboard--product.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,18 @@ about: Use this issue to create an onboarding/offboarding issue 1 time.
title: 'Onboard & Offboard: Product'
labels: ''
assignees: ''

---

### Overview

We need to have a checklist of items to do when a product manager onboard and offboards so that the process can be consistent and fast.

### Date Updated

(insert date you created this issue and keep updating the date each time the org template change are integrated)

### Action Items

- [ ] Check to see if the org template for this process has new steps in it, and if it does, update this issue and its template with content and add the last date you updated the template below
- [ ] Copy template to comment below
- [ ] Add name of person
Expand Down Expand Up @@ -64,6 +66,7 @@ We need to have a checklist of items to do when a product manager onboard and of
- [ ] use zoom spreadsheet, vault and accounts
- [ ] calendar invite
```

```
#### Offboard
- [ ] Remove from Google calendar invite
Expand Down Expand Up @@ -96,6 +99,7 @@ We need to have a checklist of items to do when a product manager onboard and of
```

### Resources/Instructions

- [1password.com](https://1password.com/)
- [REPLACE with Google Drive Link]
- [REPLACE with Team Roster]
Expand All @@ -111,7 +115,9 @@ We need to have a checklist of items to do when a product manager onboard and of
- [Replace with name of your project Figma]
- Shortcut for adding a profile to the desktop: chrome://settings/manageProfile
- Tutorials
- [Forward emails to team members](https://github.com/hackforla/product-management/wiki/Forward-emails-to-team-members)
- [Forward emails to team members](https://github.com/hackforla/product-management/wiki/Forward-emails-to-team-members)

---

[org template](https://raw.githubusercontent.com/hackforla/.github/main/.github/ISSUE_TEMPLATE/onboard---offboard--product.md) updated 2022-02-23
[Changelog](https://github.com/hackforla/product-management/wiki/Onboard-Offboard-Changelog)
Loading

0 comments on commit e5b2f78

Please sign in to comment.