95 lines
1.9 KiB
Markdown
95 lines
1.9 KiB
Markdown
# Getting Started
|
|
|
|
This guide explains how to start using `cautious-journey` to manage project and issue labels.
|
|
|
|
## Contents
|
|
|
|
- [Getting Started](#getting-started)
|
|
- [Contents](#contents)
|
|
- [Setup](#setup)
|
|
- [Installing](#installing)
|
|
- [Running](#running)
|
|
- [Configuring](#configuring)
|
|
- [Labels](#labels)
|
|
- [Flag Labels](#flag-labels)
|
|
- [State Labels](#state-labels)
|
|
- [Projects](#projects)
|
|
- [Configuring Multiple Projects](#configuring-multiple-projects)
|
|
- [Running Select Projects](#running-select-projects)
|
|
- [Remotes](#remotes)
|
|
- [Copying Project Remotes](#copying-project-remotes)
|
|
- [Commands](#commands)
|
|
- [Sync Labels](#sync-labels)
|
|
- [Sync Issues](#sync-issues)
|
|
- [Transitions](#transitions)
|
|
- [Flag Transitions](#flag-transitions)
|
|
- [State Transitions](#state-transitions)
|
|
|
|
## Setup
|
|
|
|
### Installing
|
|
|
|
TODO: how would you install the app?
|
|
|
|
### Running
|
|
|
|
TODO: how would you run the app?
|
|
|
|
### Configuring
|
|
|
|
TODO: how would you configure the app?
|
|
|
|
## Labels
|
|
|
|
TODO: what are labels? what kinds of labels do we support?
|
|
|
|
### Flag Labels
|
|
|
|
TODO: what are flag labels?
|
|
|
|
### State Labels
|
|
|
|
TODO: what are state labels?
|
|
|
|
## Projects
|
|
|
|
TODO: what are projects? how are they managed? how do you pick which projects to run?
|
|
|
|
### Configuring Multiple Projects
|
|
|
|
TODO: how would you configure the app to run for multiple projects?
|
|
|
|
### Running Select Projects
|
|
|
|
TODO: how would you run a single project, or a subset?
|
|
|
|
## Remotes
|
|
|
|
TODO: what are remotes? how are they configured?
|
|
|
|
### Copying Project Remotes
|
|
|
|
TODO: how would you share a remote config block between two projects?
|
|
|
|
## Commands
|
|
|
|
TODO: what commands are present?
|
|
|
|
### Sync Labels
|
|
|
|
TODO: what happens when you sync the project labels?
|
|
|
|
### Sync Issues
|
|
|
|
TODO: what happens when you sync the issue labels?
|
|
|
|
## Transitions
|
|
|
|
### Flag Transitions
|
|
|
|
TODO: how are flag labels added and removed?
|
|
|
|
### State Transitions
|
|
|
|
TODO: how are state labels added and removed?
|