add more cookbook docs

fluent-ci-templates · Jul 28, 2024 · 514f9f2 · 514f9f2
1 parent 60b0474
commit 514f9f2
Show file tree

Hide file tree

Showing 94 changed files with 477 additions and 103 deletions.
diff --git a/docs/tutorial-extras/_category_.json → docs/cookbook/_category_.json b/docs/tutorial-extras/_category_.json → docs/cookbook/_category_.json
diff --git a/docs/tutorial-extras/build-bun.md → docs/cookbook/build-bun.md b/docs/tutorial-extras/build-bun.md → docs/cookbook/build-bun.md
diff --git a/docs/tutorial-extras/build-containers.md → docs/cookbook/build-containers.md b/docs/tutorial-extras/build-containers.md → docs/cookbook/build-containers.md
diff --git a/docs/tutorial-extras/build-deno.md → docs/cookbook/build-deno.md b/docs/tutorial-extras/build-deno.md → docs/cookbook/build-deno.md
diff --git a/docs/tutorial-extras/build-flutter.md → docs/cookbook/build-flutter.md b/docs/tutorial-extras/build-flutter.md → docs/cookbook/build-flutter.md
diff --git a/docs/tutorial-extras/build-gleam.md → docs/cookbook/build-gleam.md b/docs/tutorial-extras/build-gleam.md → docs/cookbook/build-gleam.md
diff --git a/docs/tutorial-extras/build-go.md → docs/cookbook/build-go.md b/docs/tutorial-extras/build-go.md → docs/cookbook/build-go.md
diff --git a/docs/tutorial-extras/build-java.md → docs/cookbook/build-java.md b/docs/tutorial-extras/build-java.md → docs/cookbook/build-java.md
diff --git a/docs/tutorial-extras/build-nodejs.md → docs/cookbook/build-nodejs.md b/docs/tutorial-extras/build-nodejs.md → docs/cookbook/build-nodejs.md
diff --git a/docs/tutorial-extras/build-php.md → docs/cookbook/build-php.md b/docs/tutorial-extras/build-php.md → docs/cookbook/build-php.md
diff --git a/docs/tutorial-extras/build-rust.md → docs/cookbook/build-rust.md b/docs/tutorial-extras/build-rust.md → docs/cookbook/build-rust.md
diff --git a/docs/cookbook/build-vm-images-with-packer.md b/docs/cookbook/build-vm-images-with-packer.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 11
+---
+
+# Build VM images with Packer
+
+[Packer](https://www.packer.io) is an open source tool for creating identical Virtual Machine (VM) images for multiple platforms from a single source configuration. This page explains how to use Packer and FluentCI to create a VM image.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Packer`. In addition:
+
+- Have your source code including the [Packer template](https://www.packer.io/docs/templates) handy.
+
+## Using the Packer Plugin
+
+You can use FluentCI to build VM images using the [packer plugin](https://github.com/fluentci-io/packer-plugin), no need to install Packer on your machine, FluentCI will handle everything for you.
+
+The following command can be used to build VM image with Packer:
+
+```bash
+fluenci run --wasm packer fmt
+fluenci run --wasm packer validate
+fluenci run --wasm packer build
+```
diff --git a/docs/tutorial-extras/build-zig.md → docs/cookbook/build-zig.md b/docs/tutorial-extras/build-zig.md → docs/cookbook/build-zig.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 11
+sidebar_position: 12
 ---
 
 # Build and test Zig applications

diff --git a/docs/tutorial-extras/deploy-to-cloudflare.md → docs/cookbook/deploy-to-cloudflare.md b/docs/tutorial-extras/deploy-to-cloudflare.md → docs/cookbook/deploy-to-cloudflare.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 12
+sidebar_position: 13
 ---
 
 # Deploy to Cloudflare

diff --git a/docs/tutorial-extras/deploy-to-firebase.md → docs/cookbook/deploy-to-firebase.md b/docs/tutorial-extras/deploy-to-firebase.md → docs/cookbook/deploy-to-firebase.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 13
+sidebar_position: 14
 ---
 
 # Deploy to Firebase

diff --git a/docs/tutorial-extras/deploy-to-fly.md → docs/cookbook/deploy-to-fly.md b/docs/tutorial-extras/deploy-to-fly.md → docs/cookbook/deploy-to-fly.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 14
+sidebar_position: 15
 ---
 
 # Deploy to Fly.io

diff --git a/docs/tutorial-extras/deploy-to-heroku.md → docs/cookbook/deploy-to-heroku.md b/docs/tutorial-extras/deploy-to-heroku.md → docs/cookbook/deploy-to-heroku.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 15
+sidebar_position: 16
 ---
 
 # Deploy to Heroku

diff --git a/docs/tutorial-extras/deploy-to-netlify.md → docs/cookbook/deploy-to-netlify.md b/docs/tutorial-extras/deploy-to-netlify.md → docs/cookbook/deploy-to-netlify.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 16
+sidebar_position: 17
 ---
 
 # Deploy to Netlify

diff --git a/docs/tutorial-extras/deploy-to-railway.md → docs/cookbook/deploy-to-railway.md b/docs/tutorial-extras/deploy-to-railway.md → docs/cookbook/deploy-to-railway.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 17
+sidebar_position: 18
 ---
 
 # Deploy to Railway

diff --git a/docs/cookbook/deploy-to-shuttle.md b/docs/cookbook/deploy-to-shuttle.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 19
+---
+
+# Deploy to Shuttle
+
+This page explains how to deploy applications to Shuttle using FluentCI.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Shuttle`. In addition:
+
+- Have your Shuttle project ready.
+- If you don't already have a project to deploy to Shuttle, you can create a default project by [installing and initializing Shuttle](https://docs.shuttle.rs/getting-started/installation).
+
+## Using the Shuttle Plugin
+
+You can use FluentCI to deploy applications to Shuttle using the [shuttle plugin](https://github.com/fluent-ci-templates/shuttle-pipeline), no need to install Shuttle CLI on your machine, FluentCI will handle everything for you.
+
+The following commands can be used to deploy applications to Shuttle:
+
+```bash
+# Deploy to Shuttle, make sure to export SHUTTLE_API_KEY
+fluentci run --wasm shuttle deploy
+```
diff --git a/docs/cookbook/deploy-to-spin.md b/docs/cookbook/deploy-to-spin.md
@@ -0,0 +1,26 @@
+---
+sidebar_position: 20
+---
+
+# Deploy to Fermyon Cloud
+
+This page explains how to deploy applications to Fermyon CLoud using FluentCI.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Fermyon Cloud`. In addition:
+
+- Have your Spin project ready.
+- If you don't already have a project to deploy to Fermyon Cloud, you can create a default project by [installing and initializing Spin](https://developer.fermyon.com/cloud/quickstart).
+
+## Using the Spin Plugin
+
+You can use FluentCI to deploy applications to Fermyon Cloud using the [spin plugin](https://github.com/fluent-ci-templates/spin-pipeline), no need to install Spin CLI on your machine, FluentCI will handle everything for you.
+
+The following commands can be used to deploy applications to Fermyon Cloud:
+
+```bash
+# Deploy to Fermyon Cloud, make sure to export SPIN_AUTH_TOKEN
+fluentci run --wasm spin build
+fluentci run --wasm spin deploy
+```
diff --git a/docs/cookbook/deploy-to-wasmer.md b/docs/cookbook/deploy-to-wasmer.md
@@ -0,0 +1,26 @@
+---
+sidebar_position: 21
+---
+
+# Deploy to Wasmer Edge
+
+This page explains how to deploy applications to Wasmer Edge using FluentCI.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Wasmer`. In addition:
+
+- Have your Wasmer project ready.
+- If you don't already have a project to deploy to Wasmer Edge, you can create a default project by [installing and initializing Wasmer](https://docs.wasmer.io/edge/get-started).
+
+## Using the Wasmer Plugin
+
+You can use FluentCI to deploy applications to Wasmer Edge using the [wasmer plugin](https://github.com/fluent-ci-templates/wasmer-pipeline), no need to install Wasmer CLI on your machine, FluentCI will handle everything for you.
+
+The following commands can be used to deploy applications to Wasmer Edge:
+
+```bash
+fluentci run --wasm wasmer build
+# Deploy to Wasmer Edge, make sure to export WASMER_TOKEN
+fluentci run --wasm wasmer deploy
+```
diff --git a/...torial-extras/img/docsVersionDropdown.png → docs/cookbook/img/docsVersionDropdown.png b/...torial-extras/img/docsVersionDropdown.png → docs/cookbook/img/docsVersionDropdown.png
diff --git a/docs/tutorial-extras/img/localeDropdown.png → docs/cookbook/img/localeDropdown.png b/docs/tutorial-extras/img/localeDropdown.png → docs/cookbook/img/localeDropdown.png
diff --git a/docs/cookbook/provision-with-pulumi.md b/docs/cookbook/provision-with-pulumi.md
@@ -0,0 +1,29 @@
+---
+sidebar_position: 22
+---
+
+# Provision with Pulumi
+
+This page explains how to provision infrastructure using [Pulumi](https://pulumi.com) with FluentCI.
+
+Pulumi is an infrastructure-as-code (IaC) tool that lets you provision and manage cloud infrastructure. Pulumi provides plugins called providers that let you interact with cloud providers and other APIs.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Pulumi`. In addition:
+
+- Have your Pulumi project ready.
+- If you don't already have a project to provision with Pulumi, you can create a default project by [installing and initializing Pulumi](https://www.pulumi.com/docs/install/).
+- Make sure you have a `Pulumi.yaml` file in your project root directory.
+- Make sure you have a `Pulumi.dev.yaml` file in your project root directory.
+
+## Using the Pulumi Plugin
+
+You can use FluentCI to provision infrastructure using Pulumi with the [pulumi plugin](https://github.com/fluent-ci-templates/pulumi-pipeline) without installing Pulumi CLI on your machine. FluentCI will handle everything for you.
+
+The following commands can be used to provision infrastructure using Pulumi:
+
+```bash
+fluentci run --wasm pulumi init
+fluentci run --wasm pulumi up
+```
diff --git a/docs/cookbook/provision-with-terraform.md b/docs/cookbook/provision-with-terraform.md
@@ -0,0 +1,29 @@
+---
+sidebar_position: 23
+---
+
+# Provision with Terraform
+
+This page explains how to provision infrastructure using [Terraform](https://terraform.io) with FluentCI.
+
+HashiCorp Terraform is an infrastructure-as-code (IaC) tool that lets you provision and manage cloud infrastructure. Terraform provides plugins called providers that let you interact with cloud providers and other APIs.
+
+## Before you begin
+
+The instructions on this page assume that you are familiar with `Terraform`. In addition:
+
+- Have your Terraform project ready.
+- If you don't already have a project to provision with Terraform, you can create a default project by [installing and initializing Terraform](https://developer.hashicorp.com/terraform/tutorials/aws-get-started/install-cli).
+- Make sure you have a `main.tf` file in your project root directory.
+
+## Using the Terraform Plugin
+
+You can use FluentCI to provision infrastructure using Terraform with the [terraform plugin](https://github.com/fluent-ci-templates/terraform-pipeline) without installing Terraform CLI on your machine. FluentCI will handle everything for you.
+
+The following commands can be used to provision infrastructure using Terraform:
+
+```bash
+fluentci run --wasm terraform init
+fluentci run --wasm terraform plan
+fluentci run --wasm terraform apply
+```
diff --git a/docs/tutorial-extras/upload-to-codecov.md → docs/cookbook/upload-to-codecov.md b/docs/tutorial-extras/upload-to-codecov.md → docs/cookbook/upload-to-codecov.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 18
+sidebar_position: 24
 ---
 
 # Upload Coverage to Codecov

diff --git a/...orial-extras/upload-to-github-releases.md → docs/cookbook/upload-to-github-releases.md b/...orial-extras/upload-to-github-releases.md → docs/cookbook/upload-to-github-releases.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 19
+sidebar_position: 25
 ---
 
 # Upload assets to GitHub 

diff --git a/docs/tutorial-extras/upload-to-gitlab.md → docs/cookbook/upload-to-gitlab.md b/docs/tutorial-extras/upload-to-gitlab.md → docs/cookbook/upload-to-gitlab.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 20
+sidebar_position: 26
 ---
 
 # Upload assets to GitLab Releases

diff --git a/docs/tutorial-extras/upload-to-r2.md → docs/cookbook/upload-to-r2.md b/docs/tutorial-extras/upload-to-r2.md → docs/cookbook/upload-to-r2.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 21
+sidebar_position: 27
 ---
 
 # Upload files to Cloudflare R2

diff --git a/docs/tutorial-extras/upload-to-s3.md → docs/cookbook/upload-to-s3.md b/docs/tutorial-extras/upload-to-s3.md → docs/cookbook/upload-to-s3.md
@@ -1,5 +1,5 @@
 ---
-sidebar_position: 22
+sidebar_position: 28
 ---
 
 # Upload files to AWS S3

diff --git a/docs/examples/_category_.json b/docs/examples/_category_.json
@@ -1,6 +1,6 @@
 {
   "label": "Examples",
-  "position": 5,
+  "position": 6,
   "link": {
     "type": "generated-index"
   }

diff --git a/docs/examples/deploy/chromatic.md b/docs/examples/deploy/chromatic.md
@@ -28,7 +28,7 @@ fluentci run chromatic_pipeline publish
 You can also use this pipeline programmatically:
 
 ```typescript
-import { publish } from "https://pkg.fluentci.io/chromatic_pipeline@v0.6.0/mod.ts";
+import { publish } from "jsr:@fluentci/chromatic";
 
 await publish();
 ```
diff --git a/docs/examples/deploy/cloudflare.md b/docs/examples/deploy/cloudflare.md
@@ -28,7 +28,7 @@ fluentci run cloudflare_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from "https://pkg.fluentci.io/cloudflare_pipeline@v0.6.0/mod.ts";
+import { deploy } from from "jsr:@fluentci/chromatic";
 
 await deploy();
 

diff --git a/docs/examples/deploy/deno.md b/docs/examples/deploy/deno.md
@@ -24,7 +24,7 @@ fluentci run deno_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```ts
-import { fmt, lint, test } from "https://deno.land/x/deno_pipeline/mod.ts";
+import { fmt, lint, test } from "jsr:@fluentci/deno";
 
 await fmt();
 await lint();

diff --git a/docs/examples/deploy/fly.md b/docs/examples/deploy/fly.md
@@ -27,7 +27,7 @@ fluentci run fly_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from "https://pkg.fluentci.io/fly_pipeline@v0.5.1/mod.ts";
+import { deploy } from "jsr:@fluentci/fly";
 
 await deploy();
 ```
diff --git a/docs/examples/deploy/heroku.md b/docs/examples/deploy/heroku.md
@@ -28,7 +28,7 @@ fluentci run heroku_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from "https://pkg.fluentci.io/heroku_pipeline@v0.6.0/mod.ts";
+import { deploy } from "jsr:@fluentci/heroku";
 
 await deploy();
 ```
diff --git a/docs/examples/deploy/netlify.md b/docs/examples/deploy/netlify.md
@@ -29,7 +29,7 @@ fluentci run netlify_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { build, deploy } from "https://pkg.fluentci.io/netlify_pipeline@v0.6.0/mod.ts";
+import { build, deploy } from "jsr:@fluentci/netlify";
 
 await build();
 await deploy();

diff --git a/docs/examples/deploy/railway.md b/docs/examples/deploy/railway.md
@@ -27,7 +27,7 @@ fluentci run railway_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from "https://pkg.fluentci.io/railway_pipeline@v0.6.0/mod.ts";
+import { deploy } from "jsr:@fluentci/railway";
 
 await deploy();
 ```
diff --git a/docs/examples/deploy/shuttle.md b/docs/examples/deploy/shuttle.md
@@ -26,7 +26,7 @@ fluentci run shuttle_pipeline deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { deploy } from "https://pkg.fluentci.io/shuttle_pipeline@v0.6.0/mod.ts";
+import { deploy } from "jsr:@fluentci/shuttle";
 
 await deploy();
 ```
diff --git a/docs/examples/deploy/spin.md b/docs/examples/deploy/spin.md
@@ -28,7 +28,7 @@ fluentci run spin_pipeline build deploy
 You can also use this pipeline programmatically:
 
 ```typescript
-import { build, deploy } from "https://pkg.fluentci.io/spin_pipeline@v0.6.0/mod.ts";
+import { build, deploy } from "jsr:@fluentci/spin";
 
 await build();
 await deploy();

diff --git a/docs/examples/languages/bun.md b/docs/examples/languages/bun.md
@@ -43,7 +43,7 @@ fluentci
 You can also use this pipeline programmatically:
 
 ```ts
-import { test } from "https://pkg.fluentci.io/bun_pipeline@v0.3.0/mod.ts";
+import { test } from "jsr:@fluentci/bun";
 
 await test();
 ```
diff --git a/docs/examples/languages/clojure.md b/docs/examples/languages/clojure.md
@@ -38,7 +38,7 @@ fluentci run .
 You can also use this pipeline programmatically:
 
 ```ts
-import { test, uberjar } from "https://pkg.fluentci.io/clojure_pipeline@v0.4.0/mod.ts";
+import { test, uberjar } from "jsr:@fluentci/clojure";
 
 await test();
 await uberjar();

diff --git a/docs/examples/languages/deno.md b/docs/examples/languages/deno.md
@@ -50,7 +50,7 @@ fluentci run .
 You can also use this pipeline programmatically:
 
 ```ts
-import { fmt, lint, test } from "https://deno.land/x/deno_pipeline/mod.ts";
+import { fmt, lint, test } from from "jsr:@fluentci/deno";
 
 await fmt();
 await lint();

diff --git a/docs/examples/languages/elixir.md b/docs/examples/languages/elixir.md
@@ -37,7 +37,7 @@ fluentci run .
 You can also use this pipeline programmatically:
 
 ```ts
-import { test } from "https://pkg.fluentci.io/elixir_pipeline@v0.6.0/mod.ts";
+import { test } from "jsr:@fluentci/elixir";
 
 await test();
 ```
diff --git a/docs/examples/languages/gleam.md b/docs/examples/languages/gleam.md
@@ -47,7 +47,7 @@ fluentci
 You can also use this pipeline programmatically:
 
 ```ts
-import { check, format, test, build } from "https://pkg.fluentci.io/gleam_pipeline@v0.4.0/mod.ts";
+import { check, format, test, build } from "jsr:@fluentci/gleam";
 
 await check();
 await format();

diff --git a/docs/examples/languages/go.md b/docs/examples/languages/go.md
@@ -39,7 +39,7 @@ fluentci run .
 You can also use this pipeline programmatically:
 
 ```ts
-import { fmt, test, build } from "https://pkg.fluentci.io/go_pipeline@v0.6.0/mod.ts";
+import { fmt, test, build } from "jsr:@fluentci/go";
 
 await fmt();
 await test();