Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add icons to sidebar #248

Merged
merged 1 commit into from Jan 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions community/contribute.mdx
@@ -1,6 +1,7 @@
---
title: Contributing
description: "This document describes the best way to get started with contributing to Shuttle"
icon: "code-pull-request"
---

Contributing to Shuttle is highly encouraged!
Expand Down
1 change: 1 addition & 0 deletions community/get-involved.mdx
@@ -1,5 +1,6 @@
---
title: "Get Involved"
icon: "hand-holding-hand"
---

If you are wondering what the best way is to get involved, here's how:
Expand Down
1 change: 1 addition & 0 deletions community/open-source.mdx
@@ -1,6 +1,7 @@
---
title: "Open Source"
description: "Shuttle is Open Source."
icon: "osi"
---

We are firm believers that Open Source is the key to a long-term sustainable and
Expand Down
1 change: 1 addition & 0 deletions configuration/ci-cd.mdx
@@ -1,6 +1,7 @@
---
title: "CI/CD"
description: "Tools for automating Shuttle deployments"
icon: "arrow-progress"
---

Shuttle currently provides one GitHub Action for automating deployments.
Expand Down
1 change: 1 addition & 0 deletions configuration/domain-names.mdx
@@ -1,6 +1,7 @@
---
title: Domain names
description: Add custom domains to your project
icon: "globe"
---

<Snippet file="pro-feature.mdx" />
Expand Down
1 change: 1 addition & 0 deletions configuration/environment.mdx
@@ -1,6 +1,7 @@
---
title: "Deployment environment"
description: "Details about the environment your app runs in."
icon: "box"
---

This page answers:
Expand Down
1 change: 1 addition & 0 deletions configuration/files.mdx
@@ -1,6 +1,7 @@
---
title: "Deployment files"
description: "How to handle files and folder for deployment"
icon: "file"
---

This page answers:
Expand Down
1 change: 1 addition & 0 deletions configuration/logs.mdx
@@ -1,6 +1,7 @@
---
title: "Logs"
description: "Tracing or logging in Shuttle apps."
icon: "list"
---

Shuttle will record anything your application writes to `stdout`, e.g. a `tracing` or `log` crate configured to write to `stdout`,
Expand Down
1 change: 1 addition & 0 deletions configuration/project-name.mdx
@@ -1,6 +1,7 @@
---
title: Project name
description: How Shuttle project names work
icon: "signature"
---

Your Shuttle Project Name determines which subdomain your project is hosted on (`https://<project-name>.shuttleapp.rs/`).
Expand Down
1 change: 1 addition & 0 deletions configuration/project-structure.mdx
@@ -1,6 +1,7 @@
---
title: Project structure
description: Cargo workspaces and custom binary names
icon: "folder-tree"
---

This page describes what Shuttle expects from your project structure, how it handles cargo workspaces, and how to use a custom binary name.
Expand Down
1 change: 1 addition & 0 deletions configuration/shuttle-versions.mdx
@@ -1,6 +1,7 @@
---
title: "Shuttle versions"
description: "How Shuttle versioning works"
icon: "code-merge"
---

- When you start or restart a project, a Shuttle `deployer` Docker container is started with the [latest released](https://github.com/shuttle-hq/shuttle/releases) version of Shuttle.
Expand Down
1 change: 1 addition & 0 deletions getting-started/idle-projects.mdx
@@ -1,5 +1,6 @@
---
title: "Idle Projects"
icon: "clock"
---

To help handle the load of our users, and to help them save on compute costs (Pro tier),
Expand Down
1 change: 1 addition & 0 deletions getting-started/installation.mdx
@@ -1,5 +1,6 @@
---
title: "Installation"
icon: "wrench"
---

## Install Shuttle
Expand Down
1 change: 1 addition & 0 deletions getting-started/local-run.mdx
@@ -1,6 +1,7 @@
---
title: "Local Run"
description: "Test your Shuttle app on your local system"
icon: "code"
---

We will assume that you have already initialized a project. If you haven't, you should
Expand Down
1 change: 1 addition & 0 deletions getting-started/quick-start.mdx
@@ -1,5 +1,6 @@
---
title: "Quick Start"
icon: "rabbit-running"
---

We will assume that you have already installed Shuttle and logged in.
Expand Down
1 change: 1 addition & 0 deletions getting-started/shuttle-commands.mdx
@@ -1,5 +1,6 @@
---
title: "Command Line Interface"
icon: "terminal"
---

Interaction with the Shuttle services is mainly done with through the `cargo-shuttle` Command Line Interface (CLI).
Expand Down
1 change: 1 addition & 0 deletions introduction/how-shuttle-works.mdx
@@ -1,5 +1,6 @@
---
title: "How Shuttle works"
icon: "puzzle-piece"
---

The simplest way to build and deploy a web app on Shuttle looks like this:
Expand Down
1 change: 1 addition & 0 deletions introduction/welcome.mdx
@@ -1,6 +1,7 @@
---
title: "Welcome"
description: "Shuttle is a Rust-native cloud development platform that lets you deploy your Rust apps for free."
icon: "hand-wave"
---

<CardGroup>
Expand Down
1 change: 1 addition & 0 deletions introduction/what-is-shuttle.mdx
@@ -1,6 +1,7 @@
---
title: "What is Shuttle?"
description: "Shuttle is a Rust-native cloud development platform that lets you deploy your app while also taking care of all of your infrastructure."
icon: "question"
---

![](/images/infra-from-code.gif)
Expand Down
1 change: 1 addition & 0 deletions resources/custom-resources.mdx
@@ -1,5 +1,6 @@
---
title: "Custom Resources"
icon: "toolbox"
---

This example shows how you can make a custom resource.
Expand Down
1 change: 1 addition & 0 deletions resources/overview.mdx
@@ -1,5 +1,6 @@
---
title: "Overview"
icon: "face-monocle"
---

The next sections go over one by one the resources currently supported by Shuttle. In broad terms, for the resource needed, simply mark up your code with the appropriate annotation. This is very powerful and brings several benefits:
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-aws-rds.mdx
@@ -1,5 +1,6 @@
---
title: "Shuttle AWS RDS"
icon: "aws"
---

<Snippet file="pro-feature.mdx" />
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-metadata.mdx
@@ -1,5 +1,6 @@
---
title: Metadata
icon: "gear-code"
---

The metadata plugin allows applications to obtain certain information about their runtime environment.
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-persist.mdx
@@ -1,5 +1,6 @@
---
title: "Shuttle Persist"
icon: "key"
---

The persist plugin allows data to be persisted in a key-value store, which is backed by a struct type. The struct implements `serde::Serialize` for serialization (prepare data for saving or transmission) and `serde::Deserialize` for deserialization (load data to memory, either from storage or fetched via the network). The persist plugin is useful for saving and retrieving data when it is not desired to hard code that data into the app. An example is saved settings for a Discord bot that need to remain the same between updates. State data, used in web frameworks such as Axum and Rocket, is also a good candidate for use of the persist plugin.
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-secrets.mdx
@@ -1,6 +1,7 @@
---
title: Secrets
description: Including secrets in your deployment
icon: "user-secret"
---

This plugin manages secrets on [Shuttle](https://www.shuttle.rs).
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-shared-db.mdx
@@ -1,5 +1,6 @@
---
title: "Shuttle Shared Databases"
icon: "share"
---

This plugin manages databases on [Shuttle](https://www.shuttle.rs) and connects them to your app. A shared database
Expand Down
1 change: 1 addition & 0 deletions resources/shuttle-turso.mdx
@@ -1,5 +1,6 @@
---
title: "Shuttle Turso"
icon: "database"
---

This plugin allows services to connect to a [Turso](https://turso.tech) database. Turso is an edge-hosted distributed database based on libSQL, a SQLite fork.
Expand Down
1 change: 1 addition & 0 deletions support/delete-project.mdx
@@ -1,6 +1,7 @@
---
title: Delete project
description: How to delete projects, and how to solve common issues
icon: "trash-can"
---

<Warning>Deleting old projects can fail due to outdated or corrupt data. If you have tried all the steps below, but they keep failing or if a resource refuses to be deleted, please contact us on *support@shuttle.rs* from the email associated with your GitHub account. There, we can assist you with manually deleting projects.</Warning>
Expand Down
1 change: 1 addition & 0 deletions support/faq.mdx
@@ -1,5 +1,6 @@
---
title: "Frequently Asked Questions"
icon: "comment-question"
---

This section is aimed at collecting common questions users have to provide documented answers.
Expand Down
1 change: 1 addition & 0 deletions support/troubleshooting.mdx
@@ -1,5 +1,6 @@
---
title: "Troubleshooting"
icon: "bug"
---

This section is aimed at collecting common issues users have to provide quick debug solutions.
Expand Down