{"id":23180957,"url":"https://github.com/replicatedhq/help-center","last_synced_at":"2025-04-05T03:13:52.950Z","repository":{"id":22906643,"uuid":"97640794","full_name":"replicatedhq/help-center","owner":"replicatedhq","description":"Replicated help center","archived":false,"fork":false,"pushed_at":"2024-12-18T21:10:27.000Z","size":46672,"stargazers_count":4,"open_issues_count":24,"forks_count":24,"subscribers_count":26,"default_branch":"main","last_synced_at":"2025-03-23T03:33:14.039Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"HTML","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/replicatedhq.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","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":"2017-07-18T20:26:00.000Z","updated_at":"2024-12-18T21:10:32.000Z","dependencies_parsed_at":"2024-03-20T17:59:16.952Z","dependency_job_id":null,"html_url":"https://github.com/replicatedhq/help-center","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/replicatedhq%2Fhelp-center","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Fhelp-center/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Fhelp-center/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/replicatedhq%2Fhelp-center/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/replicatedhq","download_url":"https://codeload.github.com/replicatedhq/help-center/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280270,"owners_count":20912967,"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-12-18T08:13:56.928Z","updated_at":"2025-04-05T03:13:52.928Z","avatar_url":"https://github.com/replicatedhq.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Local development\n\nBefore you are able to run this locally you need to have NodeJS v8.x, [YARN](https://yarnpkg.com/lang/en/docs/install/) and [Hugo installed](https://gohugo.io/getting-started/installing/) on your machine. If you already have Hugo installed, make sure you [have the latest version](https://gohugo.io/getting-started/installing/#upgrade-hugo).\n\n1. Install project dependencies\n   ```bash\n   make install\n   ```\n\n1. Back in the root of the project, run\n   ```bash\n   make build\n   ```\n\n1. And then run the project\n   ```bash\n   make serve\n   ```\n\n1. In your browser navigate to `localhost:1313` to view the project.\n\n### Staging vs Prod\n\nHelp center can be built for either staging or prod via:\n\n#### Prod\n```bash\n make build-prod\n```\n\n```bash\n make serve-prod\n```\n\n#### Staging\n```bash\n make build-staging\n```\n\n```bash\n make serve-staging\n```\n\n### Indexing Content\n\nIncluded in this project is the [hugo-algolia](https://github.com/replicatedhq/hugo-algolia) package, which crawls the /content folder of the site and indexes all the content. If you want to re-index the site and/or send new docs content to Algolia, you can use the following commands:\n\n#### Index the site\nThis command indexes the whole site and puts content into a single array.\n\n```bash\nmake index-site\n```\n\n#### Index the site and send content to Algolia account\nThis command indexes the whole site and sends the array to Algolia.\n\n```bash\nmake index-and-send\n```\n\nYou can index and send content to our staging indices via:\n```bash\nmake index-and-send-staging\n```\n\n### Adding the KOTS documentaion alert\n\nSimply put the following shortcode after the front matter and before the main page content (or wherever you want the alert to appear) and replace the URL with the URL to the desired article.\n\n```bash\n{{\u003c kotsdocs \"https://kots.io\" \u003e}}\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplicatedhq%2Fhelp-center","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Freplicatedhq%2Fhelp-center","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Freplicatedhq%2Fhelp-center/lists"}