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 projects guide #541

Open
wants to merge 8 commits into
base: main
Choose a base branch
from
Open
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
71 changes: 71 additions & 0 deletions developers/guides/managing-projects.mdx
@@ -0,0 +1,71 @@
---
title: "Managing Projects"
description:
"Explore best practices for managing multiple environments in Livepeer Studio"
---

![Create a project](/images/project-creation.png)

## Overview

Projects in Livepeer Studio allow for the organization of streaming assets, API
keys, and usage within dedicated environments. This feature is crucial for
separating staging and production environments, managing multiple applications,
and ensuring efficient workflow within a single account.

## Why Use Projects?

- **Separation of Environments**: Keep your staging and production environments
separate to avoid conflicts and ensure reliable testing.
- **Centralized Management for Multiple Applications**: Instead of juggling
multiple accounts, you can build and manage separate applications from within
the same account. This is ideal for developers and companies that operate
multiple apps or brands and wish to streamline their management in one place.

## Getting Started with Projects

### Creating a New Project

To start building with separate environments or applications, you'll need to
create a new project. Here's how:

1. In the sidebar, click on the project dropdown at the top of the menu.
2. Choose **+ New project** from the dropdown list.
3. Enter a name for your new project when prompted.
4. Confirm the creation to set up your new environment.

### Deleting a Project

<Warning>
Deletion of a project is a final action that cannot be undone. All streams,
assets, and API keys associated with the project will be permanently erased.
</Warning>

#### Recommended Pre-Deletion Steps:

1. **Backup**: Confirm that you have secured backups of all essential data.
2. **Verification:** Ensure that the project is no longer in use and all
necessary migrations have been completed.

#### Deletion Steps:

1. Navigate to the **Settings** option in the project's sidebar to access the
detailed settings view.
2. Scroll down to find the Delete Project section.
3. Click on the **Delete** button.
4. As a safety measure, you will be prompted to type in the name of the project
to confirm your intent to delete.
5. After typing the name, proceed by confirming the deletion.

### Renaming a Project

1. Within a project, navigate to the **Settings** section in the sidebar.
2. Find the project name field, make your changes, and save.

## Conclusion

With the introduction of Projects, Livepeer Studio provides you with a powerful
way to manage your application's live and on-demand streams. By leveraging the
ability to create separate projects for staging and production, you can
streamline your workflows and ensure a clean separation of your streaming
environments.
Binary file added images/project-creation.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.