Skip to content

Commit f1c6d2e

Browse files
Merge pull request #115362 from SnehaGunda/release-build1
Adding GitHub notebooks doc
2 parents a1af7e9 + e678cd1 commit f1c6d2e

File tree

7 files changed

+61
-2
lines changed

7 files changed

+61
-2
lines changed

articles/cosmos-db/TOC.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1043,6 +1043,8 @@
10431043
items:
10441044
- name: Enable notebooks
10451045
href: enable-notebooks.md
1046+
- name: Import notebooks from GitHub
1047+
href: import-github-notebooks.md
10461048
- name: Use built-in Python notebook commands
10471049
href: use-python-notebook-features-and-commands.md
10481050
- name: Use built-in C# notebook commands

articles/cosmos-db/faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ You can also use the [Azure Cosmos DB Emulator](local-emulator.md) to develop an
6464

6565
To ask a technical question, you can post to one of these two question and answer forums:
6666

67-
* [MSDN forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=azurecosmosdb)
67+
* [MSDN forum](https://docs.microsoft.com/answers/topics/azure-cosmos-db.html)
6868
* [Stack Overflow](https://stackoverflow.com/questions/tagged/azure-cosmosdb). Stack Overflow is best for programming questions. Make sure your question is [on-topic](https://stackoverflow.com/help/on-topic) and [provide as many details as possible, making the question clear and answerable](https://stackoverflow.com/help/how-to-ask).
6969

7070
To request new features, create a new request on [User voice](https://feedback.azure.com/forums/263030-azure-cosmos-db).
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Import and run notebooks from a GitHub repo into Azure Cosmos DB
3+
description: Learn how to connect to GitHub and import the notebooks from a GitHub repo to your Azure Cosmos account. After importing, you can run, edit them, and save the changes back to GitHub.
4+
author: deborahc
5+
ms.author: dech
6+
ms.service: cosmos-db
7+
ms.topic: conceptual
8+
ms.date: 05/19/2020
9+
10+
---
11+
12+
# Import notebooks from a GitHub repo into Azure Cosmos DB
13+
14+
After you [enable notebook support](enable-notebooks.md) for your Azure Cosmos accounts, you can create new notebooks, upload new notebooks from your local computer, or import the existing notebooks from your GitHub accounts. This article shows how to connect your notebooks workspace to GitHub and import the notebooks from a GitHub repo to your Azure Cosmos account. After importing, you can run them, make changes, and save the changes back to GitHub.
15+
16+
## Get notebooks from GitHub
17+
18+
You can connect to your own GitHub repositories or other public GitHub repositories to read, author, and share notebooks in Azure Cosmos DB. Use the following steps to connect to a GitHub account:
19+
20+
1. Sign into [Azure portal](https://portal.azure.com/) and navigate to your Azure Cosmos account.
21+
22+
1. Open the **Data Explorer** tab. This tab will show all your existing databases, containers, and notebooks.
23+
24+
1. Select the **Connect to GitHub** menu item.
25+
26+
1. A tab opens where you can choose to connect to **Public repos** only or **Public and private repos**. After choosing the required option, select **Authorize access**. Authorization is required for Azure Cosmos DB to access the repositories in your GitHub account.
27+
28+
![Authorize Azure Cosmos DB to access your GitHub repositories](./media/import-github-notebooks/authorize-access-github.png)
29+
30+
1. You are redirected to "github.com" web page where you can confirm the authorization. Select the **Authorize AzureCosmosDBNotebooks** button and enter your GitHub account password in the prompt.
31+
32+
1. After the authorization is successful, it takes you back to your Azure Cosmos account. You can then see all the public/private repos from your GitHub account. You can select a repo from the list available or add a repo directly by using its URL.
33+
34+
1. Once you select the required repo, the repo entry moves from the **Unpinned repos** section to **Pinned repos** section. If needed, you can also choose a specific branch of that repo to import the notebooks from.
35+
36+
![Choose a repository and a branch](./media/import-github-notebooks/choose-repo-branch.png)
37+
38+
1. Select **OK** to complete the import operation. All the notebooks available in the selected branch of your repo are imported into your Azure Cosmos account.
39+
40+
After you integrate with a GitHub account, only you can see the list of repositories and notebooks in your Azure Cosmos account. This statement is true even if multiple users log into the Azure Cosmos DB account and add their own accounts. In other words, multiple users can use the same Azure Cosmos account to connect the notebook workspace to GitHub. However, each user only sees the list of repositories and notebooks they have imported. The notebooks imported by others are not visible to you.
41+
42+
To disconnect your GitHub account from the notebooks workspace, open the **Data Explorer** tab, select `` next to **GitHub repos** and select **Disconnect from GitHub**.
43+
44+
## Edit a notebook and push changes to GitHub
45+
46+
You can edit an existing notebook or add a new notebook to the repo and save the changes back to GitHub.
47+
48+
After you edit an existing notebook, select **Save**. A dialog box opens where you can enter the commit message for the changes you have made. Select **Commit** and the notebook in GitHub is updated. You can validate the updates by signing into your GitHub account, and verifying the commit history.
49+
50+
In the regular GitHub flow after committing the changes, you will typically push changes to a remote. However, in this case the commit option serves the purpose of “staging, committing, and pushing” your updates to GitHub.
51+
52+
![Edit notebooks and commit changes to GitHub](./media/import-github-notebooks/commit-changes-github.png)
53+
54+
## Next steps
55+
56+
* Learn about the benefits of [Azure Cosmos DB Jupyter notebooks.](cosmosdb-jupyter-notebooks.md)
57+
23.6 KB
Loading
12.5 KB
Loading
123 KB
Loading

articles/cosmos-db/table-api-faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -288,7 +288,7 @@ Azure Cosmos DB is an SLA-based system that provides latency, throughput, availa
288288
You can share your feedback in any of the following ways:
289289

290290
* [User voice](https://feedback.azure.com/forums/263030-azure-cosmos-db)
291-
* [MSDN forum](https://social.msdn.microsoft.com/Forums/en-US/home?forum=azurecosmosdb)
291+
* [MSDN forum](https://docs.microsoft.com/answers/topics/azure-cosmos-db.html)
292292
* [Stack Overflow](https://stackoverflow.com/questions/tagged/azure-cosmosdb). Stack Overflow is best for programming questions. Make sure your question is [on-topic](https://stackoverflow.com/help/on-topic) and [provide as many details as possible, making the question clear and answerable](https://stackoverflow.com/help/how-to-ask).
293293

294294
## Next steps

0 commit comments

Comments
 (0)