2013-01-22 01:16:29 +08:00
|
|
|
# What goes in this file:
|
|
|
|
|
# * local canvas configuration (db, ymls, overrides, etc.)
|
|
|
|
|
# * generated/cached stuff (docs, css, js, uploads, etc.)
|
|
|
|
|
#
|
|
|
|
|
# What does NOT go in this file
|
|
|
|
|
# * editor-related stuff
|
|
|
|
|
# * random scripts only used by you
|
|
|
|
|
# * env-specific stuff (e.g. .DS_Store)
|
|
|
|
|
# * pretty much any dotfile not already covered (e.g. .rvmrc)
|
|
|
|
|
#
|
|
|
|
|
# That's what .git/info/exclude and core.excludesfile are for :)
|
|
|
|
|
|
2014-02-01 07:52:04 +08:00
|
|
|
.bundle/
|
2013-01-22 01:16:29 +08:00
|
|
|
/.yardoc/
|
2013-09-07 04:16:57 +08:00
|
|
|
/app/coffeescripts/ember/*/main.coffee
|
2013-03-20 00:58:55 +08:00
|
|
|
/app/views/info/styleguide.html.erb
|
A new way of doing css/sass & New Canvas Theme Editor
what this does:
* Changes the way we generate css so we are able to generate custom
css for people that use the theme editor.
* Sets everything up so we can push all of our static assets
(js, fonts, css, images, etc) to s3 pre-deploy and serve them
from cloudfront. Yay! faster canvas for everyone!
* as part of that, this enables the rails asset pipeline just so we
can use it to put md5s in our urls. we don't use it for any of the
coffeescript/sass/sprockets transformer stuff.
* adds a new "Theme editor" functionality (only for people that have
have the use-new-styles feature flag turned on) where an admin for
an account can pick their own colors/images for all the users
at their account/school.
* when the user is done saving things in theme editor, it will,
in a delayed job, generate all the css with against the variables
that user specified and push it to s3 so it will be available to
anyone else that requests it. (the delayed job will shell
out to a node.js executable called `brandable_css`).
* ability to pick an existing shared theme and to reset to
blank theme. closes: CNVS-19685
* gets rid of jammit.
test plan:
(this is exaustive, so not every person has to do every step
but we should make sure at least someone does each of these things.
maybe as part of the review add a comment if you have done one of these
bulletpoints)
* before you check this out, compile all css and copy the
public/stylsheets_compiled directory somewhere. after you check out
this code and regenerate all the css. make sure there are no
significant changes to the css output. (we updated the versions of
node-sass and autoprefixer that we use so we want to make sure they
don't change things in a way we weren't expecting)
* make sure the way we load css for handlebars templates still works.
eg: if there is a handlebars template at
app/views/jst/some/template.handlebars
if there is also a scss file at
app/stylesheets/jst/some/template.scss
then that stylesheet should get loaded when that template is rendered
* check out the code and run migrations. browse around canvas,
make sure css and js files load correctly as before.
* cody, jacob, or someone on queso: look at the db migrations and
make sure everything looks good and that I am handling sharding
correctly.
* verify that both rake canvas:compile_assets and guard, works as well
as `node_modules/.bin/brandable_css` (note: if you have
"node_modules/.bin" in your PATH (which you should), it will also
work with just `brandable_css`)
* verify that passing the --watch option to
`.bin/node_modules/brandable_css` works and picks up changes to
sass files, images, fonts, or any other resource that goes into
a css file. and that it only recompiles the css files that actually
depend on that file.
* go to https://github.com/ryankshaw/brandable_css and check out the
code there. that is what is actually doing the sass compiling
* create a config/canvas_cdn.yml file and add aws access creds and
an s3 bucket and cdn hostname (for testing, you can use the credentials
for instructure_uploads_engineering from
https://gollum.instructure.com/OtherServiceTestAccounts ). for a test
cdn hostname you can use https://diu0rq5m1weh1.cloudfront.net. that
is a cloudfront bucket I set up on my personal account that points to
instructure_uploads_engineering
* run rake canvas:compile_assets again, this time, at the end, you
should see it run the assets:precompile task that puts md5s in filenames
and, gzipps them, and copys them to public/assets.
then you should see it run canvas:cdn:upload_to_s3
(look at log/development.log for progress),
which pushes everything to s3.
closes: CNVS-17333 CNVS-17430 CNVS-17337
* try out the theme editor: turn on new styles, go to accounts/x
(where x is the @domain root acount you are testing from) and click
the "theme editor" button on the right side of the page.
that should take you to a page that has the ability to pick colors/images
on the left side and preview your changes in an iframe on the right
closes: CNVS-19360 CNVS-20551
* test the "preview", "save", "reset", and "choose existing" functionality
closes: CNVS-17339 CNVS-17338 CNVS-19685
* make sure that the themeeditor works both if you have
config/canvas_cdn.yml set up and enabled as well as if you don't.
if it is enabled, you should see it push the css for just that new
brand config to s3 when you hit preview, and the css
should be accessible from the cdn you configured.
Change-Id: Ie0a812d04f5eeb40e7df7e71941ff63ea51a4d22
Reviewed-on: https://gerrit.instructure.com/53873
Tested-by: Jenkins
QA-Review: Jeremy Putnam <jeremyp@instructure.com>
Reviewed-by: Jacob Fugal <jacob@instructure.com>
Product-Review: Ryan Shaw <ryan@instructure.com>
2015-02-12 03:51:05 +08:00
|
|
|
app/stylesheets/_brandable_variables_defaults_autogenerated.scss
|
|
|
|
|
app/stylesheets/brandable_css_brands
|
2013-01-22 01:16:29 +08:00
|
|
|
/config/*.yml
|
|
|
|
|
/config/build.js
|
|
|
|
|
/config/environments/*-local.rb
|
2014-04-24 00:57:32 +08:00
|
|
|
/config/locales/generated/
|
2014-10-16 02:50:10 +08:00
|
|
|
/config/RAILS4
|
2015-03-10 03:34:59 +08:00
|
|
|
/coverage/
|
2013-01-22 01:16:29 +08:00
|
|
|
/db/schema.rb
|
|
|
|
|
/db/*.sqlite*
|
|
|
|
|
/db/*sql
|
|
|
|
|
/exports/
|
2014-02-01 07:52:04 +08:00
|
|
|
Gemfile.lock
|
2014-07-17 23:52:07 +08:00
|
|
|
Gemfile.lock2
|
2014-03-20 12:27:41 +08:00
|
|
|
Gemfile.lock3
|
2014-07-02 02:32:06 +08:00
|
|
|
Gemfile.lock4
|
2013-01-22 01:16:29 +08:00
|
|
|
/log/
|
2014-10-16 02:50:10 +08:00
|
|
|
/node_modules
|
A new way of doing css/sass & New Canvas Theme Editor
what this does:
* Changes the way we generate css so we are able to generate custom
css for people that use the theme editor.
* Sets everything up so we can push all of our static assets
(js, fonts, css, images, etc) to s3 pre-deploy and serve them
from cloudfront. Yay! faster canvas for everyone!
* as part of that, this enables the rails asset pipeline just so we
can use it to put md5s in our urls. we don't use it for any of the
coffeescript/sass/sprockets transformer stuff.
* adds a new "Theme editor" functionality (only for people that have
have the use-new-styles feature flag turned on) where an admin for
an account can pick their own colors/images for all the users
at their account/school.
* when the user is done saving things in theme editor, it will,
in a delayed job, generate all the css with against the variables
that user specified and push it to s3 so it will be available to
anyone else that requests it. (the delayed job will shell
out to a node.js executable called `brandable_css`).
* ability to pick an existing shared theme and to reset to
blank theme. closes: CNVS-19685
* gets rid of jammit.
test plan:
(this is exaustive, so not every person has to do every step
but we should make sure at least someone does each of these things.
maybe as part of the review add a comment if you have done one of these
bulletpoints)
* before you check this out, compile all css and copy the
public/stylsheets_compiled directory somewhere. after you check out
this code and regenerate all the css. make sure there are no
significant changes to the css output. (we updated the versions of
node-sass and autoprefixer that we use so we want to make sure they
don't change things in a way we weren't expecting)
* make sure the way we load css for handlebars templates still works.
eg: if there is a handlebars template at
app/views/jst/some/template.handlebars
if there is also a scss file at
app/stylesheets/jst/some/template.scss
then that stylesheet should get loaded when that template is rendered
* check out the code and run migrations. browse around canvas,
make sure css and js files load correctly as before.
* cody, jacob, or someone on queso: look at the db migrations and
make sure everything looks good and that I am handling sharding
correctly.
* verify that both rake canvas:compile_assets and guard, works as well
as `node_modules/.bin/brandable_css` (note: if you have
"node_modules/.bin" in your PATH (which you should), it will also
work with just `brandable_css`)
* verify that passing the --watch option to
`.bin/node_modules/brandable_css` works and picks up changes to
sass files, images, fonts, or any other resource that goes into
a css file. and that it only recompiles the css files that actually
depend on that file.
* go to https://github.com/ryankshaw/brandable_css and check out the
code there. that is what is actually doing the sass compiling
* create a config/canvas_cdn.yml file and add aws access creds and
an s3 bucket and cdn hostname (for testing, you can use the credentials
for instructure_uploads_engineering from
https://gollum.instructure.com/OtherServiceTestAccounts ). for a test
cdn hostname you can use https://diu0rq5m1weh1.cloudfront.net. that
is a cloudfront bucket I set up on my personal account that points to
instructure_uploads_engineering
* run rake canvas:compile_assets again, this time, at the end, you
should see it run the assets:precompile task that puts md5s in filenames
and, gzipps them, and copys them to public/assets.
then you should see it run canvas:cdn:upload_to_s3
(look at log/development.log for progress),
which pushes everything to s3.
closes: CNVS-17333 CNVS-17430 CNVS-17337
* try out the theme editor: turn on new styles, go to accounts/x
(where x is the @domain root acount you are testing from) and click
the "theme editor" button on the right side of the page.
that should take you to a page that has the ability to pick colors/images
on the left side and preview your changes in an iframe on the right
closes: CNVS-19360 CNVS-20551
* test the "preview", "save", "reset", and "choose existing" functionality
closes: CNVS-17339 CNVS-17338 CNVS-19685
* make sure that the themeeditor works both if you have
config/canvas_cdn.yml set up and enabled as well as if you don't.
if it is enabled, you should see it push the css for just that new
brand config to s3 when you hit preview, and the css
should be accessible from the cdn you configured.
Change-Id: Ie0a812d04f5eeb40e7df7e71941ff63ea51a4d22
Reviewed-on: https://gerrit.instructure.com/53873
Tested-by: Jenkins
QA-Review: Jeremy Putnam <jeremyp@instructure.com>
Reviewed-by: Jacob Fugal <jacob@instructure.com>
Product-Review: Ryan Shaw <ryan@instructure.com>
2015-02-12 03:51:05 +08:00
|
|
|
/public/dist/
|
2013-01-22 01:16:29 +08:00
|
|
|
/public/doc/api/
|
|
|
|
|
/public/javascripts/compiled/
|
|
|
|
|
/public/javascripts/jst/
|
2014-10-10 06:56:09 +08:00
|
|
|
/public/javascripts/jsx/
|
2013-01-22 01:16:29 +08:00
|
|
|
/public/javascripts/translations/
|
2015-10-06 00:53:40 +08:00
|
|
|
/public/javascripts/**/*.gz
|
2013-01-22 01:16:29 +08:00
|
|
|
/public/optimized/
|
2015-10-06 00:53:40 +08:00
|
|
|
/public/vendor/tinymce_themes/**/*.gz
|
2014-10-16 02:50:10 +08:00
|
|
|
/spec/javascripts/compiled/
|
|
|
|
|
/spec/javascripts/requirejs_config.js
|
2013-10-25 04:37:48 +08:00
|
|
|
/spec/javascripts/runner.html
|
2014-01-24 23:58:37 +08:00
|
|
|
/spec/javascripts/tests.js
|
2013-01-22 01:16:29 +08:00
|
|
|
/tmp/
|
2013-03-21 04:30:20 +08:00
|
|
|
/vendor/plugins/rails_upgrade
|
2015-01-24 07:40:01 +08:00
|
|
|
npm-debug.log
|
2015-08-05 22:41:50 +08:00
|
|
|
mkmf.log
|
2014-12-10 06:46:27 +08:00
|
|
|
/vendor/bundle
|
2013-01-22 01:16:29 +08:00
|
|
|
|
|
|
|
|
# generated plugin stuff
|
|
|
|
|
/app/coffeescripts/plugins/
|
|
|
|
|
/app/stylesheets/plugins/
|
|
|
|
|
/app/views/jst/plugins/
|
|
|
|
|
/public/javascripts/plugins/
|
|
|
|
|
/public/plugins/
|
|
|
|
|
/spec/coffeescripts/plugins/
|
2013-10-25 04:37:48 +08:00
|
|
|
/spec/plugins/
|
2014-04-10 04:41:41 +08:00
|
|
|
|
2014-10-16 02:50:10 +08:00
|
|
|
# generated client app stuff
|
client app: canvas_quiz_statistics
This commit brings in canvas_quiz_statistics, a client app that can be
embedded in Canvas.
Closes CNVS-14781, CNVS-14846, CNVS-14847, CNVS-14850
> What's done
- full build integration, meaning the app runs with ?optimized_js=1:
+ JavaScript "built" source gets piped into the r.js build pipeline
like any other Canvas JS source in public/javascripts/*
+ SCSS sources get picked up by the sass-compiler like Canvas style
sources and they get compiled from the grounds-up
+ I18n: phrases are extracted properly, with default values and
options, by our i18n rake tasks
- new rake task js:build_client_apps that builds client apps and
injects them as input to the rest of the JS build process
- support for using Canvas JS packages, like d3, jQuery, and Backbone
- support for using Canvas SASS variables & helpers
- super i18n support: use raw I18n.t() calls like you are in Canvas,
with development-time interpolation, as well as super new
Handlebars-like block-style translations in React, perfect for very
long phrases (mini-articles)
> Docs and References
The code was originally developed in its own github repository. While I
won't be pushing code to that repo anymore, the Wiki will still house
the docs until we find a better place.
- Repo: https://github.com/amireh/canvas_quiz_statistics
- Development guide: http://bit.ly/1sNOhER
- Integration guide: http://bit.ly/1m9kA9V
> TESTING
- login as a teacher
- go to /courses/:course_id/quizzes/:quiz_id/statistics_cqs
+ make sure you see something that looks like the Ember stats
+ click one of those little "?" help icons, you get a dialog:
- verify the contents within the dialog are actual English text,
not code gibberish
- there's also a link at the end of that dialog, click it and
verify it takes you to an Instructure help article
- build the assets: `bundle exec rake canvas:compile_assets` then:
+ add ?optimized_js=1 to the URL and reload the page:
- verify the app still works
Change-Id: Ic474650dfb06a1c22869ed9680dd04d1ca0f651d
Reviewed-on: https://gerrit.instructure.com/39105
Tested-by: Jenkins <jenkins@instructure.com>
Reviewed-by: Hannah Bottalla <hannah@instructure.com>
Reviewed-by: Adam Ard <aard@instructure.com>
QA-Review: Trevor deHaan <tdehaan@instructure.com>
Product-Review: Ahmad Amireh <ahmad@instructure.com>
2014-08-06 15:04:23 +08:00
|
|
|
/public/javascripts/client_apps/
|
|
|
|
|
|
2014-10-16 02:50:10 +08:00
|
|
|
# remove this once we move jquery into bower
|
2014-04-10 04:41:41 +08:00
|
|
|
/public/javascripts/bower/jquery/
|
|
|
|
|
|
2014-10-16 02:50:10 +08:00
|
|
|
# canvas-gems
|
2014-04-20 16:22:49 +08:00
|
|
|
/gems/*/coverage
|
|
|
|
|
/gems/*/tmp
|