-
Notifications
You must be signed in to change notification settings - Fork 57
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Documentation:Developer] Ansible Create Term & Course Docs (#610)
The Ansible Create Course and Create Term Documentation. This will allow for user to create a term and a course on their web server following an ansible install. --------- Co-authored-by: Cameron Peterson <46759635+IDzyre@users.noreply.github.com> Co-authored-by: Barb Cutler <Barb Cutler>
- Loading branch information
1 parent
9c7ecca
commit 715fb9e
Showing
6 changed files
with
105 additions
and
14 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,35 @@ | ||
--- | ||
title: Course Creation using Ansible | ||
category: System Administrator > Configuration & Administration | ||
--- | ||
|
||
NOTE: This guide assumes that you have first created a Submitty server | ||
using Ansible following the | ||
[Installation using Ansible](/sysadmin/installation/ansible) instructions. | ||
|
||
## Steps to Create a Course | ||
|
||
1. Navigate to the ansible directory in your Submitty installation: | ||
|
||
``` | ||
cd .setup/ansible | ||
``` | ||
2. There is a playbook available named `submitty_course_creation.yml`. This playbook contains the necessary roles to create a new course in Submitty. You can edit this file to specify the details of the course you want to create. | ||
3. Run the playbook using the following command: | ||
``` | ||
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml | ||
``` | ||
4. Once the process is complete, your new course should be available in Submitty. | ||
**For a more detailed step-by-step guide on creating a course, you | ||
can refer to the [Course Creation](course_creation) | ||
instructions. | ||
**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. | ||
See also: | ||
[Ansible Term Creation](/sysadmin/configuration/ansible_term_creation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,39 @@ | ||
--- | ||
title: Term Creation using Ansible | ||
category: System Administrator > Configuration & Administration | ||
--- | ||
|
||
NOTE: This guide assumes that you have first created a Submitty server | ||
using Ansible following the | ||
[Installation using Ansible](/sysadmin/installation/ansible) instructions. | ||
|
||
## Steps to Create a Term | ||
|
||
1. Navigate to the `ansible directory` in your Submitty installation: | ||
|
||
``` | ||
cd .setup/asnible | ||
``` | ||
2. There is a playbook available named `submitty_course_creation.yml`. This playbook contains the necessary roles to create a new term in Submitty. You can edit this file to specify the details of the term you want to create. | ||
**Remember: The term should be an abbreviated semester name like: `s24` . The start and end date must be formatted in mm/dd/yyyy format. | ||
3. Run the playbook using the following command: | ||
``` | ||
ansible-playbook -i inventory/submitty playbooks/submitty_course_creation.yml | ||
``` | ||
This command will start the term creation process. Ansible will display the progress in the terminal. | ||
4. Once the process is complete, your new term should be available in Submitty. | ||
**For a more detailed step-by-step guide on creating a course, you | ||
can refer to the [Term Creation](term_creation) instructions. | ||
**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. | ||
See also: | ||
[Ansible Course Creation](/sysadmin/configuration/ansible_course_creation) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters