Skip to content

Documentation on how to operate and manage your Plural installation.

License

Notifications You must be signed in to change notification settings

asmallberg/documentation

This branch is 81 commits behind pluralsh/documentation:main.

Folders and files

NameName
Last commit message
Last commit date
Jun 15, 2023
Mar 31, 2023
Apr 25, 2023
Jun 15, 2023
Nov 14, 2023
Mar 22, 2024
Mar 16, 2024
Mar 11, 2024
Dec 8, 2022
Jun 16, 2023
Dec 2, 2022
Dec 5, 2022
Apr 25, 2023
Mar 31, 2023
Mar 31, 2023
Jun 15, 2023
Jun 26, 2021
Nov 13, 2023
Nov 17, 2022
Mar 6, 2023
Jun 16, 2023
Dec 7, 2022
Oct 21, 2022
Dec 2, 2022
Jul 28, 2023
Nov 9, 2022
Apr 25, 2023
Nov 13, 2023

Repository files navigation

Documentation site for Plural, 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.

Built with Next.js and Markdoc.

Contributing

Running the docs locally

To run the docs locally, you'll need to have yarn and node as prerequisites. Then run the following commands:

yarn # build the environment
yarn dev # run docs locally

Adding a new document

All content can be located under the pages directory. The directory structure directly informs the website URL structure, so consider that when placing your new document.

All of our documents are in standard Markdown (.md) file format. If you are including an image, add it to [public/assets] using the same directory structure as pages.

Finally, make sure to add your new document to the NavData.tsx file located here.

Updating structure

If you are making any changes to the documentation structure or organization, you'll likely need to set up page redirects. These can be added in next.config.js. Make sure to look for internal usages throughout all the documents on the site to make sure that there are no broken links.

About

Documentation on how to operate and manage your Plural installation.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 94.8%
  • JavaScript 4.5%
  • Other 0.7%