{"id":19838539,"url":"https://github.com/metal-stack/docs","last_synced_at":"2025-08-05T23:34:07.162Z","repository":{"id":37470376,"uuid":"267556760","full_name":"metal-stack/docs","owner":"metal-stack","description":"Contains the documentation for metal-stack","archived":false,"fork":false,"pushed_at":"2025-07-14T15:38:08.000Z","size":82477,"stargazers_count":5,"open_issues_count":22,"forks_count":1,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-07-14T19:58:15.403Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://docs.metal-stack.io/","language":"Shell","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/metal-stack.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-05-28T10:09:55.000Z","updated_at":"2025-07-09T11:54:08.000Z","dependencies_parsed_at":"2023-10-13T00:05:08.487Z","dependency_job_id":"d79882cd-630c-4dcf-abc3-34756d870f7a","html_url":"https://github.com/metal-stack/docs","commit_stats":null,"previous_names":[],"tags_count":142,"template":false,"template_full_name":null,"purl":"pkg:github/metal-stack/docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fdocs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fdocs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fdocs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fdocs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metal-stack","download_url":"https://codeload.github.com/metal-stack/docs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metal-stack%2Fdocs/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265451706,"owners_count":23767808,"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":[],"created_at":"2024-11-12T12:18:07.018Z","updated_at":"2025-08-05T23:34:07.149Z","avatar_url":"https://github.com/metal-stack.png","language":"Shell","readme":"# Docs\n\n[![Stable Docs](https://img.shields.io/badge/docs-stable-blue.svg)](https://docs.metal-stack.io/)\n[![Devel Docs](https://img.shields.io/badge/docs-dev-blue.svg)](https://docs.metal-stack.io/dev/)\n\nThis repository contains the documentation of metal-stack at [docs.metal-stack.io](https://docs.metal-stack.io/).\n\nIt is being generated using [Julia Documenter](https://github.com/JuliaDocs/Documenter.jl). Everything is basically build on Markdown files. Check their [docs](https://juliadocs.github.io/Documenter.jl/stable/) if you want to dig deeper.\n\n## Development\n\nTo generate the documentation you can use the following command (only Docker is required):\n\n```bash\nmake\n```\n\nThe result is being written to `docs/build` and is fully static. You can simply view it in your browser by opening `docs/build/index.html`.\n\nTo update the docs that is included from external repositories (e.g. metalctl, mini-lab, ...), you can run the following target:\n\n```make\nRELEASE_VERSION=master make update\n```\n\nThe `RELEASE_VERSION` points to our [releases](https://github.com/metal-stack/releases) repository.\n\n## Pull Requests\n\nA pull request will automatically generate a preview on our Gitlab page with Github Actions on `https://docs.metal-stack.io/previews/PR\u003cyour-pr-number\u003e`.\n\n## How to organize the docs?\n\n- Prioritize the `concept` section. If this is about a MEP, you likely already have the contents for this.\n- Use the `general` section to distribute users to their sections or to the deeper concept.\n- user, operator or developer specific sections would be nice, but are optional.\n\n### Example\n\n- Roles and Permissions\n  - Concept: explains all roles, permissions and sessions\n  - For operators: OIDC, creation in CI, ... How to / Explanation\n  - For users: how to guide to create tokens and edit permissions\n  - General: base concept, links to How to guides and deeper Concept\n  - CISO / Compliance: minimal need to know Principle Explanation / Concept\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal-stack%2Fdocs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetal-stack%2Fdocs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetal-stack%2Fdocs/lists"}