meonkeys commented on code in PR #53: URL: https://github.com/apache/fineract-site/pull/53#discussion_r2843159203
########## README.md: ########## @@ -1,21 +1,43 @@ # fineract-site -This is the Apache Fineract Website served on https://fineract.apache.org - -See [CONTRIBUTING.md](CONTRIBUTING.md) for local run/test instructions before opening a PR. - -## wish list - -- [ ] clean up unused code/static assets (fonts, icons, images, etc) -- [ ] use a static site generator, don't hand-code HTML - - [ ] validate links, markup, css, etc. -- [ ] auto-deploy website with every PR using an ASF tool or GitHub actions (commits to the asf-site branch do currently trigger auto-deploys, but this isn't set up for PRs) -- [ ] automate deployment of generated versioned asciidoc (don't commit it to apache/fineract-site repo – this creates a 2nd source of truth) -- [ ] fix text overlap with intermediate-sized media query -- [ ] document how to test locally, before/while committing -- [ ] additional review/critique of work done in https://github.com/apache/fineract-site/pull/37 -- [x] improve [a11y](https://www.accessibilitychecker.org/audit/?website=https%3A%2F%2Ffineract.apache.org&flag=us) (accessibility) - current score of 57 out of 100, with 30 critical issues (as of 2026-02-11, only one issue remains) -- [x] fix [missing fonts and icons](https://github.com/apache/fineract-site/pull/38#issuecomment-2916819388) -- [x] [Cache google assets](https://github.com/apache/fineract-site/pull/37) -- [x] https://github.com/apache/fineract-site/pull/37 -- [x] [migrate this wish list from Fineract JIRA](https://issues.apache.org/jira/browse/FINERACT-2192) +Apache Fineract website source repository for https://fineract.apache.org. + +## Source Of Truth + +- Hugo source is in `site-src/`. +- Generated output is in `.build/site`. +- Static passthrough is mounted from: + - `docs/` -> `/docs/` + - `css/` -> `/css/` + - `js/` -> `/js/` + - `images/` -> `/images/` + - `font/` -> `/font/` + - `.htaccess` -> `/.htaccess` + - `doap_Fineract.rdf` -> `/doap_Fineract.rdf` + +Do not edit generated output directly. Edit files under `site-src/` and mounted static sources instead. + +## Local Commands + +- PowerShell build: `./scripts/site-build.ps1 --cleanDestinationDir` +- Bash build: `./scripts/site-build.sh --cleanDestinationDir` +- PowerShell serve: `./scripts/site-serve.ps1` +- Bash serve: `./scripts/site-serve.sh` +- Internal link check: `python ./scripts/check_internal_links.py --site-root .build/site` Review Comment: Probably also worth a mention that, since the container runs as root, something like `sudo chown -R "$(id -u):$(id -g)" .build site-src` will likely be necessary to clean up after building the site. Or we could make the container run as non-root, but that adds a bit of junk to the `Dockerfile`. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
