Commit 793354a0 by Victor Shnayder

remove (almost) all references to askbot.

parent 7966c18d
......@@ -9,8 +9,6 @@
.AppleDouble
database.sqlite
courseware/static/js/mathjax/*
db.newaskbot
db.oldaskbot
flushdb.sh
build
.coverage
......
[submodule "askbot"]
path = askbot
url = git@github.com:MITx/askbot-devel.git
syntax: glob
*.pyc
*~
*.scssc
*.swp
*.orig
*.DS_Store
database.sqlite
courseware/static/js/mathjax/*
db.newaskbot
db.oldaskbot
flushdb.sh
Subproject commit e56ae380846f7c6cdaeacfc58880fab103540491
......@@ -3,6 +3,8 @@ Models for Student Information
Replication Notes
TODO: Update this to be consistent with reality (no portal servers, no more askbot)
In our live deployment, we intend to run in a scenario where there is a pool of
Portal servers that hold the canoncial user information and that user
information is replicated to slave Course server pools. Each Course has a set of
......
......@@ -388,7 +388,7 @@ class XModuleDescriptor(Plugin, HTMLSnippet, ResourceTemplates):
entry_point = "xmodule.v1"
module_class = XModule
# Attributes for inpsection of the descriptor
# Attributes for inspection of the descriptor
stores_state = False # Indicates whether the xmodule state should be
# stored in a database (independent of shared state)
has_score = False # This indicates whether the xmodule is a problem-type.
......
......@@ -72,12 +72,6 @@ clone_repos() {
git clone git@github.com:MITx/mitx.git
fi
if [[ ! -d "$BASE/mitx/askbot/.git" ]]; then
output "Cloning askbot as a submodule of mitx"
cd "$BASE/mitx"
git submodule update --init
fi
# By default, dev environments start with a copy of 6.002x
cd "$BASE"
mkdir -p "$BASE/data"
......@@ -330,9 +324,6 @@ pip install -r mitx/pre-requirements.txt
output "Installing MITx requirements"
cd mitx
pip install -r requirements.txt
output "Installing askbot requirements"
pip install -r askbot/askbot_requirements.txt
pip install -r askbot/askbot_requirements_dev.txt
mkdir "$BASE/log" || true
mkdir "$BASE/db" || true
......
......@@ -27,7 +27,7 @@ You should be familiar with the following. If you're not, go read some docs...
- CMS -- Course Management System. The instructor-facing parts of the system. Allows instructors to see and modify their course, add lectures, problems, reorder things, etc.
- Askbot -- the discussion forums. We have a custom fork of this project. We're also hoping to replace it with something better later. (e.g. need support for multiple classes, etc)
- Forums -- this is a ruby on rails service that runs on Heroku. Contributed by berkeley folks. The LMS has a wrapper lib that talks to it.
- Data. In the data/ dir. There is currently a single `course.xml` file that describes an entire course. Speaking of which...
......
......@@ -9,7 +9,6 @@ There is also a script "create-dev-env.sh" that automates these steps.
mkdir ~/mitx_all
cd ~/mitx_all
git clone git@github.com:MITx/mitx.git
git clone git@github.com:MITx/askbot-devel
hg clone ssh://hg-content@gp.mitx.mit.edu/data
2) Install OSX dependencies (Mac users only)
......@@ -49,8 +48,6 @@ There is also a script "create-dev-env.sh" that automates these steps.
source ~/mitx_all/python/bin/activate
cd ~/mitx_all
pip install -r askbot-devel/askbot_requirements.txt
pip install -r askbot-devel/askbot_requirements_dev.txt
pip install -r mitx/pre-requirements.txt
pip install -r mitx/requirements.txt
......
=============================
Customization of Askbot skins
=============================
The default skin at the moment is in the development, however
it is already possible to start customizing your site without
incurring much maintenance overhead.
Current status of templates
===========================
The two busiest templates are - the "main" page and the "question" page,
the main page is more or less complete. "Question" page will be significantly
refactored in the near future.
How skins work in Askbot
========================
The skins reside in up to two directories:
* `askbot/skins` in the source code (contains any stock skins)
* directory pointed to by a ASKBOT_EXTRA_SKINS_DIR in your settings.py
with any other skins
Currently, the skin is selected by the site administrator in the live settings.
Also, at the moment skin default is special - it serves any resources
absent in other skins. In a way - all other skins inherit from the "default".
Templates and media are resolved in the following way:
* check in skin named as in settings.ASKBOT_DEFAULT_SKIN
* then skin named 'default'
How to customize a skin
=======================
There are three options:
* edit custom css via the settings interface - good for small tweaks
(no need to directly log in to the server)
* create a new skin in separate files (need direct access to the server
files, more maintenance overhead)
* directly modify the "default" skin (as in the previous option - need
direct access to the server, less maintenance overhead, some
knowledge of git system is required)
The first option only allows to modify css and add custom javascript.
The latter two options allow changing the templates as well.
If you wish to follow the second option, create a directory named the same
way as the skin you are building and start adding files with the same names
and relative locations as those in the "default" skin.
NO NEED TO CREATE ALL TEMPLATES/MEDIA FILES AT ONCE as your skin will inherit
pieces from the "default".
The disadvantage of thil second approach is that you will be on your own maintaining
the synchrony of your template, stylesheet and the core code.
Third approach is the best, but it requires (the most basic) use of
git source code management software. With git you will easily merge the updates
from the development repository.
Structure of the skin directories
=================================
Todo.
To simplify maintenance of the css as the skin is being developed,
populate css file `media/style/extra.css` with any rules that will
override those in the `media/style/style.css` file. If you do that
media does not have to be composed of files named the same way as in default skin
whatever media you link to from your templates - will be in operation
This source diff could not be displayed because it is too large. You can view the blob instead.
This source diff could not be displayed because it is too large. You can view the blob instead.
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment