{"id":28867150,"url":"https://github.com/minio/kes-docs","last_synced_at":"2025-10-09T00:08:47.399Z","repository":{"id":65765184,"uuid":"537621468","full_name":"minio/kes-docs","owner":"minio","description":"Documentation for the MinIO Key Encryption Service (KES)","archived":false,"fork":false,"pushed_at":"2025-08-12T17:51:51.000Z","size":8431,"stargazers_count":3,"open_issues_count":3,"forks_count":4,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-10-07T03:40:56.751Z","etag":null,"topics":["documentation"],"latest_commit_sha":null,"homepage":"https://github.com/minio/kes","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"cc-by-4.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/minio.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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":"2022-09-16T21:13:14.000Z","updated_at":"2025-08-12T17:51:54.000Z","dependencies_parsed_at":"2024-05-28T21:39:17.116Z","dependency_job_id":"81a9f572-9d0d-4e8e-a461-ec0f86e12004","html_url":"https://github.com/minio/kes-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/minio/kes-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fkes-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fkes-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fkes-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fkes-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/minio","download_url":"https://codeload.github.com/minio/kes-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/minio%2Fkes-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279000745,"owners_count":26082879,"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","status":"online","status_checked_at":"2025-10-08T02:00:06.501Z","response_time":56,"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":["documentation"],"created_at":"2025-06-20T11:41:25.253Z","updated_at":"2025-10-09T00:08:47.377Z","avatar_url":"https://github.com/minio.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# MinIO's Key Encryption Service (KES) Documentation\n\nThe KES docs use [Hugo](https://www.gohogo.io) to generate static HTML pages.\n\n- [MinIO's Key Encryption Service (KES) Documentation](#minios-key-encryption-service-kes-documentation)\n  - [Prerequisites](#prerequisites)\n  - [Initial Setup](#initial-setup)\n  - [Update Theme from Upstream Repository](#update-theme-from-upstream-repository)\n  - [Build Preview](#build-preview)\n  - [Build for production](#build-for-production)\n  - [Style](#style)\n    - [Markup](#markup)\n    - [Style Guides](#style-guides)\n    - [Spelling](#spelling)\n    - [Code Blocks](#code-blocks)\n  - [Shortcodes](#shortcodes)\n    - [Internal linking](#internal-linking)\n    - [Components (Tabs, Admonitions, Cards, etc.)](#components-tabs-admonitions-cards-etc)\n  - [Frontmatter](#frontmatter)\n    - [Custom Frontmatter params](#custom-frontmatter-params)\n\n## Prerequisites\n\n- Any [operating system that Hugo supports](https://gohugo.io/installation/)\n- [nodejs](https://nodejs.org/en/download/package-manager/) 16.9.x or later\n- [Node Package Manager](https://docs.npmjs.com/downloading-and-installing-node-js-and-npm) installed (8.5.0 or later)\n- [Hugo installed](https://gohugo.io/installation/) (0.110.0 or later)\n\n## Initial Setup\n\n1. Clone this repository\n2. cd to the directory (`cd kes-docs`)\n3. Initialize the theme directory submodule\n\n   ```\n   git submodule update --init --recursive\n   ```\n\n4. `cd themes/kes-docs-theme`\n5. `npm install`\n6. `npm run build`\n7. `cd ../../`\n\n## Update Theme from Upstream Repository\n\nThe theme we use in the docs is hosted and maintained in a separate, private repository.\nWe use a the git submodule functionality to include it here.\nAfter updating the theme, re-install node packages and then re-build the theme assets.\n\nTo pull new updates to the theme from the upstream repository, run the following:\n\n```\ngit submodule update --recursive --remote\ncd themes/kes-docs-theme\nnpm install\nnpm run build\n```\n\n**Note:** You must have access to the remote theme repository, which is a private MinIO repository.\n\n## Build Preview\n\nYou can launch a live preview of the site as you work.\n\n1. From your terminal in the repository folder, run\n\n   ```shell\n   hugo server\n   ```\n\n2. In your browser, go to `localhost:1313`\n\n## Build for production\n\nTo build the site for production or to upload to the staging server:\n\n1. Run\n\n   ```shell\n   hugo\n   ```\n\n2. Contents go to the `/public` directory in the repo folder.\n\n## Style\n\n### Markup\n\nWe write in [Goldmark Markdown](https://github.com/yuin/goldmark/) as extended by [Hugo shortcodes](https://gohugo.io/content-management/shortcodes/) and our own [shortcodes](#shortcodes).\n\nGoldmark is fully [Commonmark](https://commonmark.org/help/) compliant.\n\n### Style Guides\n\nMinIO uses an internal style guide.\nAllow maintainers to modify your branch when you submit your PR so that we can adjust for internal style consistencies.\n\nOtherwise, follow these resources in order of preference:\n\n1. [MongoDB Style Guide](https://www.mongodb.com/docs/meta/style-guide/quickstart/)\n2. [ASD-STE-100 Simplified Technical English](https://asd-ste100.org/STE_downloads.html#features16-x)\n3. [Google Developer Style Guide](https://developers.google.com/style/)\n\n### Spelling\n\nWe write in American English, using [Merriam Webster's online dictionary](https://www.merriam-webster.com/) as the standard spelling reference.\n\n### Code Blocks\n\nTo add a copy button to a code block, add `{.copy}` after the language format.\n\nFor example\n\n```md\n```yaml {.copy}\ntls:\n  key:      ./server.key   # Path to the TLS private key\n  cert:     ./server.cert  # Path to the TLS certificate\n  password: \"\"             # An optional password to decrypt the TLS private key\n```\n\nThe code block *must* have a valid language type for the copy function to work.\n\n## Shortcodes\n\nHugo uses shortcodes to extend what is normally available with Markdown.\n\n### Internal linking\n\nTo link to another page within the docs, use the following format.\n\n```Markdown\n[link text]({{\u003c relref \"path/to/page/#heading\" \u003e}})\n```\n\n### Components (Tabs, Admonitions, Cards, etc.)\n\nRefer to `themes/kes-docs-theme/README.md`.\n\n## Frontmatter\n\nWe use YAML-formatted [front matter](https://gohugo.io/content-management/front-matter/).\n\n\u003c!---\nWe need to implement cascading front matter.\nSee https://gohugo.io/content-management/front-matter/#front-matter-cascade.\n--\u003e\n\nPages should have at least the following front matter tokens:\n\n```yaml\n---\ntitle: \u003cPage Title\u003e\ndate: YYYY-MM-DD ## date of file creation\nlastmod: :git ## this is retrieved from git and should not be modified\ndraft: false ## set to true if the document is not yet ready for publication\ntableOfContents: true ## creates a right-side page navigation TOC, set to `false` if not needed\n---\n```\n\n### Custom Frontmatter params\n\nRefer to `themes/kes-docs-theme/README.md`.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fkes-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fminio%2Fkes-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fminio%2Fkes-docs/lists"}