Skip to content

Commit 9862bb5

Browse files
Barb CutlerBarb Cutler
Barb Cutler
authored and
Barb Cutler
committed
tweak instructions
1 parent d677596 commit 9862bb5

File tree

4 files changed

+39
-32
lines changed

4 files changed

+39
-32
lines changed

_docs/sysadmin/configuration/ansible_course_creation.md

+11-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,11 @@
11
---
2-
title: Course Creation
2+
title: Course Creation using Ansible
33
category: System Administrator > Configuration & Administration
44
---
55

6-
# Course Creation using Ansible
7-
8-
Ansible is a powerful automation tool that can be used to manage configurations and automate the course creation process in Submitty.
9-
10-
## Prerequisites
11-
12-
This guide assumes that you are already following the Ansible installation guide for Submitty. If you have not yet installed Ansible or set up Submitty with Ansible, please refer to the [Ansible Installation Guide](/sysadmin/installation/ansible) before proceeding with course creation.
6+
NOTE: This guide assumes that you have first created a Submitty server
7+
using Ansible following the
8+
[Installation using Ansible](/sysadmin/installation/ansible) instructions.
139

1410
## Steps to Create a Course
1511

@@ -29,6 +25,11 @@ This guide assumes that you are already following the Ansible installation guide
2925
3026
4. Once the process is complete, your new course should be available in Submitty.
3127
32-
**For a more detailed step-by-step guide on creating a course, you can refer to the [Course Creation Documentation](course_creation)
28+
**For a more detailed step-by-step guide on creating a course, you
29+
can refer to the [Course Creation](course_creation)
30+
instructions.
31+
32+
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_course_creation` role.
3333
34-
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_course_creation` role.
34+
See also:
35+
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)

_docs/sysadmin/configuration/ansible_term_creation.md

+10-9
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,9 @@ title: Term Creation using Ansible
33
category: System Administrator > Configuration & Administration
44
---
55

6-
# Term Creation using Ansible
7-
8-
Ansible is a powerful automation tool that can be used to manage configurations and automate the term creation process in Submitty.
9-
10-
## Prerequisites
11-
12-
This guide assumes that you are already following the Ansible installation guide for Submitty. If you have not yet installed Ansible or set up Submitty with Ansible, please refer to the [Ansible Installation Guide](/sysadmin/installation/ansible) before proceeding with term creation.
6+
NOTE: This guide assumes that you have first created a Submitty server
7+
using Ansible following the
8+
[Installation using Ansible](/sysadmin/installation/ansible) instructions.
139

1410
## Steps to Create a Term
1511

@@ -33,6 +29,11 @@ This guide assumes that you are already following the Ansible installation guide
3329
3430
4. Once the process is complete, your new term should be available in Submitty.
3531
36-
**For a more detailed step-by-step guide on creating a course, you can refer to the [Term Creation Documentation](term_creation).
32+
**For a more detailed step-by-step guide on creating a course, you
33+
can refer to the [Term Creation](term_creation) instructions.
34+
35+
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_term_creation` role.
36+
3737
38-
**If you wish to understand the individual tasks that are performed during the course creation process, you can examine the tasks defined under the `submitty_term_creation` role.
38+
See also:
39+
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)

_docs/sysadmin/installation/ansible.md

+17-12
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,14 @@
11
---
2-
title: Installing with Ansible
2+
title: Installation using Ansible
33
category: System Administrator > Installation
44
redirect_from:
55
---
66

7-
These are the instructions for install Submitty using Ansible.
7+
Ansible is a powerful automation tool that can be used to manage
8+
configurations and automate the term creation process in Submitty.
89

9-
Getting Started:
10-
11-
**Note**: We assume that you're installing Submitty on a dedicated machine.
10+
***Note**: We assume that you're installing Submitty server on a
11+
dedicated machine.*
1212

1313
1. [Install Ubuntu 22.04 server edition (or other supported distro)](/sysadmin/installation/server_os)
1414

@@ -18,25 +18,26 @@ Getting Started:
1818

1919
2. Install Ansible:
2020

21-
Installing Ansible on your local environment is required. Below is a link for more help.
22-
23-
https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html
21+
Installing Ansible on your local environment is required.
22+
See also: [Ansible Documentation](https://docs.ansible.com/ansible/latest/installation_guide/intro_installation.html)
2423

2524

2625
3. Edit Inventory and Add Server IP:
2726

2827
An example has been given to you in the inventory file. Update localhost with your server ip address.
2928
This will allow access to your web interface.
3029

31-
4. Edit playbook variables with your server properties(`.setup/ansible/playbooks/submitty_install.yml`):
30+
4. Edit playbook variables with your server properties, stored in this file:
31+
`.setup/ansible/playbooks/submitty_install.yml`
3232

33-
Note: Configure your playbook with your Submitty settings. See
33+
Note: Configure your playbook with your Submitty settings. See:
3434
`.setup/ansible/roles/app_submitty/defaults/main.yml` for default installation parameters.
3535

3636
**Important**: Any variables defined in the playbook will take precedence over the default values.
3737
This allows for fine-tuning and customization of your Submitty installation.
3838

39-
**Reminder**: Ensure that the `submitty_version` variable in your playbook matches the version of Submitty you intend to install. This is crucial for the correct functioning of your installation.
39+
**Reminder**: Ensure that the `submitty_version` variable in your playbook matches the version of
40+
Submitty you intend to install. This is crucial for the correct functioning of your installation.
4041

4142
5. SSL Configuration
4243

@@ -68,7 +69,6 @@ Getting Started:
6869

6970
```
7071
cd .setup/ansible
71-
7272
```
7373

7474
Once you are in the `ansible` directory, you can proceed with the installation by running the
@@ -91,3 +91,8 @@ Getting Started:
9191
8. Navigate to Web Interface
9292

9393
Navigate to your domain name in a web browser.
94+
95+
96+
See also:
97+
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation)
98+
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation)

navtreedata.js

+1-1
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ var NAVTREE =
145145
[ "Server OS", "/sysadmin/installation/server_os", null ],
146146
[ "Update GNU/Linux Server", "/sysadmin/installation/update_server", null ],
147147
[ "Update Submitty", "/sysadmin/installation/update_submitty", null ],
148-
[ "Ansible Installation", "/sysadmin/installation/ansible", null ],
148+
[ "Ansible Server Installation", "/sysadmin/installation/ansible", null ],
149149
[ "Version Notes", "/sysadmin/installation/version_notes/index", [
150150
[ "Overview", "/sysadmin/installation/version_notes/index", null],
151151
[ "v23.12.02", "/sysadmin/installation/version_notes/v23.12.02", null ],

0 commit comments

Comments
 (0)