Add resources page

Author: mrysav

docs/index.md

@@ -4,3 +4,12 @@ icon: lucide/earth
 
 # Home
 
+**Welcome to the Computing For Good course resource site!**
+
+You are most likely here because you are enrolled in [CS 6150: Computing for Good](https://omscs.gatech.edu/cs-6150-computing-good) at Georgia Tech. Welcome!
+
+This site is a repository of resources for the course that exists outside of the LMS. We want to put things here that belong on a public-facing website: things like documentation, helpful guides, and project webpages.
+
+If you are new here, you can check out our [Resources](resources.md) page. You may also want to checkout the [Markdown](markdown.md) explainer if you need a refresher.
+
+There is not much here right now. Feel free to click the "Edit this page" link in the top right and submit a pull request on GitHub to improve it!

docs/resources.md

@@ -0,0 +1,166 @@
+---
+icon: lucide/book
+---
+
+## Accessibility
+
+Lainey Feingold, Attorney: https://www.lflegal.com/
+
+Lainey advocates an innovative approach to advocacy for persons with a disability called "Structured Negotiation." They have advocated on behalf of persons with a disability since 1995, including work in the technology sector.
+
+## Dean of Students (deadline exceptions, etc.)
+
+If you have a personal emergency requiring academic accommodation (late assignment, etc.), please work through the [Dean of Students](https://studentlife.gatech.edu/request-assistance) office, explaining your unique situation. This will initiate a conversation between us through which we aim to achieve a solution that is fair to all students and maintains the academic integrity of Georgia Tech.
+
+## Documentation: User and Developer
+
+* [Mermaid.js Diagramming Tool](https://mermaid.js.org/)
+
+## Mobile apps (Android, iOS)
+
+If you're considering a mobile app as the core of your deliverable, consider a Progressive Web Application (PWA). PWA resources are below. There are pros and cons, and neither is the answer in all use cases, as shown below. A PWA is often a better option for a one-semester class like ours since implementing desktop and mobile functionality is expedited. Additionally, a PWA promotes equity due to its reduced file size and resultant performance advantage in limited bandwidth scenarios. Here's a summary:
+
+Pros: one code base for all major platforms (Android, iOS, Windows, Linux, etc.); almost native-level performance.
+Cons: slightly less than native-level performance when downloaded to any given platform. Generally, larger-sized codebase.
+
+If the decision is a native mobile app, and you have familiarity with the Dart language, we recommend the [Flutter framework](https://flutter.dev/), which allows for a multi-platform, single codebase. This reduces coding time compared to coding multiple native versions.
+
+* [PWA vs. Flutter; the debate rages on](https://cubettech.com/resources/blog/flutter-vs-pwa-which-is-better-for-mobile-app-development/#:~:text=Flutter%20apps%20have%20profound%20access,flutter%20complex%20apps%20work%20effortlessly.)
+
+## Nonprofit status, confirming.
+
+For many free services, such as hosting, you must obtain a copy of the IRS determination letter:
+
+irs.gov search:
+
+1. [enter organization name here](https://apps.irs.gov/app/eos/) 
+1. click organization name (if the determination letter link is not present, please request the letter directly from the partner). 
+
+For the nonprofit to be approved by most hosting companies, the partner must have filed a 990 tax return within the last three years; this results in a valid determination letter.
+
+## Previous Projects (publicly available)
+
+* [C4G BLIS Website](http://blis.cc.gatech.edu/)
+* [C4G BLIS GitHub repository](https://github.com/C4G/BLIS)
+* [CDC Milestone Tracker App](https://www.cdc.gov/ncbddd/actearly/milestones-app.html)
+* [LifeNet](http://lifenet.wiki/) (The GitHub repo is accessible via the "Download" button)
+
+## Progressive Web Applications (PWAs)
+
+* NOTE: If you are using next.js, the next-pwa module expedites PWA creation
+
+* [Push notifications for PWAs explained ](https://www.pushpro.com/blog/pwa-push-notifications-for-progressive-web-apps)
+* [Apple and the status of web push](https://onesignal.com/blog/apples-plans-to-support-ios-web-push-in-2021/)
+Links to an external site.
+* [PWAs with notifications and push](https://developer.mozilla.org/en-US/docs/Web/Progressive_web_apps/Re-engageable_Notifications_Push)
+
+* Installation
+    * Note: it may take up to 20 seconds to receive a notification on Android 
+    * iOS (iPhone 7 Plus):
+        - email the link to yourself
+        - access your email on your phone and touch the link
+        - touch the share icon (rectangle with an up arrow)
+        - scroll down the list at the bottom of the screen
+        - touch "Add to Home Screen."
+        - touch Add to confirm
+        - icon is added to the home screen
+    * Android (Galaxy S7 Edge):
+        - email the link to yourself
+        - access your email on your phone and touch the link
+        - see the notification at the bottom of the screen
+        - touch "add <app name> to Home screen"
+        - touch "Install"
+        - will receive confirmation of the app's installation
+
+## Project development workflow
+
+As you add code to your project, it is recommended that you consider the workflow listed below to avoid problems. This should be done from the beginning, i.e., when you first upload an initial 'placeholder' page as your home page:
+
+  * Add component code, e.g., authentication.
+
+  * Add developer documentation. By keeping up as you go along, you can easily make minor changes at the end of the semester.
+
+  * Test: Lighthouse, Chrome dev tools (emulators for portrait and landscape for iOS and Android). NOTE: When actively developing with a properly functioning CI/CD pipeline, it is anticipated that the above workflow will happen 2-10x/day or even more. By adhering to the above process, you will avoid problems associated with the last-minute creation of the developer documentation. Additionally, by incorporating the Lighthouse/emulator tests into each component cycle, you can prevent issues that are difficult to correct.
+
+## Projects-HIPAA
+
+  * For the projects where students will potentially have access to private health information while working with a medical department, they must complete some mandatory HIPAA and CITI training modules before they will be granted access to the corresponding work areas and internal computer network.
+  * Corresponding institutions will share the steps to complete these trainings.
+
+## Projects-Research
+
+  * When conducting biomedical research, there is a group called Institutional Review Board (IRB) which reviews, monitors the research. You can learn more about it on [IRB FAQs](https://www.fda.gov/regulatory-information/search-fda-guidance-documents/institutional-review-boards-frequently-asked-questions).
+
+## Sites - General
+
+* CDC pandemic statistics, etc. - [COVID Update](https://covid.cdc.gov/covid-data-tracker/#datatracker-home)
+* Cloud datasets, environment-focused - https://planetarycomputer.microsoft.com Links to an external site.
+* UX/Site Architecture - https://www.nngroup.com/topic/information-architecture/
+
+## Software Testing
+
+* [Lighthouse Web Metrics](https://developer.chrome.com/docs/lighthouse/overview)
+
+* [Selenium](https://selenium.dev/)
+ 
+## UI/UX
+
+  * [Heuristics](https://www.nngroup.com/articles/ten-usability-heuristics/)
+
+## Video
+
+  * Documentary on homelessness (requires Netflix): [Lead Me Home](https://www.leadmehomefilm.com/) (2021, 40 min)
+
+## Web Hosting Options
+
+**NOTE:** We offer this information without endorsement. Feel free to use this information as a starting point for searching for appropriate services; please ensure that your chosen service has the needed features.
+
+_Free for Georgia Tech Students:_ [OIT Web Hosting](https://next.hosting.gatech.edu/about/plesk-hosting)
+
+_Free plan for everyone:_ NO CREDIT CARD REQUIRED: [Vercel](https://vercel.com/)
+
+_Free for students:_ [Azure](https://azure.microsoft.com/en-us/free/students/), [Heroku](https://www.heroku.com/), [PythonAnywhere](https://www.pythonanywhere.com/)
+
+_Free for nonprofits_ (updated 4/28/2022):
+
+* [Microsoft cloud for nonprofits](https://docs.microsoft.com/en-us/industry/nonprofit/)
+    * [Renewal](https://docs.microsoft.com/en-us/industry/nonprofit/renew) (please ensure the partner organization has this information for sustainability)
+
+* [Dreamhost.com](https://dreamhost.com) (credit card required for verification, NOT FOR BILLING). Free hosting [requires an IRS determination letter](https://help.dreamhost.com/hc/en-us/articles/215769478): [Search for IRS Determination Letter](https://apps.irs.gov/app/eos/)
+    * NOTE:
+        * Please do not create a custom domain or subdomain for your project; just accept the name given. Otherwise a charge may be incurred.
+        * If you see an invoice generated in the signup process, please do not let that concern you. They do not ask for a credit card. Please continue to the next screen where you can complete a support request; during that process, you will upload the IRS determination letter as an attachment.
+    * Linux
+    * One (1) domain
+    * Five (5) subdomains
+    * 50GB storage
+    * 6 FTP/SFTP/Shell users
+    * 6 MySQL databases (free)
+
+* [MongoDB](https://www.mongodb.com/pricing): free database hosting
+* [Replit](https://replit.com/): free Web hosting
+
+[Article on free database hosting plans](https://www.lastweekinaws.com/blog/10-free-cloud-databases-you-should-consider-and-1-you-shouldnt/)
+
+## Dante's opinions - the best hosting options for the C4G course:
+
+| | Traditional Cloud (Azure, AWS, Google, etc.) | DreamHost/Vercel | Both |
+|-|-|-|-|
+|**Pros**|<ul><li>One location for hosting</li></ul>| <ul><li>No credit card is required</li><li>No accidental charges</li><li>Lighthouse/mobile performance achieved quickly and easily</li><li>Requires only a development team</li><li>Does not require constant monitoring of charges (or notifications)</li></ul>|Free|
+|**Cons**|<ul><li>Credit card is required</li><li>Possible inadvertent charges</li><li>Lighthouse/mobile performance: more challenging to achieve</li><li>Requires a cloud architect or person with cloud knowledge on staff for the partner organization</li><li>Requires constant monitoring of charges (or notifications)</li></ul>|<ul><li>Two locations for hosting (DreamHost for the database; Vercel for frontend and some backend services)</li></ul>||
+
+## Writing
+
+If you are new to conference-style papers, please feel free to use the template on [this page](https://www.acm.org/publications/proceedings-template) under 'Word authors': Interim layout.docx. The template does not show inline citing, which is done like this: [2]. The number in square brackets references the resource in your REFERENCES section. You are welcome to format the paper into two columns. In MS Word: Layout > Columns. However, you are not required to do so. If you use the 2-column format, you may use the template's 9-point font. If you are new to the components of graduate-quality writing, please research the many resources available online.
+
+[Free Overleaf subscription as a GT student](https://www.overleaf.com/login?) NOTE: This will significantly expedite your writing.
+
+[USNA sample writing guidelines](https://www.usna.edu/CS/Resources/rubrics.php) (we do not use these for grading; they are offered as a starting point only for those new to writing professional papers).
+
+[Sample paper](https://www.mycaretext.com/docs/YunArriaga.pdf)
+
+[Avoiding plagiarism course (Library resources)](https://www.library.gatech.edu/events/avoiding-plagiarism-and-citing-your-references-correctly-online-22)
+
+[Citations (1-minute video)](https://researchguides.uoregon.edu/citing-plagiarism/plagiarism)
+
+NOTE: Turnitin has been added to Georgia Tech's MS Word in Microsoft 365. Please open MS Word and start a blank doc; you'll see Turnitin in the ribbon (top menubar). 2/11/2023

zensical.toml

@@ -11,7 +11,7 @@
 # The site_name is shown in the page header and the browser window title
 #
 # Read more: https://zensical.org/docs/setup/basics/#site_name
-site_name = "Computing 4 Good Resources"
+site_name = "C4G Resources"
 
 # The site_description is included in the HTML head and should contain a
 # meaningful description of the site content for use by search engines.