{"id":15107064,"url":"https://github.com/better-hpc/keystone-docs","last_synced_at":"2025-07-02T11:36:17.511Z","repository":{"id":234509399,"uuid":"786495331","full_name":"Better-HPC/keystone-docs","owner":"Better-HPC","description":"Documentation for the Keystone allocation manager.","archived":false,"fork":false,"pushed_at":"2025-06-24T13:27:34.000Z","size":1312,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"main","last_synced_at":"2025-06-24T14:31:36.501Z","etag":null,"topics":["mkdocs","yaml"],"latest_commit_sha":null,"homepage":"http://better-hpc.github.io/keystone-docs/","language":null,"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/Better-HPC.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":"2024-04-14T16:31:52.000Z","updated_at":"2025-06-24T13:27:39.000Z","dependencies_parsed_at":"2024-06-20T02:45:47.143Z","dependency_job_id":"cc9b4db2-6bc8-4db8-bcfc-138533235d96","html_url":"https://github.com/Better-HPC/keystone-docs","commit_stats":{"total_commits":122,"total_committers":4,"mean_commits":30.5,"dds":"0.25409836065573765","last_synced_commit":"7b6241d2650a0e05e7347348024b91a94a507462"},"previous_names":["pitt-crc/keystone-docs","better-hpc/keystone-docs"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Better-HPC/keystone-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Better-HPC%2Fkeystone-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Better-HPC%2Fkeystone-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Better-HPC%2Fkeystone-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Better-HPC%2Fkeystone-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Better-HPC","download_url":"https://codeload.github.com/Better-HPC/keystone-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Better-HPC%2Fkeystone-docs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":263130934,"owners_count":23418363,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["mkdocs","yaml"],"created_at":"2024-09-25T21:04:11.021Z","updated_at":"2025-07-02T11:36:17.461Z","avatar_url":"https://github.com/Better-HPC.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Keystone Documentation\n\nThis repository acts as a GitOps staging ground for publishing the Keystone documentation.\nProject level documentation is stored in this repository and combined with component level documentation\n(e.g., Keystone-API, Keystone-Web) via Git submodules.\n\n## Submodules\n\n- [Keystone-API](https://github.com/better-hpc/keystone-api): Backend REST API for managing HPC allocations and resources.\n- [Keystone-Web](https://github.com/better-hpc/keystone-web): Website frontend for HPC administration and self-service.\n- [Keystone-Python-Client](https://github.com/better-hpc/keystone-python-client): A light-weight Python client for Keystone API.\n\n## Getting Started\n\n### Working Locally\n\nThis repository leverages submodules.\nTo clone the repository with submodules included:\n\n```shell\ngit clone [URL] --recurse-submodules\n```\n\nSubmodules can also be pulled and updated manually:\n\n```shell\ngit submodule update --init\n```\n\nAfter ensuring the submodules are up-to-date, make sure to (re)install the project dependencies.\n\n```shell\npip install -r requirements.txt\n```\n\nDocumentation is compiled and served locally using the `mkdcs` utility.\n\n```shell\nmkdocs serve\n```\n\n### Working in CI\n\nNew documentation is automatically built and published every time the `main` branch is updated.\nCI permissions are granted via the `Keystone-GitOps` GitHub application which must be installed on all upstream repositories.\nSee the organization level settings to install and configure the GitHub application on new repositories.\n\nA composite GitHub action is provided to streamline GitOps activities against this repository.\nThe following example job updates the `keystone-api` submodule to tag `tags/v0.3.8` and publishes new documentation.\nAuthentication/permissions are handled by the GitHub application identified by its application ID (`keystone-gitops-id`) and primary key (`keystone-gitops-pk`).\n\n```yml\njobs:\n  build:\n    runs-on: ubuntu-latest\n    steps:\n      - name: Update docs\n        uses: better-hpc/keystone-docs/.github/actions/update-action/@main\n        with:\n          keystone-gitops-id: ${{ secrets.KEYSTONE_GITOPS_ID }}\n          keystone-gitops-pk: ${{ secrets.KEYSTONE_GITOPS_PK }}\n          repo-name: keystone-api\n          tag: tags/v0.3.8\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetter-hpc%2Fkeystone-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbetter-hpc%2Fkeystone-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbetter-hpc%2Fkeystone-docs/lists"}