Skip to content

Commit

Permalink
Merge pull request #44 from gabledata/slamflipstrom-patch-1
Browse files Browse the repository at this point in the history
Update README.md for Creating Secrets link
  • Loading branch information
slamflipstrom authored Feb 23, 2024
2 parents 39e6986 + ef59270 commit 5cc54d8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ You can find your API endpoint and key by navigating to the `Settings -> API Key

Next, you will need to create the `GABLE_API_KEY` and `GABLE_API_ENDPOINT` secrets in your repository settings to configure Github Actions to talk to Gable.

Follow the Github instructions for [Creating encrypted secrets for a repository](https://docs.github.com/en/actions/security-guides/encrypted-secrets#creating-encrypted-secrets-for-a-repository) to create the `GABLE_API_KEY`and `GABLE_API_ENDPOINT` repository secrets.
Follow the Github instructions for [Creating encrypted secrets for a repository](https://docs.github.com/en/actions/security-guides/using-secrets-in-github-actions#creating-secrets-for-a-repository) to create the `GABLE_API_KEY`and `GABLE_API_ENDPOINT` repository secrets.

### Clone the forked tutorial repository

Expand Down Expand Up @@ -101,7 +101,7 @@ Contracts are associated with a specific data asset. When you first enabled Gith

![Gable Data Assets](./static/gable_data_asset_list.png)

You can click on the data asset where you can view its details including the ID Gable uses for the asset. You can click on the clipboard next to the ID to copy it into the contract below.
You can click on the data asset where you can view its details including the ID Gable uses for the asset. You can click on the clipboard next to the ID to copy it. For this tutorial, we are using the `tutorial.public.order_details` data asset.

![Gable Data Asset Details](./static/gable_data_asset_detail.png)

Expand Down Expand Up @@ -147,7 +147,7 @@ Now that you have created the contract, it is time to commit the change to the r

```bash
git add .
git commit -m "Added order details data contract"
git commit -m "Add order details data contract"
git push origin first_contract
```

Expand All @@ -166,7 +166,7 @@ To create the Pull Request:
4. In the "base repository" dropdown, select your forked tutorial repository
5. In the "base" dropdown, select the `main` branch
6. In the "compare" dropdown, select the `first_contract` branch that contains your new data contract
7. In the "Title" field, add `New Order Details Data Contract`
7. In the "Title" field, add `Add order details data contract`
8. In the "Leave a comment" field, add the following:

```
Expand Down Expand Up @@ -205,7 +205,7 @@ git checkout -b breaking_data_change

We are going to add a new migration file for our database to attempt to break the contract.

Create a new file called `7a341d712aa5_order_detail_changes.py` in the [migrations folder](./db_migrations/versions/). Paste the following contents into the new `7a341d712aa5_order_detail_changes.py` file:
Create a new file called `7a341d712aa5_order_detail_changes.py` in the `./db_migrations/versions/` [folder](./db_migrations/versions/). Paste the following contents into the new `7a341d712aa5_order_detail_changes.py` file:

```python
"""order_detail changes
Expand Down
Binary file modified static/gable_data_asset_detail.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 5cc54d8

Please sign in to comment.