{"id":48816455,"url":"https://github.com/throughput-ec/throughput_docs","last_synced_at":"2026-04-14T11:04:41.231Z","repository":{"id":54410882,"uuid":"298696378","full_name":"throughput-ec/throughput_docs","owner":"throughput-ec","description":"The documentation repository for Throughput.","archived":false,"fork":false,"pushed_at":"2021-11-03T01:17:03.000Z","size":2574,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":4,"default_branch":"prod","last_synced_at":"2023-03-06T14:27:37.484Z","etag":null,"topics":["documentation","earthcube","mkdocs","throughput-database"],"latest_commit_sha":null,"homepage":"","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/throughput-ec.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-09-25T23:01:23.000Z","updated_at":"2021-11-03T01:17:06.000Z","dependencies_parsed_at":"2022-08-13T14:50:41.787Z","dependency_job_id":null,"html_url":"https://github.com/throughput-ec/throughput_docs","commit_stats":null,"previous_names":[],"tags_count":null,"template":null,"template_full_name":null,"purl":"pkg:github/throughput-ec/throughput_docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/throughput-ec%2Fthroughput_docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/throughput-ec%2Fthroughput_docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/throughput-ec%2Fthroughput_docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/throughput-ec%2Fthroughput_docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/throughput-ec","download_url":"https://codeload.github.com/throughput-ec/throughput_docs/tar.gz/refs/heads/prod","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/throughput-ec%2Fthroughput_docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31793245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-14T02:24:21.117Z","status":"ssl_error","status_checked_at":"2026-04-14T02:24:20.627Z","response_time":153,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["documentation","earthcube","mkdocs","throughput-database"],"created_at":"2026-04-14T11:04:04.261Z","updated_at":"2026-04-14T11:04:41.215Z","avatar_url":"https://github.com/throughput-ec.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Documentation Building](https://github.com/throughput-ec/throughput_docs/actions/workflows/ci.yml/badge.svg)\n[![lifecycle](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)\n[![NSF-1928366](https://img.shields.io/badge/NSF-1928366-blue.svg)](https://nsf.gov/awardsearch/showAward?AWD_ID=1928366)\n\n# Throughput Documentation\n\nWeb documentation generated using Markdown documents together with the Python module [MkDocs](https://www.mkdocs.org/).  This documentation is intended to cover the main elements of the actual Throughput Database itself, including [installation instructions](https://throughput-ec.github.io/throughput_docs/admin/loading/) and [node types within the database](https://throughput-ec.github.io/throughput_docs/nodes/objects/).\n\nThere are also several [data models presented](https://throughput-ec.github.io/throughput_docs/models/data_models/) to help showcase uses for the database, and the ways in which queries may be structured.\n\n## Contributors\n\nThis project is an open project, and contributions are welcome from any individual.  All contributors to this project are bound by a [code of conduct](CODE_OF_CONDUCT.md).  Please review and follow this code of conduct as part of your contribution.\n\n* [Simon Goring](http://goring.org) [![orcid](https://img.shields.io/badge/orcid-0000--0002--2700--4605-brightgreen.svg)](https://orcid.org/0000-0002-2700-4605) - University of Wisconsin Madison\n* [Michael Lenard](https://www.si.umich.edu/people/michael-lenard) [![orcid](https://img.shields.io/badge/orcid-0000--0003--0298--785X-brightgreen.svg)](https://orcid.org/0000-0003-0298-785X) - University of Michigan\n\n### Tips for Contributing\n\nIssues and bug reports are always welcome.  Code clean-up, and feature additions can be done either through pull requests to [project forks]() or branches.\n\nAll products of the Throughput Annotation Project are licensed under an [MIT License](LICENSE.md) unless otherwise noted.\n\n## How to use this repository\n\nText files in this repository are parsed from Markdown using [MkDocs](https://www.mkdocs.org/), to generate a set of pages with navigation for use in displaying the Throughput documentation.\n\nMkdocs requires the use of Python.  Instructions are available online [to install Mkdocs](https://www.mkdocs.org/getting-started/#installation).  If Python 3.0+ and `pip` are both installed, then `Mkdocs` can be quickly installed using `pip install mkdocs`.\n\nThis repository is already set up as an Mkdocs project, so you can serve the pages locally using `mkdocs serve`, or render the whole site as a static webiste using `mkdocs build`.  The `serve` command allows you to monitor your changes as you go.  By default `mkdocs serve` serves the pages at `localhost:8000`.\n\n![Webpage when built using mkdocs](throughput/images/built_page.png)\n\n### Workflow Overview\n\nMarkdown files are arranged in folders within the [`docs`}(docs/) folder.  Each folder represents a conceptual grouping of pages.  The navigation is defined in the file [mkdocs.yml](mkdocs.yml), in the `nav` property.\n\n```bash\nmkdocs build\n```\n\nContinuous integration for the repository is managed using [GitHub Actions](https://github.com/throughput-ec/throughput_docs/actions) with a module that [builds the pages using mkdocs](https://github.com/throughput-ec/throughput_docs/blob/prod/.github/workflows/ci.yml) under an Ubuntu build.  A failing build means that the current `prod` branch of the repository is not correctly set up to render a static Mkdocs site.\n\n### System Requirements\n\nThis project was developed using Python 3.8.10 in a Linux evironment (Ubuntu 20.04.3 LTS).\n\n### Data Requirements\n\nThis project is self-contained (except for the requirements described above).\n\n### Key Outputs\n\nThis project generates a documentation website.  The `main` branch of the repository is live at [https://throughput-ec.github.com/throughput_docs](https://throughput-ec.github.com/throughput_docs).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthroughput-ec%2Fthroughput_docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fthroughput-ec%2Fthroughput_docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fthroughput-ec%2Fthroughput_docs/lists"}