Continuous Development of Wiki for Site Architecture

[ye-susan]

Overview

Research and document HFLA's site architecture.

Action Items

• Create wiki page documenting existing site architecture
• Include screenshots
• Research and document any API we're using (separate wiki for endpoints, related to issue Scrape JSON file for UX relevant fields #270)
• Update documentation for any new features --i.e. master calendar

[ye-susan]

Update: new wiki page is up - Hack for LA's Site Architecture
Still need to expand on projects section, styling section, and add more details about the APIs we're using

[ye-susan]

Status: Updated Hack for LA's Site Architecture page, and added Guide to the Project Layout File
To Do:

• document JS scripts in project layout
• add more images
• add styling section

[ExperimentsInHonesty]

@ye-susan can you provide a little more status report

1. Progress (see Continuous Development of Wiki for Site Architecture #529 (comment))
2. Blocks
3. Availability
4. ETA

[ye-susan]

1. Progress: 80% finished with site architecture, just need styling section. Added a wiki for Project.html Layout file like the wiki we have for project.md files. Still need to add documentation for project-meetings.html for the calendar.
2. Blocks: I have some questions about the scripts used in project.html layout
3. Availability: free
4. ETA: 5/27

[ExperimentsInHonesty]

Adding @ampers-and to comments and questions review.

[ye-susan]

1. Progress: 100% finished with site architecture. Just starting on new wiki for API endpoints
2. Blocks: clarifying questions about our API endpoints and the JSON file that was mentioned in issue Scrape JSON file for UX relevant fields #270
3. Availability: Sun - Wed
4. ETA: 6/3

[ExperimentsInHonesty]

@ye-susan I tried to find details about how our redirect is structured:
https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture#redirect-files
but it didn't have information on how the redirect works. See #553 for some of that related info, and also feel free to talk to me about the redirects if there is anything that is unclear.

[ExperimentsInHonesty]

@ye-susan please move images from this issue to issue #525 so that we can keep all the images for the wiki in one place and keep it open while closing this issue when you are done. I think you can cut and paste the code that calls them direct from this issue and paste that code into 525, keeping you from having to change anything at the wiki end.

[ye-susan]

@ExperimentsInHonesty Thanks for the feedback, Bonnie. I've just edited the Redirect section to include a description of how the code is pulling from the markdown files. In the styling section, I also talk about how the sass layout folder is styling the redirect layout, as well as distinguishing between the two main.scss files.

All the images have been copied to issue 525.

[ExperimentsInHonesty]

Hi @ye-susan on this page: https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture#redirect-files please change
donate.md: links to donorbox.org
to
donate.md: links to https://www.codeforamerica.org/donate

[ye-susan]

Thanks Bonnie, I've change the link to the correct one

[harishlingam]

@ampers-and @jbubar Please review the documentation on this Wiki page: https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture

[ExperimentsInHonesty]

@jbubar re your comment last night, about how cool the site architecture is. Was this insight gained by reading the wiki, or by exploring the site?

[ExperimentsInHonesty]

@hannahlivnat @ethanh256 - Task for all new developers - Please review the documentation on this Wiki page: https://github.com/hackforla/website/wiki/Hack-for-LA's-Site-Architecture
and tell us if there are improvements that could further your understanding and the understanding of the people who come after you.

[ghost]

@ye-susan Just to double-check before I start working on the style section, do I click the "edit" button within the wiki page and get started in there, or should I be creating a draft in a different spot and submitting that draft to be added to the wiki page?

[ye-susan]

@hannahlivnat I don't think there's a draft option unfortunately, so I just edit offline in VS code and paste it straight onto the wiki when I'm finished

[eb46]

@ye-susan great job putting this all together! I like how detailed the folder descriptions are, specifically the Includes folder. I don't have anything to add at the moment but I'm sure I'll get some ideas once I start using it.

[ghost]

@ExperimentsInHonesty @ye-susan During our Tuesday night meeting, we talked about adding a section to the style page of the wiki that detailed where different sass components/variables /etc. could be found. I was reading through the style section, and it seems like Susan has already written this out pretty well. Screenshot included below. Do we want to go more in-depth than this within the wiki?

[ghost]

@ye-susan just read through the new guide page section that you posted. Very clear and easy to understand, particularly with the visuals. I think it looks great!

[jbubar]

@ExperimentsInHonesty @ye-susan @alexandrastubbs
I am really impressed with the site architecture page! It is definitely one of the most important pages on the wiki. I really appreciate all of the educational links. I learned a lot form it. My one thought is that this page is not easily accessed through the wiki. I found it on the readme pretty easily but it was buried pretty deep in the webdev page on the wiki. not sure if this is on purpose

Other thoughts about other wiki pages:

Introduction to the project page

• I don't feel too strongly about this, but here is my thought. We don't need to talk about the redesign… I don't know if anyone remembers the old site design
  Joining the Hfla website team page
• Product owner link (step 5) does not work
• Harish is no longer the PM
• What is this? "*6. Review [INSERT SLIDE DECK or VIDEO THAT SHOWS HOW WE USE THE PROJECT BOARDS IN GITHUB TO MANAGE WORKFLOW]. *This step is under development."

Template of a project.md file page

• Needs to be updated with the changes to looking for

[alexandrastubbs]

1. @alexandrastubbs and @ExperimentsInHonesty will review what needs to be on the product owner link. Update PM as well. Make an issue for # 6 on introduction page.

2. @jbubar will make a link in the resources page to the site architecture wiki.

3. @ethanh256 update looking for in the template of a project.md file.

[jbubar]

added site architecture link to the resources page in the wiki under web developer