Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
17 changes: 17 additions & 0 deletions .guides/book.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "Sphynx-Docs",
"children": [
{
"title": "Page 1",
"id": "890dfcdb-0b7a-48b5-2a3b-2f12d0ca8b54",
"pageId": "890dfcdb-0b7a-48b5-2a3b-2f12d0ca8b54",
"type": "page"
},
{
"title": "Page 2",
"id": "5568808d-1665-4ec9-03bd-b37e0d81a712",
"pageId": "5568808d-1665-4ec9-03bd-b37e0d81a712",
"type": "page"
}
]
}
1 change: 1 addition & 0 deletions .guides/content/Page-1-890d.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Sample content Page 1
1 change: 1 addition & 0 deletions .guides/content/Page-2-5568.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Sample content Page 2
33 changes: 33 additions & 0 deletions .guides/metadata.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
{
"sections": [
{
"id": "890dfcdb-0b7a-48b5-2a3b-2f12d0ca8b54",
"title": "Page 1",
"files": [],
"path": [],
"type": "markdown",
"content-file": ".guides/content/Page-1-890d.md",
"chapter": false,
"reset": [],
"teacherOnly": false,
"learningObjectives": ""
},
{
"id": "5568808d-1665-4ec9-03bd-b37e0d81a712",
"title": "Page 2",
"files": [],
"path": [],
"type": "markdown",
"content-file": ".guides/content/Page-2-5568.md",
"chapter": false,
"reset": [],
"teacherOnly": false,
"learningObjectives": ""
}
],
"theme": "light",
"scripts": [],
"lexikonTopic": "",
"useSubmitButtons": true,
"useMarkAsComplete": true
}
Binary file modified source/_static/img/CodioLibTags.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/accessgrades.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/account_password.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/actionarea.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/addFromLib.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/adjusted.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/assessment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/assessmentpoints.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/assessmenttoken.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/assign-module.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/auto-transfer-total.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/autoComplete.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/autograde-test.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/bloomsTax.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book-permissions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book_publish.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book_stack_modified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book_stack_newstack.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book_stack_newversion.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/book_stack_notmodified.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/bookmapping.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/bookpages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/booksettings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/booksettingspage.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/bookshowallpages.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified source/_static/img/bookslist.png
Binary file modified source/_static/img/bookupdate.png
Binary file modified source/_static/img/bookupdate1.png
Binary file modified source/_static/img/bookversion.png
Binary file modified source/_static/img/box_info.png
Binary file modified source/_static/img/ca-collapse-before.png
Binary file modified source/_static/img/ca-overview.png
Binary file modified source/_static/img/ca-popup-window.png
Binary file modified source/_static/img/ca-readme.png
Binary file modified source/_static/img/ca-video.png
Binary file modified source/_static/img/changereleasegrades.png
Binary file modified source/_static/img/chromecookies.png
Binary file modified source/_static/img/class-releasegrades.png
Binary file modified source/_static/img/class_add_module.png
Binary file modified source/_static/img/class_addstudents.png
Binary file modified source/_static/img/class_addteachers.png
Binary file modified source/_static/img/class_administration/asignmentsettings.png
Binary file modified source/_static/img/class_administration/editassignment.png
Binary file modified source/_static/img/class_administration/editunit.png
Binary file modified source/_static/img/class_administration/grading/anongrading.png
Binary file modified source/_static/img/class_administration/grading/classroom.png
Binary file modified source/_static/img/class_administration/grading/templates.png
Binary file modified source/_static/img/class_administration/indunitupdate.png
Binary file modified source/_static/img/class_administration/modulesettings.png
Binary file modified source/_static/img/class_administration/orgbilling.png
Binary file modified source/_static/img/class_administration/profilepic.png
Binary file modified source/_static/img/class_administration/projectupdateunit.png
Binary file modified source/_static/img/class_administration/stackupdate.png
Binary file modified source/_static/img/class_administration/unit-settings-1.png
Binary file modified source/_static/img/class_administration/unit-settings-2.png
Binary file modified source/_static/img/class_administration/unit-settings-dd.png
Binary file modified source/_static/img/class_administration/updatedunits.png
Binary file modified source/_static/img/class_administration/updateunit.png
Binary file modified source/_static/img/class_administration/updateunitadhoc.png
Binary file modified source/_static/img/class_administration/upgradecourse.png
Binary file modified source/_static/img/class_administration/upgradecoursedialog.png
Binary file modified source/_static/img/class_courses.png
Binary file modified source/_static/img/class_create.png
Binary file modified source/_static/img/class_dashboard.png
Binary file modified source/_static/img/class_delete.png
Binary file modified source/_static/img/class_export.png
Binary file modified source/_static/img/class_exportlinks.png
Binary file modified source/_static/img/class_grade.png
Binary file modified source/_static/img/class_join.png
Binary file modified source/_static/img/class_list.png
Binary file modified source/_static/img/class_lti_export.png
Binary file modified source/_static/img/class_projects.png
Binary file modified source/_static/img/class_recent.png
Binary file modified source/_static/img/class_releasegrades.png
Binary file modified source/_static/img/class_setgrade.png
Binary file modified source/_static/img/class_start.png
Binary file modified source/_static/img/class_students.png
Binary file modified source/_static/img/class_studentstab.png
Binary file modified source/_static/img/class_view.png
Binary file modified source/_static/img/classcontacturl.png
Binary file modified source/_static/img/classunitsettings.png
Binary file modified source/_static/img/codesolution.png
Binary file modified source/_static/img/codiofeedback.png
Binary file modified source/_static/img/codioignore.png
Binary file modified source/_static/img/commentcode.png
Binary file modified source/_static/img/complexLayoutIcon.png
Binary file modified source/_static/img/consent.png
1 change: 0 additions & 1 deletion source/admin/acsettings.rst

This file was deleted.

1 change: 0 additions & 1 deletion source/admin/integrate.rst

This file was deleted.

1 change: 0 additions & 1 deletion source/admin/invite.rst

This file was deleted.

16 changes: 0 additions & 16 deletions source/admin/legal.rst

This file was deleted.

1 change: 0 additions & 1 deletion source/admin/orgbilling.rst

This file was deleted.

3 changes: 0 additions & 3 deletions source/admin/orgsettings.rst

This file was deleted.

5 changes: 4 additions & 1 deletion source/common/develop/ide/boxes/access.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Connect Codio to other applications such as Github and ButBucket using SSH keys.

.. _ssh:

Access Codio Box via SSH
Expand Down Expand Up @@ -46,7 +49,7 @@ You can view all uploaded public keys in your project by opening the terminal an

Enable SSH forwarding and connect to your box
---------------------------------------------
You can now enable SSh forwarding in Codio and then connect to you box from you local machine's terminal window:
You can now enable SSH forwarding in Codio and then connect to your box from your local machine's terminal window:

1. Click the **Project** tab on the menu bar and choose **Settings**.
2. Click the **Forwarding Settings** tab.
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/always-on.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Always-on boxes all your projects to always be accessible.

.. _always on boxes:

Always-On Boxes
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/ext-access.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: External Access to Boxes and Ports

.. _external access:

External Access to Boxes and Ports
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/ide-access-permissions.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Granting IDE access to other users by assigning admin permissions.

.. _IDE-access-permissions:

IDE Access Permissions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: All Codio projects are pre-installed with Ubuntu server and Git software.

.. _preinstalled-software:

Preinstalled Software Packages
Expand Down
4 changes: 4 additions & 0 deletions source/common/develop/ide/boxes/installsw/file-locations.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. meta::
:description: Location of the Codio workspace and installed software.


File and Software Locations
===========================

Expand Down
7 changes: 5 additions & 2 deletions source/common/develop/ide/boxes/installsw/gui.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Working with GUI based output

.. _gui:

GUI Based Output
Expand All @@ -15,7 +18,7 @@ Uses and limitations
^^^^^^^^^^^^^^^^^^^^
X Server is a virtual desktop that is very effective for Codio's cloud-based infrastructure. Any application that relies on a graphical user interface has its graphical output redirected to it and Codio's viewer is then able to display the virtual desktop in a browser.

You can gain good experience using the sample applications in the **Demo GUI Output** project, which also includes some complex UIs (for example, SQLite and StartUML). You may experience limitations when using fast-motion graphics where the virtual screen content is changing so fast that it cannot be rendered in real time over the internet. A stronger bandwidth will provide better performance and overall experience.
The **Demo GUI Output** project provides sample applications and also includes some complex UIs (for example, SQLite and StartUML). You may experience limitations when using fast-motion graphics where the virtual screen content is changing so fast that it cannot be rendered in real time over the internet. A stronger bandwidth will provide better performance and overall experience.


Install your own projects
Expand Down Expand Up @@ -44,7 +47,7 @@ Use the viewer
^^^^^^^^^^^^^^
The viewer is a special window that appears either inside Codio or in a separate browser tab. To open it, add `"Viewer": "https://{{domain3000}}/"` to the .codio file, as follows:

.. code:: json
.. code:: ini

{
// Configure your Run and Preview buttons here.
Expand Down
4 changes: 0 additions & 4 deletions source/common/develop/ide/boxes/installsw/index.rst

This file was deleted.

Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Installing software packages in your project/assignment or view installed software.

.. _box_parts:

Install Software Packages
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/installsw/langserver.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: The Language Server Protocol integrates features such as autocomplete, go to definition, and find all references.

.. _langserver:

Language Server Protocol
Expand Down
7 changes: 5 additions & 2 deletions source/common/develop/ide/boxes/installsw/parts-coding.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Adding rour own software packages to the Install Software list.

.. _parts-coding:

Add Your Own Software Packages
Expand All @@ -21,7 +24,7 @@ The **package_list.json** file is is the manifest that lists the entire contents

Here's a example of the MySQL entry:

.. code:: json
.. code:: ini

"mysql": {
"name": "MySQL",
Expand Down Expand Up @@ -78,7 +81,7 @@ Ansible playbook script
^^^^^^^^^^^^^^^^^^^^^^^
Ansible simplifies installations and configurations, as easier to read and maintain than using the main bash script with standard Ubuntu commands. For more information about Ansible playbooks, `click here <http://docs.ansible.com/>`_.

.. code:: json
.. code:: ini

---
- name: Install MySQL
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/overview.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Each Codio project or assignment IDE gets it's own dedicated Ubuntu Server (box) with sudo access. This is an overview of the Codio IDE box.

.. _overview:

IDE Box Overview
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/restart-reset.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Restarting a box is a reboot, resetting a box returns it to a fresh state.

.. _Restart and Reset:

Restart or Reset Box
Expand Down
7 changes: 5 additions & 2 deletions source/common/develop/ide/boxes/runmenu.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Customize the run button to execute commands and shell scripts.

.. _customizable-run-menu:

Customize Run Button
Expand All @@ -14,7 +17,7 @@ To customize the **Run** button to open a new terminal window where you can see

In the .codio file, locate the lines below, and then copy and paste the following code:

.. code:: json
.. code:: ini

{
// Configure your Run and Preview buttons here.
Expand All @@ -35,7 +38,7 @@ Configure to run in current terminal window
-------------------------------------------
If you want to configure the Run button to run commands in the current terminal window, modify the **id** field in the **.codio** file as follows:

.. code:: json
.. code:: ini

{
"commands": {
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/startup.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Configure services to autostart when you open your project.

.. _startup:

Autostart Services
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/boxes/terminal.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Open a terminal window in your project or assignment.

.. _terminal:

Terminal Window
Expand Down
9 changes: 6 additions & 3 deletions source/common/develop/ide/debugger/create-debug-target.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Create and Manage Debugger Targets

.. _create-debug-target:


Expand All @@ -11,7 +14,7 @@ Before you can start debugging a project, you must first create your debug targe

You manage your debug targets on the **Debugger Settings** page.

.. figure:: /img/debug-targets.png
.. image:: /img/debug-targets.png
:alt: Debugger Settings

Create a debug target
Expand All @@ -23,10 +26,10 @@ To create a debug target, follow these steps:

2. On the Debugger Settings page, click **Create**.

.. figure:: /img/debug-target.png
.. image:: /img/debug-target.png
:alt: Create Debug Target

Create Debug Target


3. Click the **Debugger Type** drop-down and choose the programming language.

Expand Down
4 changes: 4 additions & 0 deletions source/common/develop/ide/debugger/debugger.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
.. meta::
:description: Debugger


Debugger
========

Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/debugger/start-debug.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Start Debug Session

.. _start-debug:

Start Debug Session
Expand Down
6 changes: 5 additions & 1 deletion source/common/develop/ide/editing/abbreviations.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@

.. meta::
:description: HTML and CSS abbreviations that expand to code in the IDE.

.. _abbreviations:

Abbreviations
Expand Down Expand Up @@ -43,7 +47,7 @@ results in
Juicier HTML example
--------------------

.. code:: css
.. code:: ini

#page>div.logo+ul#navigation>li*5>a{Item $}

Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/autocomplete.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Autocomplete is supported in HTML, CSS, and Javascript files. Simply start typing and matches are automatically displayed.

.. _autocomplete:

Autocomplete
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/code-beautifier.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Applying the Code Beautifier will automatically indent and manage spaces in your code to format it correctly.

.. _code-beautifier:

Code Beautifier
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/code-editing.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Special code editing features when working with HTML, CSS, and Javascript files.

.. _code-editing:

Code Editing Features
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/color-picker.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: You can preview colors of code and choose a different color using the Color Picker feature.

.. _color-picker:

Color Picker and Preview
Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/command-bar.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: The Command Bar allows you to access almost all of the Codio actions from a searchable list.

.. _command-bar:

Command Bar
Expand Down
7 changes: 5 additions & 2 deletions source/common/develop/ide/editing/connect-github-codio.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,11 @@
.. meta::
:description: Connecting a Codio project/assignment to a GitHub repo.

.. _connect-codio-github:

Connecting a Codio Box to a GitHub Repo
=======================================
The first step to using GitHub in Codio is connecting your Codio and Github accounts. You only have to do this once. Follow these steps:
The first step to using GitHub in Codio is connecting your Codio and GitHub accounts. You only have to do this once. Follow these steps:

1. Click your user name in the bottom left of the main menu.

Expand Down Expand Up @@ -66,7 +69,7 @@ To connect to your repo from Codio, follow these steps:

5. Click **Save** and then **Close**.

.. image:: /img/RemoteConfig2]
.. image:: /img/RemoteConfig2.png

6. Click **Tools > Terminal** on the menu to open a terminal window.

Expand Down
3 changes: 3 additions & 0 deletions source/common/develop/ide/editing/cursor.rst
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
.. meta::
:description: Multiple cursors allow you to create multiple insertion points in a file.

.. _cursor:

Cursor Features
Expand Down
Loading