From fb47d9e596a1d245908fde06cbc0144e840ef81d Mon Sep 17 00:00:00 2001 From: anurag629 Date: Thu, 17 Oct 2024 12:48:53 +0530 Subject: [PATCH] add: how to add datasources on project in creating new repo --- .../github/create-new-repo.md | 38 ++++++++++++++++++- .../github/creating-github-account.md | 2 +- new-authors-training/github/github-actions.md | 2 +- .../github-repo-artifacts.md | 1 + .../github/transforming-project.md | 2 +- 5 files changed, 41 insertions(+), 4 deletions(-) diff --git a/new-authors-training/github/create-new-repo.md b/new-authors-training/github/create-new-repo.md index 06d2c93..9e93e56 100644 --- a/new-authors-training/github/create-new-repo.md +++ b/new-authors-training/github/create-new-repo.md @@ -1,5 +1,5 @@ --- -visibility: hidden +icon: code-square order: B --- @@ -40,3 +40,39 @@ Format of the repository name: `lab-{random ID}-{project_name}` For your SQL projects, you have to setup the `docker-compose.yml` file. You can refer to the [Available Databases](https://github.com/datawars-io-content/reference-databases-available-sql-tracks) for the list of databases available. Check the `.yml` file in the repository and change the `docker-compose.yml` file according to the database you want to use. + +> Check this document on how to find dataset from datasources playground: [Finding Datasets from Datasources Playground](http://localhost:5000/new-authors-training/your-first-project/choosing-a-dataset/) + +When you select the dataset from the datasources playground, you can get the name of the database and ip address of the database from the `docker-compose.yml` file and you can include the same in the `english.md` file. + +* **Data path**: Mention the path of the dataset. This is important as it helps in locating the dataset easily. + +- For data files with CSV file format, the path can be mentioned as follows: **{{datasource.filesystem_path}}/"filename"** +- For databases, the ip address path can be written as follows: **{{devices_copy."Data Source".ip_address}}** +![Dataset path](/static/creating-datasets-img/image-2.png) + +> Thing to consider while writing data sources path: + +Here is the path to get `ip address` of devices rendered in description. +```markdown +{{devices."{Device Name}".ip_address}} +``` + +For Example: + +1. In case device name is `Postgres Airlines demo database`, the path will be: +```markdown +{{devices."Postgres Airlines demo database".ip_address}} +``` +![Data Source Path](/static/creating-datasets-img/image-10.png) + +2. In case device name is `Data Source`, the path will be: +```markdown +{{devices."Data Source".ip_address}} +``` +![Data Source Path](/static/creating-datasets-img/image-9.png) + +Here is the explample: + +- Example of `english.md`: [Querying Logical Operator with Airlines using Python](https://github.com/datawars-io-content/lab-87dg27-advance-sql-logical-operator-airlines/blob/master/english.md?plain=1#L10) +- Example of `docker-compose.yml`: [Querying Logical Operator with Airlines using Python](https://github.com/datawars-io-content/lab-87dg27-advance-sql-logical-operator-airlines/blob/master/docker-compose.yml) diff --git a/new-authors-training/github/creating-github-account.md b/new-authors-training/github/creating-github-account.md index 8f105e6..11deaa7 100644 --- a/new-authors-training/github/creating-github-account.md +++ b/new-authors-training/github/creating-github-account.md @@ -1,5 +1,5 @@ --- -visibility: hidden +icon: mark-github order: A --- # Getting started with Github diff --git a/new-authors-training/github/github-actions.md b/new-authors-training/github/github-actions.md index d729987..e135834 100644 --- a/new-authors-training/github/github-actions.md +++ b/new-authors-training/github/github-actions.md @@ -1,6 +1,6 @@ --- icon: git-pull-request -order: 800 +order: D --- [!embed](https://www.loom.com/embed/93cb59410d554bb5acaed0582b3ef181?sid=9f35a102-5c8d-4b67-91ae-93d605180361) diff --git a/new-authors-training/github/github-repo-artifacts/github-repo-artifacts.md b/new-authors-training/github/github-repo-artifacts/github-repo-artifacts.md index 1acc7a8..beedaa0 100644 --- a/new-authors-training/github/github-repo-artifacts/github-repo-artifacts.md +++ b/new-authors-training/github/github-repo-artifacts/github-repo-artifacts.md @@ -1,6 +1,7 @@ --- icon: project-roadmap expanded: false +order: C --- # Reference of Repo most important components diff --git a/new-authors-training/github/transforming-project.md b/new-authors-training/github/transforming-project.md index 851901a..04dca4c 100644 --- a/new-authors-training/github/transforming-project.md +++ b/new-authors-training/github/transforming-project.md @@ -1,6 +1,6 @@ --- icon: code-square -order: 850 +order: E ---