-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
docs: update readme and techdocs (#8)
* docs: update readme * docs: update techdocs
- Loading branch information
Showing
2 changed files
with
38 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,3 +1,10 @@ | ||
**tsc-cli** | ||
**Homebrew Tap | TSC CLI** | ||
|
||
3 Sided Cube CLI | ||
A CLI util for internal use here at 3 Sided Cube. | ||
|
||
<br> | ||
|
||
**Resources:** | ||
|
||
- [TechDocs](https://backstage.idp.3sidedcube.com/docs/default/Component/tsc-cli) | ||
- [MKDocs](./docs) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,31 @@ | ||
**Documentation** | ||
# Getting Started | ||
|
||
Welcome to the `/docs` directory of this project! | ||
## Installation | ||
|
||
This folder contains all the necessary documentation to help you understand and contribute to the project effectively. | ||
```bash | ||
brew tap 3sidedcube/tap https://github.com/3sidedcube/tsc-cli.git | ||
|
||
brew install 3sidedcube/tap/tsc-cli | ||
``` | ||
|
||
## Usage | ||
|
||
### Migrate repo to GitHub | ||
|
||
If you intend to use repository auto-creation for a more seamless experience, you will need to create a fine-grained GitHub Personal Access Token (PAT). | ||
|
||
1. From your GitHub, `Settings > Developer settings > Personal access tokens > Fine-grained tokens > Generate new token`. | ||
2. Give it a name and set the owner to `3 Sided Cube` | ||
3. Set an expiration of `30 days` (recommended, you can rotate this easily). | ||
4. Optionally, give it a description. | ||
5. Select `All repositories` for repository access. | ||
6. Under repository permissions, set `Administration` to `read and write`. | ||
7. Create the token and keep it somewhere safe for now. | ||
|
||
```bash | ||
# Run this inside the root of the project that you're migrating to GitHub | ||
|
||
tsc-cli migrate github -c <repo_name> | ||
``` | ||
|
||
_Note: if this is youre first time running this command, you will be prompted to enter your GitHub Personal Access Token (PAT)._ |