Difference between revisions of "How to use the website"

From LU
Jump to: navigation, search
 
Line 1: Line 1:
[[Category:Website Resources]]
 
[[Category:Splash Manual]]
 
 
{{good}}
 
 
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>.
 
 
==The Website: A Quick Overview==
 
 
 
What we call the "website" actually consists of two separate (but interacting) parts:
 
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 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.
 
# 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.
  
You have nearly complete control over the front-end, while back-end code is maintained by our Web team.  The graphics and content of your site can be edited in several ways:
+
==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. ([[Edit_the_text_of_web_pages#Editing_a_webpage|More info]].)
 
* 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 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).
 
* 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).
  
=== Feature Requests ===
+
=== Managing a Program ===
 
+
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).
+
 
+
==Starting Out==
+
 
+
* [[Starting a site]] (non-technical first steps for new chapters)
+
* [[Launching A New Website Installation]] (slightly technical steps for brand-new sites)
+
 
+
== Managing a Program ==
+
  
 
Theory/background...  
 
Theory/background...  
Line 78: Line 49:
 
*[[Pre-program testing|Before the program runs]]
 
*[[Pre-program testing|Before the program runs]]
  
==Website Output==
+
===Printables===
  
 
How to...
 
How to...
Line 88: Line 59:
 
* [[Print door signs for classroom schedules]]
 
* [[Print door signs for classroom schedules]]
 
* [[Print administrator information]]
 
* [[Print administrator information]]
* Customize various printables with [[template overrides]]
+
* [[Customize student schedules]] and other printables: [[template overrides]]
* [[Customize student schedules]] (see also [[template overrides]])
+
 
* [[Sort printables in a different order]]
 
* [[Sort printables in a different order]]
 
* [[Customize a printable catalog]]
 
* [[Customize a printable catalog]]
  
==Website Content==
+
===Website Content===
  
 
How to...
 
How to...
Line 105: Line 75:
 
* [[Customize the graphic design]] (includes information on templates)
 
* [[Customize the graphic design]] (includes information on templates)
  
==Managing Users==
+
===Managing Users===
  
 
How to...
 
How to...
Line 117: Line 87:
 
* [[Give someone administrator access]]
 
* [[Give someone administrator access]]
 
* [[Check a student in]]
 
* [[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==
Line 126: Line 123:
 
* [[Dev server setup script]]
 
* [[Dev server setup script]]
  
== Continue Reading on [[How to design a chapter website]] ==
+
* 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...