{"id":50724867,"url":"https://github.com/calconnect/standards.calconnect.org","last_synced_at":"2026-06-10T03:03:07.876Z","repository":{"id":71559920,"uuid":"149702208","full_name":"CalConnect/standards.calconnect.org","owner":"CalConnect","description":"CalConnect Document Registry","archived":false,"fork":false,"pushed_at":"2026-05-23T03:54:29.000Z","size":156178,"stargazers_count":1,"open_issues_count":10,"forks_count":2,"subscribers_count":23,"default_branch":"main","last_synced_at":"2026-05-23T05:26:29.969Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://standards.calconnect.org","language":"CSS","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/CalConnect.png","metadata":{"files":{"readme":"README.adoc","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,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2018-09-21T03:02:47.000Z","updated_at":"2026-05-23T03:54:34.000Z","dependencies_parsed_at":"2025-02-12T04:23:41.575Z","dependency_job_id":"5ea64749-f747-4980-8114-b62e91a90218","html_url":"https://github.com/CalConnect/standards.calconnect.org","commit_stats":null,"previous_names":["calconnect/standards-calconnect-org.github.io","calconnect/standards.calconnect.org"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/CalConnect/standards.calconnect.org","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalConnect%2Fstandards.calconnect.org","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalConnect%2Fstandards.calconnect.org/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalConnect%2Fstandards.calconnect.org/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalConnect%2Fstandards.calconnect.org/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CalConnect","download_url":"https://codeload.github.com/CalConnect/standards.calconnect.org/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CalConnect%2Fstandards.calconnect.org/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34134634,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-10T02:00:07.152Z","response_time":89,"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":[],"created_at":"2026-06-10T03:03:04.642Z","updated_at":"2026-06-10T03:03:07.870Z","avatar_url":"https://github.com/CalConnect.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"= CalConnect Standards Registry\n\nimage:https://github.com/CalConnect/standards.calconnect.org/actions/workflows/build_deploy.yml/badge.svg[\n    Build Status, link=\"https://github.com/CalConnect/standards.calconnect.org/actions/workflows/build_deploy.yml\"]\n\n== Introduction\n\nThe CalConnect Standards Registry publishes CalConnect deliverables —\nstandards, specifications, guides, directives, and other documents —\nat https://standards.calconnect.org.\n\nThe site is an aggregator: it discovers Metanorma document repositories\nvia the `metanorma-release` GitHub topic, fetches their published releases,\nand builds a static site with full-text search, category pages, and document downloads.\n\nThe site is managed by TC PUBLISH.\n\n\n== Sites\n\n[cols=\"a,a,a\",options=\"header\"]\n|===\n|Site | Git branch | URL\n\n|Production | `main`  | https://standards.calconnect.org\n|===\n\nThe production site is automatically deployed from changes to the `main` branch.\nIt also rebuilds daily at 06:00 UTC to pick up new releases from document repos.\n\n\n== Architecture\n\n=== How documents get published\n\n. **Document repo** — A Metanorma repo (e.g. `cc-icalendar-series`) compiles `.adoc` sources\n  and runs the `release` workflow, which publishes ZIP archives to GitHub Releases\n  with channel labels (e.g. `public/standards`).\n. **Aggregation** — This site runs `metanorma-release aggregate`, which discovers repos\n  by the `metanorma-release` topic, fetches their releases, filters by channel,\n  extracts document files, and enriches metadata from Relaton bibliographic data.\n. **Site build** — Jekyll builds static HTML from the aggregated `documents.json` index.\n  Vite compiles the JavaScript and Tailwind CSS.\n. **Deploy** — GitHub Pages serves the built site.\n\n=== Software stack\n\n* https://github.com/metanorma/metanorma-release[metanorma-release] — aggregation pipeline\n* https://jekyllrb.com[Jekyll] — static site generator\n* https://vitejs.dev[Vite] + https://tailwindcss.com[Tailwind CSS] — frontend build\n* https://github.com/features/actions[GitHub Actions] — CI/CD\n\n\n== Quick start\n\n[source,sh]\n----\n# Install dependencies\nbundle install\nnpm ci\n\n# Aggregate releases + build the site\nbundle exec rake build\n\n# Serve locally\nnpx serve _site\n----\n\nNOTE: Aggregation requires a `GITHUB_TOKEN` with read access to the CalConnect organization repos.\nSet it as an environment variable or in `.env`.\n\n\n== Build commands\n\nThe `Rakefile` provides these tasks:\n\n[cols=\"1m,3\",options=\"header\"]\n|===\n|Command |Description\n|`rake fetch` |Aggregate releases into `_data/documents.json` and `_site/docs/`\n|`rake build` |Fetch + compile Vite + build Jekyll site\n|`rake jekyll` |Build Jekyll only (assumes fetch already done)\n|`rake serve` |Serve with Jekyll's dev server\n|`rake clean` |Remove `_site/`\n|===\n\n\n== Configuration\n\n=== `metanorma.aggregate.yml`\n\nControls how the aggregator discovers repos and builds output:\n\n[source,yaml]\n----\nsource: github\noutput_dir: _site/docs\nfile_routing: flat\ncache_dir: .cache/aggregate\ndata_dir: _data\n\nchannels:\n  - public\n\ninclude_drafts: true\n\ndisplay_categories:\n  - name: Standards, Specifications \u0026 Reports\n    slug: standards\n    doctypes: [standard, specification, report]\n  - name: Guides \u0026 Advisories\n    slug: guides\n    doctypes: [guide, advisory]\n  - name: Directives\n    slug: directives\n    doctypes: [directive]\n  - name: Administrative\n    slug: administrative\n    doctypes: [administrative]\n  - name: Amendments \u0026 Technical Corrigenda\n    slug: amendments\n    doctypes: [amendment, technical-corrigendum]\n\ngithub:\n  organizations:\n    - CalConnect\n  topic: metanorma-release\n----\n\nKey settings:\n\n* `output_dir` — where extracted document files are written\n* `channels` — which channels to subscribe to (`public` matches all `public/*`)\n* `display_categories` — maps doctypes to site categories\n* `include_drafts` — include working drafts, committee drafts, etc.\n* `data_dir` — writes flattened `documents.json` for Jekyll's `_data/`\n\n=== Delta state cache\n\nAggregation is incremental. The `.cache/aggregate/` directory tracks which repos/tags have been processed.\nCI caches this directory between builds to avoid re-downloading unchanged releases.\n\nWhen the cache is stale (e.g. files are missing from disk), the pipeline re-processes affected repos automatically.\n\n\n== How to add/remove documents\n\n=== Adding a document\n\nDocuments are added by creating a new Metanorma repository:\n\n. Use the https://github.com/CalConnect/cc-template[`cc-template`] repository template\n. Add the `metanorma-release` topic to the new repository\n. Write the document in AsciiDoc and push to `main`\n\nThe document will appear on standards.calconnect.org after:\n\n. The document repo's `release` workflow runs (on push to `main`)\n. This site's next build (push to `main` or daily cron)\n\nNo changes to this repository are needed.\n\n=== Removing a document\n\n. Archive or delete the document repository, or\n. Remove the `metanorma-release` topic from the repository\n\nThe document will disappear from the site on the next build.\n\n=== Changing a document's category\n\nDocument categories are determined by doctype.\nEdit `metanorma.aggregate.yml` → `display_categories` to change which doctypes map to which category.\n\n\n== Project structure\n\n```\n├── .github/workflows/\n│   └── build_deploy.yml        # CI: aggregate + build + deploy\n├── _data/                      # Generated by aggregation\n│   └── documents.json          # Flattened document index\n├── _frontend/                  # Vite + Tailwind source\n│   ├── entrypoints/\n│   │   ├── application.css     # Tailwind CSS entry\n│   │   └── application.js      # JavaScript entry\n│   └── js/\n│       └── home.js             # Global search\n├── _includes/                  # Jekyll partials\n│   ├── head.html\n│   ├── nav.html\n│   └── footer.html\n├── _layouts/                   # Jekyll layouts\n│   ├── base.html\n│   └── doc-type.html           # Category page (standards, guides, etc.)\n├── _pages/                     # Site pages\n│   ├── index.html              # Home page with search\n│   ├── standards.html\n│   ├── guides.html\n│   ├── directives.html\n│   ├── administrative.html\n│   ├── amendments.html\n│   ├── drafts.html\n│   └── public-review.html\n├── _site/                      # Built site output\n│   ├── docs/                   # Extracted document files (HTML, PDF, XML, RXL)\n│   └── index.json              # Full document index\n├── public/                     # Static assets (favicons, Vite output)\n├── Gemfile                     # Ruby dependencies\n├── Rakefile                    # Build tasks\n├── metanorma.aggregate.yml     # Aggregator configuration\n├── package.json                # Node.js dependencies\n└── vite.config.js              # Vite configuration\n```\n\n\n== CI/CD\n\nThe `build_deploy` workflow:\n\n. Sets up Ruby 3.3 + Node.js 24\n. Restores aggregate cache (`.cache/aggregate/`)\n. Runs `bundle exec rake build` (aggregate + Vite + Jekyll)\n. Verifies the build produced \u003e0 documents\n. Uploads Pages artifact\n. Deploys to GitHub Pages (on `main` only)\n\nScheduled builds run daily at 06:00 UTC to pick up new releases.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalconnect%2Fstandards.calconnect.org","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcalconnect%2Fstandards.calconnect.org","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcalconnect%2Fstandards.calconnect.org/lists"}