{"id":20692487,"url":"https://github.com/pluralsh/documentation","last_synced_at":"2026-02-27T00:14:15.894Z","repository":{"id":37002273,"uuid":"380604222","full_name":"pluralsh/documentation","owner":"pluralsh","description":"Documentation on how to operate and manage your Plural installation.","archived":false,"fork":false,"pushed_at":"2025-04-15T19:35:46.000Z","size":167026,"stargazers_count":5,"open_issues_count":19,"forks_count":11,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-04-15T20:38:51.811Z","etag":null,"topics":["devops","kubernetes","open-source"],"latest_commit_sha":null,"homepage":"https://docs.plural.sh/","language":"TypeScript","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/pluralsh.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":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2021-06-26T22:07:22.000Z","updated_at":"2025-04-15T19:35:48.000Z","dependencies_parsed_at":"2024-03-26T12:31:52.053Z","dependency_job_id":"a90b5d80-a668-429d-9573-a9a41a849770","html_url":"https://github.com/pluralsh/documentation","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/pluralsh%2Fdocumentation","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pluralsh%2Fdocumentation/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pluralsh%2Fdocumentation/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/pluralsh%2Fdocumentation/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/pluralsh","download_url":"https://codeload.github.com/pluralsh/documentation/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250286309,"owners_count":21405407,"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":["devops","kubernetes","open-source"],"created_at":"2024-11-16T23:22:08.524Z","updated_at":"2025-10-28T01:34:28.693Z","avatar_url":"https://github.com/pluralsh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"Documentation site for [Plural](https://www.plural.sh/), the open-source, unified, application deployment platform that makes it easy to run open-source software on Kubernetes. Our marketplace has dozens of top tier applications ready to deploy.\n\nBuilt with [Next.js](https://nextjs.org/) and [Markdoc](https://markdoc.dev/).\n\n## Contributing\n\n### Running the docs locally\n\nTo run the docs locally, you'll need to have yarn and node as prerequisites. Then run the following commands:\n\n```shell\nyarn # build the environment\nyarn dev # run docs locally\n```\n\n### Adding a new document\n\nAll documentation content is defined by the [`docsStructure`](/src/routing/docs-structure.ts) object. This file is the single source of truth for the docs site structure, navigation, and URL mapping. When running `yarn dev` or `yarn build`, the route indexing script will search the paths described, first for an index.md, then for a PATHNAME.md file if an index.md file isn't found (i.e. it will look first for /overview/introduction/index.md, then /overview/introduction.md if index isn't found). \n\nThe indexing script will reconcile routes into the generated [`routes.json`](/generated/routes.json), which needs to be committed to git so changes can be confirmed/tracked. A github workflow will confirm that route changes have been committed (though lastmod timestamps are ignored, as these lag behind by one commit)\n\nTo add a new document:\n- Update [`docsStructure`](/src/routing/docs-structure.ts) to include your new pages/sections. The order and nesting in this object will determine the sidebar navigation and the URL path.\n\n- Add your new Markdown (`.md`) file to the corresponding location in the [`pages`](/pages) directory.\n\n- If you include images, place them in [`public/assets`](/public/assets) using a directory structure that matches your document's location in `pages`.\n\n### Updating structure and redirects\n\nIf you change the documentation structure (e.g., move, rename, or remove pages), you may need to add redirects to prevent broken links. Redirects are managed directly in [`docs-structure.ts`](/src/routing/docs-structure.ts) via the `redirects` array at the bottom of the file. Redirects on a path already defined by `docsStructure` will override where it reconciles to, which can be confirmed in [`routes.json`](/generated/routes.json)\n\nWhenever you update the structure or add redirects, review internal links throughout the documentation to ensure there are no broken references.","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpluralsh%2Fdocumentation","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fpluralsh%2Fdocumentation","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fpluralsh%2Fdocumentation/lists"}