Giter VIP home page Giter VIP logo

rails_tutorial's Introduction

Bmore On Rail Workshop Tutorial

This site is created using jekyll. If you're struggling to find information here, more can be found there.

Contributing

If you're interested in contributing YAY! and THANK YOU! Please fork this repo and submit any changes as a pull request.

Up and Running

Before you get started, make sure you have the Ruby version specified in .ruby-version installed locally.

Then, clone the repo and run bundle install.

Now, you can get the site up and running locally by running jekyll serve. You can view the running site by going to http://localhost:4000/rails_tutorial/. (Note that the trailing slash is not optional.)

Caveats

Links

The config value open_links_in_new_tab in config.yml results in all links opening in a new tab. You can override this behavior on individual links by setting the target attribute back to the default value (_self) or if you just don't want the thing to work that way, remove that config value or set it to false.

Deploying

First, checkout master and pull the latest changes.

git checkout master
git pull origin master

Then, run rake prepare_deploy.

rake prepare_deploy

When the task finishes, you'll be on the gh-pages branch. There will be a new commit for the changes you're deploying. If everything looks good, push the changes.

git push origin gh-pages

rails_tutorial's People

Contributors

alexfu avatar alimi avatar angeliquejw avatar brigittewarner avatar enviable avatar jgaskins avatar kbladow avatar malissaromero avatar michellemartir avatar nerded avatar oliikit-test avatar paulostazeski avatar solipet avatar vaidehijoshi avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar

rails_tutorial's Issues

Style the landing page.

We don't have a design for the tutorial landing page :-( Right now it looks like this:

screen shot 2017-01-07 at 9 02 31 pm

Totally depressing. It doesn't have to be crazy - just a little more inspiring.

Finalize install instructions

@solipet I'm not going to review the install instructions. I trust ya'll to get this looking sharp and ready to go. Just ping me when you feel good about them and I'll merge them for you since master is protected.

If ya'll want more eyes on them ping people in slack and basecamp. If you don't mind, it'd be super helpful if you could merge them together into one pr when you feel like they're ready.

Make shadow box for screenshots

Most of the screenshots throughout the tutorial have really really small text. As a student, I'd really like to be able to click the screenshot and view it larger in a shadowbox.

Get fonts and jquery loading locally

currently we're using urls to access Google Fonts and JQuery ... which is kinof a bummer when your a dev and your internet is sucking. It's also an unnecessary web request.

Make the syntax colors less awful

There is a syntax.scss file that I copied from GH in there that you can start with. The markup might be a little inaccurate in spots with regard to the language in the block - so be sure to check which language is indicated and change that if you need to.

"Reviews" missing "s" in Ch. 9 Step 40 and Ch. 11 Step 20

Chapter 9, Step #40:
Spend some time playing around with this relationship. You can do things like my_first_book.reviews.first or my_first_book.review.pluck(:body).
like my_first_book.reviews.first or my_first_book.review.pluck(:body).
To find a complete list of all the things you can do, take a look at the documentation here.

The second command should be "my_first_book.reviews.pluck(:body)"

[Note the plural of "review" instead of the singular.]

Also, in Chapter 11, Step 20: http://localhost:3000/books/1/review/new should read http://localhost:3000/books/1/reviews/new (notice the "s" after reviews).

Fix the steps container's resizing issues

CSS is my enemy. The steps divs should look like this for tablet and desktop:

screen shot 2017-01-06 at 9 30 19 am

Then they should stack nicely - right now the white of the list segment is wrapping around the highlight box but they should both take up the full width of the parent steps div. Here's what it looks like now:

screen shot 2017-01-06 at 9 30 31 am

Also - on larger screens the two child divs pull apart with a gutter between them - that shouldn't happen. Maybe we can just prevent the content div from going over a certain width so that we don't have to worry about large screens.

Chapter 9 has placeholder text

After some delightful copy about relational databases at the very end of this chapter, there's placeholder text for an image: add illustration here

All Gifs and images should be served locally.

There are gifs and images throughout the tutorial that are being sourced from the internet. They should be downloaded and served locally from our assets folder. Feel free to make an assets/images/gifs folder ... or something like that. You'll probably come up with a better name.

The menu should not be included everywhere

right now the tutorial menu is being included on pages that aren't part of the tutorial:

screen shot 2017-01-07 at 9 02 31 pm

screen shot 2017-01-07 at 9 06 22 pm

We could get rid of the menu on these pages totally and link to the rest of the site from the body .. maybe? But other ideas are welcome.

Ideally the menu on this index page would have a title and have links to Chapter 1 and the install instructions page.

support code fencing

right now code fencing aka:

code in here

doesn't work with language specific syntax highlighting.

Navigation Buttons

We need large forward and back buttons at the end of every chapter. It'd be nice to have some small, minimal ones in the nav too. They should drop off for smaller screen sizes.

Fix breakpoints for large screens.

The steps containers look broken on large monitors. Also - limit the width of the overall container so that stuff doesn't get too spread out.

This might already be fixed ...

Chapter 11 has broken image

<img src="screenshot.jpg" alt="Browser showing new book page">

does note exist, null, void, so much sadness.

Make chapter file names long

The chapter file name should be long so that it's more descriptive. HOWEVER!!! we don't want the urls to be long. This is totally doable by using the metadata in the chapter files but some research is needed to make it work.

Break up chapter 13

Chapter 13 introduces A TON!! and deal with a lot of different issues. I think we could break it up into 2 chapters and work on explaining sessions in a little more detail. But this is purely for V2 of the tutorial.

Add a search tool

There are some great js based search tools that cram all the site content into a json blob so that it can be searched even though the site is static. Our deployment process will support this type of static search. Let's add it because we love our students.

Here's one option: http://jekyll.tips/jekyll-casts/jekyll-search-using-lunr-js/

There are others out there.

Here's what the design has - feel free to make adjustments if you need to but this was the original design goal:

screen shot 2017-01-06 at 8 28 38 am

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.