Difference between revisions of "How to use the website"

From LU
Jump to: navigation, search
 
 
(81 intermediate revisions by 18 users not shown)
Line 1: Line 1:
[[Overview of the website]]
+
What we call the "website" actually consists of two separate (but interacting) parts:
 +
# The graphical front-end.  This is controlled with normal HTML, CSS, etc.  The tools that any web designer knows, and so if you find someone who knows any web design, they'll be able to do this.
 +
# The database back-end.  This is the part that stores user information, classes, and much more.
 +
You have nearly complete control over the front-end, while back-end code is maintained by our Web team.
  
==Managing a Program==
+
==Front-End==
  
* [[Overview of Deadline Management]]
+
The graphics and content of your site can be edited in several ways:
 +
* The easiest is editing "Quasi-static data," or "QSD," which just refers to text on the website. If you're logged in as an administrator, just click the Edit link or in the box with a dotted outline, and you'll be editing the content on the page. ([[Edit_the_text_of_web_pages#Editing_a_webpage|More info]].)
 +
* The media files for the website (images, CSS stylesheets) can be added or modified by using the file browser at https://[yoursite].learningu.org/admin/filebrowser/browse/.
 +
* The HTML templates that are used to generate pages can be overridden at https://[yoursite].learningu.org/admin/utils/templateoverride/.  You can set the appearance of every page on your site by editing a single template override (main.html).
  
How to...
+
=== Managing a Program ===
 +
 
 +
Theory/background...
 +
 
 +
*[[How classes are submitted and managed]]
 +
*[[Overview of Deadlines]]
 +
 
 +
How to...  
 +
 
 +
*[[Access the communications panel]]
 +
*[[Create a program]]
 +
**[[Create or edit course categories]]
 +
**[[Create a new program type]]
 +
**[[Program modules documentation]]
 +
*[[Set up teacher training and interviews]]
 +
*[[Set program registration opening/closing dates]]
 +
*[[Managing financial aid|Solicit and review financial aid applications]]
 +
*[[View all submitted classes]]
 +
*[[Accept or reject classes]]
 +
*[[Schedule the program's classes]]
 +
*[[Change a class's location, time, title, description, or teachers]]
 +
*[[Cancel a class]]
 +
*[[E-mail program participants]]
 +
*[[Upload images or files for a specific program]]
 +
*[[See all files uploaded for a program]]
 +
*[[Make an online survey for a program]]
 +
*[[Make the class catalog world-readable]]
 +
*[[Do on-site registration or class changes]]
 +
*[[Change what registration types students see]]
 +
*[[Add a registration receipt]]
 +
*[[Make a volunteer sign-up form]]
 +
 
 +
In general, "test everything you want to use." In particular, important tests are:
  
* [[Create a program]]
+
*[[Student registration testing|Before student registration]]  
* [[Set program registration opening/closing dates]]
+
*[[Teacher registration testing|Before teacher registration]]  
* [[View all submitted classes]]
+
*[[Pre-program testing|Before the program runs]]
* [[Schedule the program's classes]]
+
* [[Change a class's location, title, description, or teachers]]
+
* [[Change a class's time]]
+
* [[Cancel a class]]
+
* [[E-mail program participants]]
+
* [[Upload images or files for a specific program]]
+
* [[See all files uploaded]]
+
* [[Make an online survey for a program]]
+
* [[Make the class catalog world-readable]]
+
* [[Do on-site registration or class changes]]
+
  
==Website Output==
+
===Printables===
  
 
How to...
 
How to...
Line 31: Line 59:
 
* [[Print door signs for classroom schedules]]
 
* [[Print door signs for classroom schedules]]
 
* [[Print administrator information]]
 
* [[Print administrator information]]
 +
* [[Customize student schedules]] and other printables: [[template overrides]]
 
* [[Sort printables in a different order]]
 
* [[Sort printables in a different order]]
 +
* [[Customize a printable catalog]]
  
==Website Content==
+
===Website Content===
  
 
How to...
 
How to...
  
 
* [[Edit the text of web pages]]
 
* [[Edit the text of web pages]]
* [[Upload a file to your page]]
+
* [[Upload a file to the website]] (i.e. not associated to a particular program)
 
* [[View all uploaded files]]
 
* [[View all uploaded files]]
 +
* [[Customize behavior with Tags]]
 +
* [https://github.com/learning-unlimited/ESP-Website/blob/main/docs/admin/generic_templates.rst Choose and customize a theme]
  
==Managing Users==
+
* [[Customize the graphic design]] (includes information on templates)
  
* [[Overview of userbits]]
+
===Managing Users===
  
 
How to...
 
How to...
  
 +
* [[Morph into user]]
 
* [[Look up user information]]
 
* [[Look up user information]]
 +
* [[Change a student's grade]]
 
* [[Deregister a student from a program]]
 
* [[Deregister a student from a program]]
 
* [[Enable a teacher to register a class after the deadline]]
 
* [[Enable a teacher to register a class after the deadline]]
 
* [[Reset someone's password]]
 
* [[Reset someone's password]]
 
* [[Give someone administrator access]]
 
* [[Give someone administrator access]]
 +
* [[Check a student in]]
 +
 +
==Back-End==
 +
 +
Some newer documentation is available at <https://github.com/learning-unlimited/ESP-Website/tree/main/docs/admin>.
 +
 +
The latest release notes are at <https://github.com/learning-unlimited/ESP-Website/tree/main/docs/admin/releases/06>.
 +
 +
To contact the web team with questions, problems, feature requests, etc. email <websupport@learningu.org>.
 +
 +
Submit feature requests and non-urgent bug reports to <https://docs.google.com/a/learningu.org/spreadsheet/viewform?usp=drive_web&formkey=dFlJcnJjVHJKSUdMYzNsTm9GNGNPRUE6MQ>.
 +
 +
===Starting Out===
 +
 +
* [[Starting a site]] (non-technical first steps for new chapters)
 +
* [[Launching A New Website Installation]] (slightly technical steps for brand-new sites)
 +
 +
=== Feature Requests ===
 +
 +
If you want to request a new feature or bug fix for the website, you have three choices:
 +
 +
# For anything that warrants discussion, e-mail your mentors or Web support e-mail list with a description of the issue.
 +
# If you have a good idea of what you need, fill out our Google form [https://docs.google.com/a/learningu.org/spreadsheet/viewform?formkey=dFlJcnJjVHJKSUdMYzNsTm9GNGNPRUE6MQ here] (responses are visible [https://docs.google.com/spreadsheet/ccc?key=0AvJIqPcxGC19dFlJcnJjVHJKSUdMYzNsTm9GNGNPRUE here])
 +
# If you have detailed technical knowledge of the issue, file a ticket directly on Github:
 +
#* Go to https://github.com/learning-unlimited/ESP-Website/issues
 +
#* Click "New Issue"
 +
#* Provide a short descriptive title of the issue, and a detailed description (e.g. exactly how to reproduce a problem, or exactly what you want a new feature to look like).  Click "Submit New Issue."
 +
#* Associate any relevant labels with the ticket (e.g. Error, UserInterface, Enhancement, Performance).
  
 
==Miscellaneous==
 
==Miscellaneous==
  
 
How to...
 
How to...
 
+
* [[E-mail to graduating high school seniors]]
 
* [[E-mail previous program participants]] (e.g. to advertise your upcoming programs)
 
* [[E-mail previous program participants]] (e.g. to advertise your upcoming programs)
 +
* [[How to request a new feature on the website]]
 +
* [[Dev server setup script]]
 +
 +
* Continue Reading on [[How to design a chapter website]]
 +
 +
[[Category:Website]]
 +
[[Category:Splash Manual]]
 +
{{good}}

Latest revision as of 21:01, 14 January 2018

What we call the "website" actually consists of two separate (but interacting) parts:

  1. The graphical front-end. This is controlled with normal HTML, CSS, etc. The tools that any web designer knows, and so if you find someone who knows any web design, they'll be able to do this.
  2. The database back-end. This is the part that stores user information, classes, and much more.

You have nearly complete control over the front-end, while back-end code is maintained by our Web team.

Front-End

The graphics and content of your site can be edited in several ways:

  • The easiest is editing "Quasi-static data," or "QSD," which just refers to text on the website. If you're logged in as an administrator, just click the Edit link or in the box with a dotted outline, and you'll be editing the content on the page. (More info.)
  • The media files for the website (images, CSS stylesheets) can be added or modified by using the file browser at https://[yoursite].learningu.org/admin/filebrowser/browse/.
  • The HTML templates that are used to generate pages can be overridden at https://[yoursite].learningu.org/admin/utils/templateoverride/. You can set the appearance of every page on your site by editing a single template override (main.html).

Managing a Program

Theory/background...

How to...

In general, "test everything you want to use." In particular, important tests are:

Printables

How to...

Website Content

How to...

Managing Users

How to...

Back-End

Some newer documentation is available at <https://github.com/learning-unlimited/ESP-Website/tree/main/docs/admin>.

The latest release notes are at <https://github.com/learning-unlimited/ESP-Website/tree/main/docs/admin/releases/06>.

To contact the web team with questions, problems, feature requests, etc. email <websupport@learningu.org>.

Submit feature requests and non-urgent bug reports to <https://docs.google.com/a/learningu.org/spreadsheet/viewform?usp=drive_web&formkey=dFlJcnJjVHJKSUdMYzNsTm9GNGNPRUE6MQ>.

Starting Out

Feature Requests

If you want to request a new feature or bug fix for the website, you have three choices:

  1. For anything that warrants discussion, e-mail your mentors or Web support e-mail list with a description of the issue.
  2. If you have a good idea of what you need, fill out our Google form here (responses are visible here)
  3. If you have detailed technical knowledge of the issue, file a ticket directly on Github:
    • Go to https://github.com/learning-unlimited/ESP-Website/issues
    • Click "New Issue"
    • Provide a short descriptive title of the issue, and a detailed description (e.g. exactly how to reproduce a problem, or exactly what you want a new feature to look like). Click "Submit New Issue."
    • Associate any relevant labels with the ticket (e.g. Error, UserInterface, Enhancement, Performance).

Miscellaneous

How to...