This repository has been archived by the owner on Apr 12, 2021. It is now read-only.
-
-
Notifications
You must be signed in to change notification settings - Fork 41
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1509 from DashboardHub/v0.11.9
Deploy to production
- Loading branch information
Showing
22 changed files
with
57 additions
and
186 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
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
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
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
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
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
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
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
Empty file.
Empty file.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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 +1,3 @@ | ||
### Coming soon | ||
|
||
This page is coming soon :) |
File renamed without changes.
File renamed without changes.
File renamed without changes.
This file was deleted.
Oops, something went wrong.
Empty file.
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 |
---|---|---|
@@ -0,0 +1 @@ | ||
Open source is social coding! DashboardHub is all completely open and transparent, with not only the whole codebase available but also our project board and meeting notes. Driven by the community, you influence the features you want! |
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,50 +1,28 @@ | ||
# Get up and running in minutes without installing anything! | ||
# Get up and running in minutes in 3 simple steps and without installing anything! | ||
|
||
From the **DashboardHub** Team... | ||
> Thank you for showing an interest in **DashboardHub**. We are currently in an `ALPHA` stage, your feedback would be much appreciated. Feel free to create an [Issue](https://github.com/DashboardHub/PipelineDashboard/issues) on **GitHub** | ||
## 1. Log in | ||
## 1. Log in with GitHub | ||
|
||
Please log in with your GitHub account by clicking on the top right of the page. | ||
|
||
![Log in](https://user-images.githubusercontent.com/21239137/40269782-a1bad2b6-5b7a-11e8-8221-51298394317d.png) | ||
![Log in](https://user-images.githubusercontent.com/624760/64843082-68531780-d604-11e9-96f1-ab02eaa3aab9.png) | ||
|
||
## 2. Create an Environment | ||
## 2. Create a Project | ||
|
||
Once logged click on `Add Environment`. `Type` and `Title` are both required, other fields are optional, however we strongly recommend adding a logo url. | ||
Once logged click on `Add Project`. `name` and `type` are both required, other fields are optional, however we highly recommend filling them out, you can always update these later on. | ||
|
||
*Note: please read the `help` section on **environment types** to find out more* | ||
![Add project](https://user-images.githubusercontent.com/624760/64853131-0d78ea80-d61b-11e9-939d-cfd06c70502b.png) | ||
|
||
![Add environment](https://user-images.githubusercontent.com/21239137/40323918-c8ef32ea-5d2e-11e8-88c1-dfe00acf3787.png) | ||
Once successfully created, you will be redirected to the **Project Dashboard** page for that project. | ||
|
||
Once successfully created, you will be redirected to the **Overview** page for that environment. | ||
![Project dashboard page](https://user-images.githubusercontent.com/624760/64853209-39946b80-d61b-11e9-8fe2-553bda3dd272.png) | ||
|
||
![Environment overview page](https://user-images.githubusercontent.com/21239137/40324027-2040dd14-5d2f-11e8-823a-1b2e5bb78e68.png) | ||
## 3. Add repository | ||
|
||
The **Overview** page will show the information you have just used to create the **environment**, and a progress bar of the **pipeline** status. | ||
Click `Repositories` at the top right of the dashboard project, and a dialog will open to select your repositories that you wish to add to the project | ||
|
||
## 3. Beacon deploy / release data | ||
You don't need to install anything on your computer or server - simply beacon data with a `POST` request. | ||
![Repositories](https://user-images.githubusercontent.com/624760/64853566-ebcc3300-d61b-11e9-9c96-5ed75488596f.png) | ||
|
||
Our examples are using `curl`. Here is the template command: | ||
|
||
```bash | ||
curl -XPOST -H "Content-Type: application/json" -d '{ "release":"{RELEASE-VERSION}" }' \ | ||
https://api-pipeline.dashboardhub.io/environments/{ENVIRONMENT-ID}/deployed/{TOKEN-ID}/{PIPELINE-STATE} | ||
``` | ||
*Note: Use your release version. For example can append the TravisCI build number* | ||
|
||
However, **DashboardHub** generates the exact `curl` commands pre-populated with the relevant IDs and tokens to *beacon* the data to **DashboardHub**. Treat tokens as passwords. To access these commands, follow the steps below: | ||
|
||
1) Click the key icon on the top left of the page. | ||
|
||
![token icon](https://user-images.githubusercontent.com/21239137/40327650-99532336-5d3b-11e8-9dbe-e7fd40e9ada8.png) | ||
|
||
2) Click the green "example usage" button | ||
|
||
![example usage](https://user-images.githubusercontent.com/21239137/40327566-5b745292-5d3b-11e8-9490-84f88251716b.png) | ||
|
||
|
||
You will then see the exact commands, as below: | ||
|
||
![modal after example usage](https://user-images.githubusercontent.com/21239137/40327043-574dab20-5d39-11e8-9802-0cccd0b510be.png) | ||
Once you click `confirm`, you will see your project dashboard with the selected repositories *(note: it could take up to 30s to collect all the information for your repositories)* |
Empty file.
This file was deleted.
Oops, something went wrong.