{"id":18293105,"url":"https://github.com/kubesphere/devops-docs-sample","last_synced_at":"2025-04-05T11:30:54.302Z","repository":{"id":52891143,"uuid":"157944658","full_name":"kubesphere/devops-docs-sample","owner":"kubesphere","description":null,"archived":false,"fork":false,"pushed_at":"2019-01-28T12:15:35.000Z","size":71588,"stargazers_count":1,"open_issues_count":0,"forks_count":54,"subscribers_count":9,"default_branch":"master","last_synced_at":"2024-04-13T21:43:05.659Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kubesphere.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}},"created_at":"2018-11-17T02:50:11.000Z","updated_at":"2021-09-15T17:10:23.000Z","dependencies_parsed_at":"2022-08-23T13:30:54.549Z","dependency_job_id":null,"html_url":"https://github.com/kubesphere/devops-docs-sample","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fdevops-docs-sample","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fdevops-docs-sample/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fdevops-docs-sample/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kubesphere%2Fdevops-docs-sample/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kubesphere","download_url":"https://codeload.github.com/kubesphere/devops-docs-sample/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221927454,"owners_count":16903070,"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-05T14:22:05.920Z","updated_at":"2024-11-05T14:22:06.697Z","avatar_url":"https://github.com/kubesphere.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Documents for [KubeSphere](KubeSphere).\n\n[![Build Status](https://travis-ci.org/kubesphere/docs.kubesphere.io.svg)](https://travis-ci.org/kubesphere/docs.kubesphere.io)\n\n## Develop\n\n### Setting up with git\nIf you choose this way, we recommend you to install some requisites\n- git\n- node.js\n- yarn (or npm, `we recommend yarn`)\n\nCheck your requisites:\n```shell\ngit --version\nnode -v\nyarn -v\n```\n\nThen you are ready to go:\n```shell\ngit clone https://github.com/kubesphere/docs.kubesphere.io.git\n\ncd docs.kubesphere.io\n\nyarn\n\nyarn develop\n```\n\n## Contribute\n\nTree of repo:\n\n```bash\n├── content                                         // documents directory\n│   ├── express                                     // documents version\n│   │   ├── en                                      // documents language \n│   │   │   └── KubeSphere-Installer-Guide.md       // document\n│   │   └── zh-CN\n│   │       └── KubeSphere-Installer-Guide.md\n│   ├── toc_express_en.json                         // table of contents, define the page navigation\n│   └── toc_express_zh-CN.json\n├── src\n└── static                                          // put document images here\n    └── daemonset_create_1.png\n```\n\nIf you want to edit the document, you can follow the ways below:\n\n### Add new version\n \n1. Create a new directory called the new version name under the ``content`` directory\n\n```shell\ncd content \u0026\u0026 mkdir version-xxxx\n```\n\n2. Create subdirectories for each language you want to support\n\n```shell\ncd content/version-xxxx \u0026\u0026 mkdir zh-CN en\n```\n\n3. Create navigation files for each language of the new version under the ``content`` directory\n\n```shell\ncd content\n\ntouch toc_version-xxx_en.json toc_version-xxx_zh-CN.json\n```\n\n### Edit navigation\n\nnavigation file example\n\n- id: should match the format of ``{version}-{language}``\n- chapters: nav items\n- title: nav title\n- entry: nav entry, path to the document to display\n- entries: sub navs\n\n```json\n{\n  \"id\": \"express-zh-CN\",\n  \"chapters\": [\n    {\n      \"title\": \"简介\",\n      \"entry\": \"./express/zh-CN/basic.md\"\n    },\n    {\n      \"title\": \"应用负载\",\n      \"entries\": [\n        {\n          \"entry\": \"./express/zh-CN/manage-deployments.md\"\n        },\n        {\n          \"entry\": \"./express/zh-CN/manage-statefulsets.md\"\n        },\n        {\n          \"entry\": \"./express/zh-CN/manage-daemonsets.md\"\n        }\n      ],\n      \"chapters\": [\n      ]\n    }\n  ]\n}\n```\n\n### Edit Document\n\ndocument example\n\n```\n---\n  title: 'document title, will show in nav'\n---\n\n  ## title 1\n\n  content 1\n\n  ![](/image.png) \n\n  this path will request ``/static/image.png``\n\n  ## title 2\n\n  ### subtitle 2.1\n    content 2.1\n  \n  ### title 3\n```\n\n`##` will be transformed to an anchor of the page, and will show in the nav.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fdevops-docs-sample","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkubesphere%2Fdevops-docs-sample","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkubesphere%2Fdevops-docs-sample/lists"}