From b39eefa2b62ccb072956f6febecab32622e3f73b Mon Sep 17 00:00:00 2001 From: Vladimir Vagaytsev Date: Tue, 28 May 2024 14:49:18 +0200 Subject: [PATCH] docs: remove Garden Seeds section (#6091) * docs: remove Garden Seeds section This project is outdated and no longer maintained. * chore: re-generate docs --- docs/README.md | 10 +-- docs/garden-seeds/README.md | 4 -- docs/garden-seeds/about.md | 27 -------- docs/garden-seeds/languages/README.md | 15 ----- docs/garden-seeds/languages/go.md | 91 --------------------------- 5 files changed, 2 insertions(+), 145 deletions(-) delete mode 100644 docs/garden-seeds/README.md delete mode 100644 docs/garden-seeds/about.md delete mode 100644 docs/garden-seeds/languages/README.md delete mode 100644 docs/garden-seeds/languages/go.md diff --git a/docs/README.md b/docs/README.md index 21b000323b..a4f0c1892c 100644 --- a/docs/README.md +++ b/docs/README.md @@ -200,19 +200,13 @@ * [`templated`](./reference/module-types/templated.md) * [`terraform`](./reference/module-types/terraform.md) -## 🌸 Garden Seeds - -* [About](./garden-seeds/about.md) -* [Languages](./garden-seeds/languages/README.md) - * [Go 🌸](./garden-seeds/languages/go.md) - -## 🌳 Misc +## 🌸 Misc * [FAQ](./misc/faq.md) * [Troubleshooting](./misc/troubleshooting.md) * [Telemetry](./misc/telemetry.md) -## 🌻 Contributing to Garden +## 🌳 Contributing to Garden * [Contributor Covenant Code of Conduct](./contributing/CODE_OF_CONDUCT.md) * [Contributing to the Docs](./contributing/contributing-docs.md) diff --git a/docs/garden-seeds/README.md b/docs/garden-seeds/README.md deleted file mode 100644 index d6ab78c845..0000000000 --- a/docs/garden-seeds/README.md +++ /dev/null @@ -1,4 +0,0 @@ ---- -title: Garden Seeds -order: 13 ---- diff --git a/docs/garden-seeds/about.md b/docs/garden-seeds/about.md deleted file mode 100644 index a4c0228762..0000000000 --- a/docs/garden-seeds/about.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -title: About -order: 1 ---- -This section walks you through using Garden with various development tools and programming languages. Our main focus with this section is to provide practical examples and guides that help you effectively leverage the power of Garden. 🚀 - -Following our Garden Seeds, you'll learn how to streamline your development process, improve efficiency, and quickly build robust applications ✨. - -## Languages - -In [Languages](./languages/README.md), you'll find various examples and guides tailored to specific coding languages. Whether you're a Pythonista, a Gopher, or working with other programming languages, we've got you covered! - -These seeds offer clear explanations and code samples to help you integrate Garden into your preferred language effortlessly. - -Our seeds offer language-specific, opinionated "Happy Paths". In just 5 minutes you'll slash your build and run test times and enjoy rebuild-free container development with Garden's Code Synchronization. - -## Tooling - -This section provides examples and guides for integrating Garden with popular development tools and platforms 🤖. - -From GitHub Actions to GitLab CI, we cover a range of tooling options to help you automate your workflows, deploy your applications, and optimize your environments. - -## Contribute - -If you have an idea for a new seed or would like to see improvements to existing ones, you can use our feature request template to share your suggestions. - -If you encounter any issues or bugs in the seeds, please report them in our main repository. Or [join our Discord](https://go.garden.io/discord) to talk to our devs or get help. diff --git a/docs/garden-seeds/languages/README.md b/docs/garden-seeds/languages/README.md deleted file mode 100644 index 335ce0d0df..0000000000 --- a/docs/garden-seeds/languages/README.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -title: Languages -order: 2 ---- - -Discover a variety of language-specific seeds tailored to your coding preferences. - -From Python 🐍 to Go and more, our seeds offer clear explanations and code samples. - -Each seed follows a consistent structure, making it easy to integrate Garden into your favorite language. - -From the sidebar, pick a language to quickly scaffold your Garden project and experience the power of Code Synchronization, -tests, and interactive dev mode. - -- [Go](./go.md) diff --git a/docs/garden-seeds/languages/go.md b/docs/garden-seeds/languages/go.md deleted file mode 100644 index 3f1386eb76..0000000000 --- a/docs/garden-seeds/languages/go.md +++ /dev/null @@ -1,91 +0,0 @@ -# Go 🌸 - -{% hint style="info" %} -If you encounter any issues or bugs 🐛 in this seed, don't hesitate to join our [Discord community](https://go.garden.io/discord) 🌸 for access to Garden's dedicated Community Engineers and our AI chatbot 🤖 trained on our docs. -{% endhint %} - -Go projects and compiled languages can run seamlessly on Garden, with fast image rebuilds as you type, cached tests and more deployed to any number of local and remote Kubernetes environments 🍃. - -This seed deploys a simple Go API using Helm and Garden to template our application and seamlessly deploy it to a local Kubernetes cluster ✅. - -In 5 minutes ⌛ you will deploy your own Go code into a Kubernetes cluster with a rebuild-free container using Garden's code synchronization. - -## Diagram 🖼️ - -This demo scaffolds a Helm chart we'll deploy to our Kubernetes cluster. - -![Quick diagram with tooling](https://ce-content.s3.fr-par.scw.cloud/golang-garden-recipe.png) - -## Prerequisites - -1. Install Garden CLI and get a Kubernetes cluster running locally by following our [quickstart guide](../../getting-started/quickstart.md) 🔎. -2. Ensure Python is available on your system and version 3.7 or higher by running `python --version`. MacOS and most Linux distributions will have Python already installed. Follow the official Python installation [guide](https://docs.python-guide.org/starting/installation/#installation-guides) if not. Python is required to scaffold the language seed. -3. If any of the terminology is unfamiliar, don't hesitate to contact our Community Engineering team over on [Discord](https://go.garden.io/discord) 💭. - -## TLDR - -Get your seed running in less than five minutes by running the following commands: - -{% tabs %} -{% tab title="macOS" %} - -````bash -brew install garden-io/garden/garden-cli -brew install cookiecutter -cookiecutter https://github.com/garden-io/go-seed.git -cookiecutter https://github.com/garden-io/go-seed.git # Answers the prompts to get your brand new repository -cd ${your-project-name} -garden deploy --sync -```` - -`garden deploy --sync` will take you to a REPL (Read, Eval, Print, Loop) interactive terminal where you can also run different commands like `test unit` which will run the `unit test` built for this HTTP API. - -If you want to get your test results with greater detail, use `get test-results unit.` - -{% endtab %} - -{% tab title="Linux" %} - -```sh -curl -sL https://get.garden.io/install.sh | bash -python3 -m pip install --user pipx -python3 -m pipx ensurepath # Reload your terminal after this step. -pipx install cookiecutter -cookiecutter https://github.com/garden-io/go-seed.git # Answers the prompts to get your brand new repository -cd ${your-project-name} -garden deploy --sync -``` - -`garden deploy --sync` will take you to a REPL (Read, Eval, Print, Loop) interactive terminal where you can also run different commands like `test unit` which will run the `unit test` built for this HTTP API. - -If you want to get your test results with greater detail, use `get test-results unit.` - -{% endtab %} - -{% endtabs %} - -If you would like to dive into the code used for this Garden Seed, check out our [go-seed repository](https://github.com/garden-io/go-seed/blob/main/README.md) - -## Conclusion 🔚 - -Congratulations 🎉 you have reached the end of this Garden seed. - -Because this project has Code Synchronization already configured, you can simply modify your `main.go` and observe changes live on the synced code path. - -![Test video](https://ce-content.s3.fr-par.scw.cloud/garden-go-seed.gif) - -## Next Steps ⏭️ - -Continue your Garden Journey. If you wish to learn more about Garden, here are a couple of resources you might find interesting: - -- Join our beautiful community on [Discord](https://go.garden.io/discord) 👋🏻. -- Give us a star in our [main repository](https://github.com/garden-io/garden) to show your support 💚. -- Read the [How Garden Works](../../overview/how-garden-works.md) page to understand the core concepts behind Garden. -- Read the [Helm Action configuration](../../reference/action-types/Deploy/helm.md) document to extend your Helm configuration within your new project. -- Extend your configuration by using a [Remote K8s environment](../../k8s-plugins/remote-k8s/README.md). - -## Contribute ➕ - -- Join our community on [Discord](https://go.garden.io/discord) 🎉 -- If you find any bugs 🐛 or have suggestions to improve our seeds, please don't hesitate to reach out by creating an [issue here](https://github.com/garden-io/garden/issues/new?assignees=&labels=&projects=&template=BUG_REPORT.md&title=) or by asking in our [Discord community](https://go.garden.io/discord)🌸 -- To vote on your favorite language/tool in our next Garden seed, create a Feature Request by clicking this [link](https://github.com/garden-io/garden/issues/new?assignees=&labels=feature+request&projects=&template=FEATURE_REQUEST.md&title=%5BFEATURE%5D%3A+).