Skip to content

Commit 64d8c37

Browse files
authored
minor changes (#471)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit * **Documentation** * Clarified Codio and GitHub setup steps to emphasize SSH-based workflows, including uploading a public key and using SSH clone URLs. * Added guidance for LTI 1.3 Canvas setup to leave the Deployment ID field blank when configuring at the course level. * Updated organization LLM key instructions to direct users to contact support and specify whether OpenAI or Anthropic keys are needed. <!-- end of auto-generated comment: release notes by coderabbit.ai -->
1 parent 8c82817 commit 64d8c37

7 files changed

Lines changed: 12 additions & 5 deletions

File tree

source/common/develop/ide/editing/connect-github-codio.rst

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ The first step to using GitHub in Codio is connecting your Codio and GitHub acco
1616

1717
3. In the GitHub section, click **Connect account** and log in to your Github account when prompted.
1818

19-
4. If you are using SSH connections, click **Upload public key** so Codio and Github can exchange keys.
19+
4. Click **Upload public key** so Codio and GitHub can exchange keys, which is required for SSH connections.
2020

2121
.. image:: /img/gitHub2.png
2222
:alt: Upload Public Key
@@ -33,16 +33,19 @@ To create a new repo, follow these steps:
3333

3434
.. image:: /img/NewRepo.png
3535
:alt: New Repo Button
36+
:width: 350px
3637

3738
2. Complete the requested details. We suggest **not** initializing a README since one already exists in Codio and will result in an immediate conflict.
3839

3940
.. image:: /img/RepoConfig.png
4041
:alt: Create New Repo
42+
:width: 500px
4143

42-
3. Copy either the **HTTP** or **SSH** URL on the created repo page (if you do not want to type credentials and you uploaded your public key, use SSH).
44+
3. Copy the **SSH** URL on the created repo page.
4345

4446
.. image:: /img/RepoURL.png
4547
:alt: Repo URL
48+
4649

4750
In Codio: Connect to repo
4851
-------------------------
@@ -111,12 +114,14 @@ Manually importing a Git repo into Codio
111114
----------------------------------------
112115
To manually import a Git repo into Codio, follow these steps:
113116

114-
1. In GitHub, click the **Clone URL** link in the right pane and copy to the clipboard.
117+
1. In GitHub, click the **SSH** tab in the right pane and copy the Clone URL to the clipboard.
115118

116119
.. figure:: /img/github-clone-url.png
117120
:alt: create from GitHub
121+
:width: 450px
118122

119-
If you are cloning using SSH, you must have already added the Codio SSH public key as described in :ref:`SSH Key <ssh-key>`.
123+
.. note::
124+
Before cloning, you must have already added the Codio SSH public key as described in :ref:`SSH Key <ssh-key>`.
120125

121126
2. Create a :ref:`new project <create-import-project>` or :ref:`add an assignment <add-remove-assignment>` to a course.
122127

source/img/NewRepo.png

-91.3 KB
Loading

source/img/RepoConfig.png

-93.6 KB
Loading

source/img/RepoURL.png

-134 KB
Loading

source/img/github-clone-url.png

-107 KB
Loading

source/instructors/admin/integration/lti1-3Canvas.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -298,6 +298,9 @@ Updating the fields in Platform Information
298298

299299
4. **Deployment ID:** leave blank
300300

301+
.. note::
302+
Leave the Deployment ID empty if you plan to deploy the LTI tool at the course level.
303+
301304
5. **Public Keyset URL:**
302305

303306
.. tabs::

source/instructors/admin/organization/llms.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,6 @@ When keys are added, you can enable use of the key in a course. See :ref:`Course
112112

113113
To enable Codio LLM keys for your organization, please contact help@codio.com to initiate the process. Specify whether you require OpenAI or Anthropic keys.
114114

115-
.. Note:: These keys are currently free but may be subject to charges in the future.
116115

117116

118117

0 commit comments

Comments
 (0)