diff --git a/docs/platform/tutorials/computer-vision/get-project.md b/docs/platform/tutorials/computer-vision/get-project.md index 3a7639c2..2526146f 100644 --- a/docs/platform/tutorials/computer-vision/get-project.md +++ b/docs/platform/tutorials/computer-vision/get-project.md @@ -21,6 +21,12 @@ The key ideas on this page: * Pipeline view of project * Synchronizing an environment +## Watch a video + +This video shows you how to fork the template project and create your project in Quix: + +
+ ## Fork the project repository Quix provides the computer vision template project as a [public GitHub repository](https://github.com/quixio/computer-vision-demo){target="_blank"}. If you want to use this template as a starting point for your own project, then the best way to accomplish this is to fork the project. Using fork enables you to create a complete copy of the project, but also benefit from future bug fixes and improvements by using the upstream changes. @@ -37,6 +43,8 @@ To fork the repository: ## Create your Quix project +You can watch a video on how to create the project + Now that you have a forked copy of the repository in your GitHub account, you can now link your Quix account to it. Doing this enables you to build and deploy the project in your Quix account, and examine the pipeline much more closely. To link Quix to this forked repository: @@ -86,14 +94,6 @@ Now create an environment called `Tutorial` which uses the `tutorial` branch: 2. Select the `tutorial` branch from the dropdown. - Make sure the branch is protected, as shown in the following screenshot: - - ![Protected branch](./images/protected-branch.png){width=70%} - - !!! tip - - Making a branch protected ensures that developers cannot commit directly into the branch. Developers have to raise pull requests (PRs), which need to be approved before they can be merged into the protected branch. - 3. Click `Continue` and then select the Quix Broker and Standard storage options to complete creation of the environment, and the project. 4. Go to the pipeline view. You will see that Quix is out of sync with the repository. @@ -119,6 +119,10 @@ Create a new secret that contains your TfL API key. Now link that secret to the [Read more about environment variables and secret management](../../how-to/environment-variables.md). +Watch the video: + +
+ ### Web UI service Note if you just want to try out the UI without performing the following steps, you can do that in the [demo](https://app-demo-computervisiondemo-prod.deployments.quix.ai/){target=_blank}. @@ -129,7 +133,11 @@ Once you have your PAT copied to the clipboard, create a new secret to contain i [Read more about environment variables and secret management](../../how-to/environment-variables.md). -Other optional services may require similar configuration, for example, the Quix Amazon S3 connector service requires your S3 credentials if you want to use it. +Watch the video: + +
+ +#### Google Maps API key When testing the UI you see "For development purposes only" displayed on the map. Optionally, if you have a Google Maps API key, you can avoid this. @@ -139,6 +147,10 @@ To add your own Google Maps API key you need to edit `src/app/app.module.ts` and AgmCoreModule.forRoot({apiKey: ''}), ``` +### Other services + +Other optional services may require similar configuration, for example, the Quix Amazon S3 connector service requires your S3 credentials if you want to use it. + ## See also If you are new to Quix it is worth reviewing the [recent changes page](../../changes.md), as that contains very useful information about the significant recent changes, and also has a number of useful videos you can watch to gain familiarity with Quix. diff --git a/docs/platform/tutorials/sentiment-analysis/get-project.md b/docs/platform/tutorials/sentiment-analysis/get-project.md index 3875d7ad..dc83f401 100644 --- a/docs/platform/tutorials/sentiment-analysis/get-project.md +++ b/docs/platform/tutorials/sentiment-analysis/get-project.md @@ -21,6 +21,10 @@ The key ideas on this page: * Pipeline view of project * Synchronizing an environment +## Watch a video + +The computer vision tutorial has a [video on forking and creating the project](../computer-vision/get-project.md#watch-a-video). This is the same process as is used for the sentiment analysis project. + ## Fork the project repository Quix provides the computer vision template project as a [public GitHub repository](https://github.com/quixio/chat-demo-app){target="_blank"}. If you want to use this template as a starting point for your own project, then the best way to accomplish this is to fork the project. Using fork enables you to create a complete copy of the project, but also benefit from future bug fixes and improvements by using the upstream changes. @@ -86,12 +90,6 @@ Now create an environment called `Tutorial` which uses the `tutorial` branch: 2. Select the `tutorial` branch from the dropdown. - Make sure the branch is protected, by making sure the `This branch is protected` checkbox is selected. - - !!! tip - - Making a branch protected ensures that developers cannot commit directly into the branch. Developers have to raise pull requests (PRs), which need to be approved before they can be merged into the protected branch. - 3. Click `Continue` and then select the Quix Broker and Standard storage options to complete creation of the environment, and the project. 4. Go to the pipeline view. You will see that Quix is out of sync with the repository. diff --git a/docs/platform/what-is-quix.md b/docs/platform/what-is-quix.md index 3444efcd..293f7db6 100644 --- a/docs/platform/what-is-quix.md +++ b/docs/platform/what-is-quix.md @@ -181,4 +181,4 @@ Quix provides a suite of tools to enable you to monitor and manage your data. Th * [Quickstart](../platform/quickstart.md) - get data into Quix and display it in less than 10 minutes * [Quix Tour](../platform/quixtour/overview.md) - build a complete pipeline in less than 30 minutes -* Watch [a video]((https://www.youtube.com/watch?v=0cr19MfATfY)) on the art of the possible with Quix +* Watch [a video](https://www.youtube.com/watch?v=0cr19MfATfY){target=_blank} on the art of the possible with Quix