CityOfLosAngeles / open-sdg-site-starter

A starting point for the site repository of an Open SDG platform implementation.
https://sdgdata.lamayor.org
MIT License
3 stars 3 forks source link

feat: update codebase to reflect the latest configuration in the parent open-sdg and open-sdg-site project #26

Closed jaylenw closed 3 months ago

jaylenw commented 6 months ago

What does this PR do?

Background info

vscode ➜ /workspaces/open-sdg-site-starter (ghi-25) $ ./scripts/test/html_proofer_staging.sh 
Running ["ScriptCheck", "LinkCheck", "ImageCheck"] on ["./_test"] on *.html... 

Ran on 561 files!

- ./_test/index.html
  *  internally linking to ../goals, which does not exist (line 257)
     <a href="../goals">goal</a>

HTML-Proofer found 1 failure!
vscode ➜ /workspaces/open-sdg-site-starter (ghi-25) $ ./scripts/test/html_proofer_prod.sh 
Running ["ScriptCheck", "LinkCheck", "ImageCheck"] on ["./_site"] on *.html... 

Ran on 561 files!

- ./_site/index.html
  *  internally linking to ../goals, which does not exist (line 257)
     <a href="../goals">goal</a>

HTML-Proofer found 1 failure!
vscode ➜ /workspaces/open-sdg-site-starter (ghi-25) $ 

SDG Data Portal accessible via localhost:9000 after following the README.md's instructions

sdg-data-site-local

Running Jekyll Server to serve built site locally

sdg-dev-local

sdg-site-loads-locally

*Note that not all of the data will load on the site as there is a CORS issue present. This should not exist with configuration in the cloud environment. site-data-not-loading-cors

How can this be tested (manually and/or automated test)?

Provide manual tests steps if applicable

The README.md mentions accessing the site locally in the browser by running the jekyll serve command. Refer to the instructions to be able to manually browse the site.

Provide steps for running automated tests if applicable

Please refer to the documentation in the README.md for testing locally.

Which issue(s) is/are related to this PR?

This PR is/are related to issue(s) #25

close #25

jaylenw commented 6 months ago

@naomiikd @kerrylacity , as part of the review process please verify the steps for running the site locally works for you.