{"id":28059781,"url":"https://github.com/princeton-cdh/princeton-cdh.github.io","last_synced_at":"2026-01-22T13:49:53.967Z","repository":{"id":37495224,"uuid":"279652669","full_name":"Princeton-CDH/princeton-cdh.github.io","owner":"Princeton-CDH","description":"Hugo site with automated scripts for data collection and reporting on CDH Research Software Team activity","archived":false,"fork":false,"pushed_at":"2025-01-11T02:38:23.000Z","size":92264,"stargazers_count":0,"open_issues_count":5,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-05-12T08:11:14.557Z","etag":null,"topics":["docsy","hugo-site","iteration-reports"],"latest_commit_sha":null,"homepage":"https://princeton-cdh.github.io/","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Princeton-CDH.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-07-14T17:38:04.000Z","updated_at":"2025-01-11T02:38:26.000Z","dependencies_parsed_at":"2024-08-10T03:27:38.055Z","dependency_job_id":"6af5f0c8-5ef7-43fa-84e5-9f4e6c337ee9","html_url":"https://github.com/Princeton-CDH/princeton-cdh.github.io","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Princeton-CDH/princeton-cdh.github.io","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princeton-CDH%2Fprinceton-cdh.github.io","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princeton-CDH%2Fprinceton-cdh.github.io/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princeton-CDH%2Fprinceton-cdh.github.io/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princeton-CDH%2Fprinceton-cdh.github.io/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Princeton-CDH","download_url":"https://codeload.github.com/Princeton-CDH/princeton-cdh.github.io/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Princeton-CDH%2Fprinceton-cdh.github.io/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28664081,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-22T01:17:37.254Z","status":"online","status_checked_at":"2026-01-22T02:00:07.137Z","response_time":144,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docsy","hugo-site","iteration-reports"],"created_at":"2025-05-12T08:10:11.976Z","updated_at":"2026-01-22T13:49:53.951Z","avatar_url":"https://github.com/Princeton-CDH.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Dev/Design @ CDH\n\nThis repository is used for automated reporting on development work and for maintenance of dev/design documentation and reporting site for the Center for Digital Humanities at Princeton Development and Design Team.\n\n[![github pages](https://github.com/Princeton-CDH/princeton-cdh.github.io/workflows/github%20pages/badge.svg)](https://princeton-cdh.github.io/)\n\n## reporting\n\nGitHub Actions are used to collect data on releases (via repository tags) and issues closed, with points and velocity (based on GitHub and ZenHub APIs). The data files created by these scripts are used for reporting in the Hugo site.\n\n## hugo site\n\nThe dev/design site is generated with [Hugo](https://gohugo.io/) using the [Docsy](https://www.docsy.dev/) theme. The Hugo site is automatically compiled from the `main` branch and published to `gh-pages`.\n\n## prerequisites\n\nHugo requires the following to be installed locally:\n\n- go\n- hugo\n- node\n\nAll can be installed using brew.\n\n## setup\n\nThis site uses the docsy theme, which is installed as a go module. Modules can be installed or updated by runnning:\n```\nhugo mod get\n```\n\nInstall npm dependencies:\n\n```\nnpm install\n```\n\nAnd run locally:\n\n```\nhugo server -D\n```\n\n## Creating iteration reports\n\nUpdate iteration definitions as needed in `iterations.json` if you need to add the dates for the next iteration (although these will likely be populated ahead of time now that we are using that data file for quarterly development schedule).\n\nPull the latest changes from GitHub to get data added by the issue collection and iteration summary GitHub Action scripts, which run on Saturdays.\n\nCreate a new iteration report using the iteration report page bundle archetype with the filename for the post you want to create. By convention, use isodates for iteration reports. To autogenerate for the current date, use this command:\n\n```\nhugo new --kind iteration-report blog/iteration-reports/`date +'%Y-%m-%d'`\n```\n\nThe iteration report archetype assumes it is run on the first day of the new iteration; previous iteration start is calculated accordingly, and should be edited when necessary. Make sure the `iteration_start` date matches the iteration start value in the iterations summary data file, and update the post title to reflect the iteration dates.\n\nEdit the new post to add content and any demo or featured content, then commit and push to GitHub to publish.\n\n## Creating quarterly dev schedule\n\nCreate a new post under `content/blog`, set layout to *quarterlyschedule_v2* and configure\ndate range start and end in page parameters, e.g.::\n```yaml\nlayout: quarterlyschedule_v2\ndate_range:\n    start: \"2023-10-01\"\n    end: \"2024-01-15\"\n```\n\nUpdate the `iterations.json` data file to add the dates for all iterations during the time period you want to cover (best to go slightly beyond the range when possible).\n\nVersion 2 of our quarterly schedule aims to track the bigger picture of our full portfolio and the work taking place at all phases of a project, not only active development.  The information in the iteration file should be structured as a dictionary or mapping of projects with a list of status codes relevant for that iteration, e.g.:\n```json\n\"work\": {\n    \"risk\": [\"writing\"],\n    \"geotaste\": [\"data\", \"code\", \"writing\"],\n    \"geniza\": [\"consulting\"],\n    \"startwords\": [\"paused\"],\n    \"ppa\": [\"data\", \"planning\"]\n}\n```\n\nStatuses in the iteration data file are converted to emojis using the mapping\nin the `projects` data file; when you add a new status, add a new emoji. \n\nThere is also a list of inactive statuses (currently only `paused`, :paused:) which should not be counted when determining if a project is active or partially active in any given iteration.\n\n### Previous quarterly dev schedule format\n\nFor each iteration, add:\n- projects: the list of projects projected to be active that iteration\n- partial: optional, list of projects that are in planning or wrap up phases\n- notes: optional; dictionary with list of notes per project for display in the schedule; when two notes are displayed, the second will be displayed the second week of the iteration.\n\nBe sure to add project colors and partial colors to `_quarterly_schedule.scss` when you add new projects to the schedule.\n\nIterations may be a variable number of weeks; they are typically two, but one and two week iterations are supported by the layout. To include a non-iteration week or time period on the calendar, add the property \"skip\" to the iteration definition. To display a label on the schedule, add text in a \"comment\" field. For example:\n\n```\n    {\n        \"from\": \"2021-06-28\",\n        \"to\": \"2021-07-02\",\n        \"comment\": \"R\u0026D week\",\n        \"skip\": \"yes\"\n    }\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprinceton-cdh%2Fprinceton-cdh.github.io","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fprinceton-cdh%2Fprinceton-cdh.github.io","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fprinceton-cdh%2Fprinceton-cdh.github.io/lists"}