{"id":21319130,"url":"https://github.com/qleet/user-docs","last_synced_at":"2025-08-15T00:45:23.591Z","repository":{"id":69435819,"uuid":"564016933","full_name":"qleet/user-docs","owner":"qleet","description":"User docs for QleetOS","archived":false,"fork":false,"pushed_at":"2024-05-22T18:02:08.000Z","size":4218,"stargazers_count":4,"open_issues_count":3,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-22T19:27:08.217Z","etag":null,"topics":["gh-pages","mkdocs-material"],"latest_commit_sha":null,"homepage":"https://qleet.github.io/user-docs","language":"Go","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/qleet.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}},"created_at":"2022-11-09T20:18:11.000Z","updated_at":"2024-05-22T19:27:10.469Z","dependencies_parsed_at":null,"dependency_job_id":"28cb6aa3-4cfa-4787-b1f1-9500fbeed20d","html_url":"https://github.com/qleet/user-docs","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/qleet%2Fuser-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qleet%2Fuser-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qleet%2Fuser-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/qleet%2Fuser-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/qleet","download_url":"https://codeload.github.com/qleet/user-docs/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225792669,"owners_count":17524992,"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":["gh-pages","mkdocs-material"],"created_at":"2024-11-21T19:34:49.454Z","updated_at":"2024-11-21T19:34:50.383Z","avatar_url":"https://github.com/qleet.png","language":"Go","readme":"# Qleet User Documentation\n\nUser docs for Qleet hosted Threeport service.\n\n## Local Development\n\nPrerequisistes:\n\n* [python 3](https://docs.python-guide.org/starting/installation/)\n* [mkdocs](https://www.mkdocs.org/getting-started/#installation)\n* [mkdocs-material theme](https://squidfunk.github.io/mkdocs-material/getting-started/#installation)\n\nRun the server locally:\n\n```bash\nmkdocs serve\n```\n\nView the site at [http://127.0.0.1:8000](http://127.0.0.1:8000/)\n\n\n## Release\nRun `release` target\n```bash\nmake release\n```\n\n### Help\n\n```text\n$ make\nUsage: make COMMAND\nCommands :\nhelp    - List available tasks\ndeps    - Install dependencies\nrun     - Run mkdocs\nstop    - Stop mkdocs\nrelease - Create and push a new tag\nversion - Print current version(tag)\n```\n\n## Merge Threeport Docs\n\nIn order to have the open source Threeport user docs nested in the Qleet docs we\ndo the following:\n\n* Keep the upstream Threeport docs as a git submodule of Qleet docs\n* Use a merge tool to add the Threeport docs into the Qleet docs.  The source\n  code for this tool is in the `threeport-merge` directory.\n\nThe `threeport-merge` tool does the following:\n\n* Copies all Threeport markdown docs into the `docs/threeport` directory.\n* Copies all images from Threeport docs into the `docs/img/threeport` directory.\n* Updates all instances of `tptctl` in markdown docs with `qleetctl`.\n* Updates all paths to images in markdown docs to point to its new home in Qleet\n  docs.\n* Updates the `.nav` in Qleet's `mkdocs.yml` config to include the Threeport\n  docs `.nav` with updated paths to markdown docs.\n* Removes any files found in the threeport-merge config file under `.exclude`.\n\n### threeport-merge Config\n\nSample config:\n\n```yaml\nexclude:\n  - docs/threeport/guides/getting-started.md\n  - docs/threeport/guides/install-tptctl.md\n  - docs/threeport/guides/install-threeport-local.md\n  - docs/threeport/guides/install-threeport-aws.md\n  - docs/threeport/guides/deploy-workload-local.md\n```\n\nIf there are any documents in the Threeport user docs that aren't appropriate in\nQleet user docs and should be excluded, add the path to the `.exclude` list and\nthey will be omitted.  The path provided must be the path to the Threeport\ndocument in the Qleet docs where it is found post-merge, i.e. the path to the\ndocument in the `docs/threeport` directory after `threeport-merge` is run.\n\n### Run Merge\n\nIf there are changes in Threeport docs that need to be pulled into the Threeport\nuser-docs submodule, first pull those changes.\n\n```bash\ngit submodule update --remote\n```\n\nThen run `threeport-merge` with a make target.\n\n```bash\nmake threeport-merge\n```\n\nThis make target will:\n\n* Build threeport-merge from source.\n* Run threeport-merge and reference the `threeport-merge/merge-config.yaml`\n  config.\n\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqleet%2Fuser-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fqleet%2Fuser-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fqleet%2Fuser-docs/lists"}