Skip to content

Commit f1f2948

Browse files
authored
updated copy button and join course (#407)
<!-- This is an auto-generated comment: release notes by coderabbit.ai --> ## Summary by CodeRabbit - **Documentation** - Reorganized guides with new images, descriptive captions/alt text, updated visuals and step flows for LTI Canvas and support pages; added an “In Codio” snippet and a new video-guided section for creating a standard code test; join instructions reference a multi-word token. - **Accessibility** - Consolidated copy-to-clipboard UI: single shared behavior, button text updates and a live-region status for success/failure (no alert). - **Style** - Standardized punctuation, capitalization, hyphenation, and formatting across docs; videos now start muted at 8s. <!-- end of auto-generated comment: release notes by coderabbit.ai --> --------- Co-authored-by: Lola Valente <lvalente@codio.com>
1 parent e53f939 commit f1f2948

File tree

10 files changed

+247
-172
lines changed

10 files changed

+247
-172
lines changed

source/img/codiofeedback.png

12 KB
Loading
15.5 KB
Loading

source/img/intercomstart.png

142 KB
Loading

source/img/joinclass.png

74.1 KB
Loading
51.2 KB
Loading

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

Lines changed: 184 additions & 138 deletions
Large diffs are not rendered by default.

source/instructors/admin/organization/llms.rst

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33

44
.. _org_llm:
55

6-
Large Language Model
7-
====================
6+
Large Language Models
7+
=====================
88

99
You can add your own LLM API keys to your Codio organization to use in your :ref:`Course <course_llm>` from the **Organization > LLMs** page in Codio.
1010

@@ -57,11 +57,11 @@ Examples of how to use a custom LLM provider
5757
- name: your openai custom name (custom value)
5858
- provider: openai (custom value)
5959
- endpoint: https://api.openai.com
60-
- api key: your api key from openai
60+
- API key: your API key from openai
6161
- authentication: Header
6262
- auth template: Authorization: Bearer {{apikey}}
63-
- endpoint environment variable: OPENAI_CUSTOM_KEY (custom value)
64-
- api key environment variable: OPENAI_CUSTOM_KEY (custom value)
63+
- endpoint environment variable: OPENAI_CUSTOM_URL (custom value)
64+
- API key environment variable: OPENAI_CUSTOM_KEY (custom value)
6565

6666
After saving the parameters in the organization and enabling the provider in the course, run the script below in the assignment.
6767

@@ -80,11 +80,11 @@ After saving the parameters in the organization and enabling the provider in the
8080
- name: your gemini custom name (custom value)
8181
- provider: gemini (custom value)
8282
- endpoint: https://generativelanguage.googleapis.com
83-
- api key: your api key from gemini
83+
- API key: your API key from gemini
8484
- authentication: Query param
8585
- auth template: key={{apikey}}
8686
- endpoint environment variable: GEMINI_CUSTOM_URL (custom value)
87-
- api key environment variable: GEMINI_CUSTOM_KEY (custom value)
87+
- API key environment variable: GEMINI_CUSTOM_KEY (custom value)
8888

8989
The script:
9090

source/instructors/getstarted/howto.rst

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Codio Overview
1818
.. raw:: html
1919

2020

21-
<script src="https://fast.wistia.com/embed/medias/5z8sv6nw5q.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script> <div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_5z8sv6nw5q videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/5z8sv6nw5q/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "5z8sv6nw5q", onReady: function(video) {video.time(8);}});</script>
21+
<script src="https://fast.wistia.com/embed/medias/5z8sv6nw5q.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script> <div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_5z8sv6nw5q videoFoam=true muted=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/5z8sv6nw5q/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "5z8sv6nw5q", onReady: function(video) {video.mute(); video.time(8);}});</script>
2222

2323

2424

@@ -29,7 +29,7 @@ Using Codio Resources
2929
.. raw:: html
3030

3131

32-
<script src="https://fast.wistia.com/embed/medias/kpwbszlupk.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_kpwbszlupk videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/kpwbszlupk/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "kpwbszlupk", onReady: function(video) {video.time(8);}});</script>
32+
<script src="https://fast.wistia.com/embed/medias/kpwbszlupk.jsonp" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_kpwbszlupk videoFoam=true muted=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/kpwbszlupk/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "kpwbszlupk", onReady: function(video) {video.mute(); video.time(8); }});</script>
3333

3434

3535

@@ -39,7 +39,7 @@ Editing Existing Guide Content
3939
.. raw:: html
4040

4141

42-
<script src="https://fast.wistia.com/embed/medias/011ctesax7.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_011ctesax7 videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/011ctesax7/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "011ctesax7", onReady: function(video) {video.time(8);}});</script>
42+
<script src="https://fast.wistia.com/embed/medias/011ctesax7.jsonp" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_011ctesax7 videoFoam=true muted=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/011ctesax7/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "011ctesax7", onReady: function(video) {video.mute(); video.time(8); }});</script>
4343

4444

4545

@@ -49,10 +49,18 @@ Adding Students and Test Students
4949
.. raw:: html
5050

5151

52-
<script src="https://fast.wistia.com/embed/medias/u19upfunmo.jsonp" async></script><script src="https://fast.wistia.com/assets/external/E-v1.js" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_u19upfunmo videoFoam=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/u19upfunmo/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "u19upfunmo", onReady: function(video) {video.time(8);}});</script>
52+
<script src="https://fast.wistia.com/embed/medias/u19upfunmo.jsonp" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_u19upfunmo videoFoam=true muted=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/u19upfunmo/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "u19upfunmo", onReady: function(video) {video.mute(); video.time(8);}});</script>
5353

5454

5555

56+
Creating a Standard Code Test in Codio
57+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58+
59+
.. raw:: html
60+
61+
<script src="https://fast.wistia.com/embed/medias/rsmrdwd2y2.jsonp" async></script><div class="wistia_responsive_padding" style="padding:56.25% 0 0 0;position:relative;"><div class="wistia_responsive_wrapper" style="height:100%;left:0;position:absolute;top:0;width:100%;"><div class="wistia_embed wistia_async_rsmrdwd2y2 videoFoam=true muted=true" style="height:100%;position:relative;width:100%"><div class="wistia_swatch" style="height:100%;left:0;opacity:0;overflow:hidden;position:absolute;top:0;transition:opacity 200ms;width:100%;"><img src="https://fast.wistia.com/embed/medias/rsmrdwd2y2/swatch" style="filter:blur(5px);height:100%;object-fit:contain;width:100%;" alt="" aria-hidden="true" onload="this.parentNode.style.opacity=1;" /></div></div></div></div><script>window._wq = window._wq || [];_wq.push({ id: "rsmrdwd2y2", onReady: function(video) {video.mute(); video.time(8); }});</script>
62+
63+
5664

5765
Additional Video Resources
5866
~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -89,4 +97,4 @@ Additional tutorial videos are available below to further assist with setup and
8997

9098

9199
.. note::
92-
All videos are configured to start at the 8-second mark for optimal viewing experience.
100+
All embedded videos start at 8 seconds and are muted by default for a consistent, accessible experience.

source/instructors/getstarted/support/support.rst

Lines changed: 42 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -6,16 +6,23 @@
66
Codio Support
77
=============
88

9-
If you need support, then the most effective way is to use our integrated support system. You will find this in the dashboard and the IDE.
9+
For support, use our integrated support system in the Dashboard and IDE.
1010

11-
Dashboard
12-
*********
13-
Support is available in the dashboard by clicking on the **Help** menu item at the top and selecting **Support Chat**.
1411

15-
IDE
16-
***
12+
+---------------+-----------------------------------------------------------------------------------+
13+
| **Dashboard** | Support is available in the dashboard by clicking on the **Help** menu item at |
14+
| | the top and selecting **Support Chat**. |
15+
| | |
16+
| | In the Dashboard: **Help → Support Chat**. |
17+
| | |
18+
+---------------+-----------------------------------------------------------------------------------+
19+
| **IDE** | Support is available within the IDE from the **Help** menu item, then |
20+
| | **Support**. |
21+
| | |
22+
| | In the IDE: **Help → Support**. |
23+
| | |
24+
+---------------+-----------------------------------------------------------------------------------+
1725

18-
Support is available within the IDE from the **Help** menu item, then **Support**.
1926

2027
Support Dialog
2128
**************
@@ -25,42 +32,56 @@ There is a support dialog that appears when you invoke the support option. This
2532
:alt: Intercom Start
2633

2734

28-
If you are in Codio, you can see when a reply to your query arrives even if you have closed the support dialog box
29-
3035
.. image:: /img/intercomnotification.png
31-
:alt: Intercom Notification
36+
:alt: Intercom Notification
37+
:align: right
38+
:class: wrap-text
39+
:scale: 50%
40+
41+
If you are in Codio, you can see when a reply to your query arrives even if you have closed the support dialog box.
42+
43+
If you don't see a reply within two minutes—or if you're logged out—you'll receive an email notification.
3244

33-
An email will also be sent to you if you do not see the reply within 2 minutes or have logged out of your Codio account
3445

3546
Feedback
3647
********
3748

49+
.. image:: /img/codiofeedback.png
50+
:alt: Feedback
51+
:align: right
52+
:class: wrap-text
53+
3854
We are always interested to hear from our users about their thoughts/ideas for future improvements. To raise an idea or vote on other ideas already raised, either select **Feedback** from the **Connect** menu at the top or go to `Codio Feedback <https://feedback.codio.com>`_ directly.
3955

40-
.. image:: /img/codiofeedback.png
41-
:alt: Feedback
56+
4257

4358
Community
4459
*********
4560

46-
The Codio community forum is a place for Codio users to engage with each other and share best practices. You can access it from the Connect menu or go to `Codio Community <https://community.codio.com/>`_ directly.
61+
The Codio Community forum is where users engage with each other and share best practices. Access it from the Connect menu or go to `Codio Community <https://community.codio.com/>`_.
62+
63+
This forum does not replace our in-product customer support chat or our help center. Please continue to use the support chat for product issues and refer to our help center for product use guidance.
4764

48-
This forum does not replace our in-product customer support chat or our help center, please continue to use the support chat for product issues, and refer to our help center for product use guidance.
4965

5066
Student Support
5167
***************
52-
You can set a Contact URL for your students at the organization level, see :ref:`Organization Contact URL <org-contact-url>` and/or at the course level, see :ref:`Course Contact URL <course-contact-url>` so they can raise questions directly to your preferred area.
5368

54-
If you set the contact URL for a course, this will override any contact URL you may have set at the organization level.
5569

56-
Students will then be given the option to report a problem, ask a question related to their course work or access Codio support if they have a problem accessing the Codio platform.
70+
.. figure:: /img/manage_organization/studentoptions.png
71+
:align: right
72+
:width: 350px
73+
:alt: Student options
5774

58-
.. image:: /img/manage_organization/studentoptions.png
59-
:alt: Student options
75+
You can set a Contact URL for your students at the organization level (see :ref:`Organization Contact URL <org-contact-url>`) and/or at the course level (see :ref:`Course Contact URL <course-contact-url>`) so they can raise questions directly in your preferred channel.
76+
77+
If you set the contact URL for a course, this will override any contact URL you may have set at the organization level.
6078

79+
Students will then be given the option to report a problem, ask a question related to their coursework, or access Codio support if they have a problem accessing the Codio platform.
6180

6281

63-
**N.B. "Teacher" accounts will not be effected by this setting and they will still be able to contact Codio in the usual manner.**
82+
6483

84+
.. note::
85+
N.B. "Teacher" accounts will not be affected by this setting, and they will still be able to contact Codio in the usual manner.
6586

6687

student-source/students/accessing-codio/joining.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ If your school is not using an LMS platform, your instructor will provide you on
1212

1313
- Send you an invitation URL that you can copy and paste into your browser.
1414

15-
- Send you a two-word token that you can enter on the Codio website using `Join Course <https://codio.com/p/join-class>`_. Enter the token and click **Next**.
15+
- Send you a multi-word token that you can enter on the Codio website using `Join Course <https://codio.com/p/join-class>`_. Enter the token and click **Next**.
1616

1717
.. image:: /img/joinclass.png
1818
:alt: Join Course

0 commit comments

Comments
 (0)