Coder Social home page Coder Social logo

orientation / orientation Goto Github PK

View Code? Open in Web Editor NEW
361.0 361.0 73.0 6.19 MB

Your best weapon in the fight against outdated documentation.

Home Page: http://orientation.io

License: MIT License

Ruby 57.86% CoffeeScript 7.17% HTML 1.67% JavaScript 0.35% Dockerfile 0.52% Shell 1.37% Sass 19.14% SCSS 2.84% Haml 9.08%
documentation rails ruby

orientation's People

Contributors

aimeebooth avatar aj-foster avatar benmanns avatar brandonmathis avatar brupm avatar calebsylvest avatar cmckni3 avatar craigkerstiens avatar dependabot-preview[bot] avatar dependabot-support avatar dependabot[bot] avatar drewbarontini avatar friism avatar fusion2004 avatar greysteil avatar hashrocketeer avatar jefmathiot avatar jmonteiro avatar joeltaylor avatar johndjameson avatar joshvc avatar mattpolito avatar mclosson avatar michaelherold avatar olivierlacan avatar prayagverma avatar renz45 avatar rjclardy avatar tonyta avatar yassskitt avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

orientation's Issues

Sign-in for development

Codez involving current_user are difficult to test without the ability to log in. Is it possible to get our auth system working in development?

updated_at date is wrong

I know for a fact Arron didn't update this in January:

image

Oddly enough fresh? returned true which means internally the updated_at isn't January 3rd, so that must be a view bug.

Make the app more browseable?

I think we may have more success with orientation as browsable documentation rather than keeping it search-centric. This may be as simple as a styling change.

So, perhaps try moving the ToC-like thing on the right over to the larger column in the left, and show every article (rather than cutting off the list). Then move search over to the right.

Could also take the time to categorize everything, though better to test the thought before we put lots of work into it. :)

Add Archive section to Orientation

It would be nice to archive articles instead of deleting them altogether.

I think I'm hesitant to delete articles because they still contain helpful tidbits even if they're stale.

For example, this article on Adding Student Discounts is super simple. And this old version probably doesn't need to be there.

But it's still worth keeping an archive of old articles to see how things used to work. Another example is that most courses are running on BlueBox now, but the stale Heroku articles still have practical applications to both Try Ruby and Try Git.

Github auth

Github authentication that allows anyone in who is part of the codeschool team would awesome for al our tools. Might even be a good way to determine admin status on codeschool as well.

Investigate long-running timeout issues

This has been happening for as long as I can remember. I probably screwed something up somewhere.

Exit timeout: Heroku/codeschool-orientation 

2013-10-10 18:10:08.436 
188 <45>1 2013-10-10T18:10:08.368414+00:00 heroku web.1 - - Error R12 (Exit timeout) -> At least one process failed to exit within 10 seconds of SIGTERM 

Go to the log: https://api.heroku.com/myapps/[email protected]/addons/logentries 

You are receiving this email because your Logentries alarm "Exit timeout" 
has been triggered. 

In context: 
2013-10-10 18:10:02.856 187 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - I, [2013-10-10T18:01:54.254085 #2] INFO -- : Completed 302 Found in 1ms (ActiveRecord: 0.0ms) 
2013-10-10 18:10:02.877 207 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - I, [2013-10-10T18:06:54.320438 #2] INFO -- : Started GET "/login" for 108.62.115.226 at 2013-10-10 18:06:54 +0000 
2013-10-10 18:10:02.877 183 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - I, [2013-10-10T18:06:54.322552 #2] INFO -- : Processing by SessionsController#new as HTML 
2013-10-10 18:10:02.877 255 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - I, [2013-10-10T18:06:54.324425 #2] INFO -- : Redirected to http://orientation.codeschool.com/auth/google_oauth2?origin=http%3A%2F%2Forientation.codeschool.com%2F 
2013-10-10 18:10:02.877 187 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - I, [2013-10-10T18:06:54.324896 #2] INFO -- : Completed 302 Found in 2ms (ActiveRecord: 0.0ms) 
2013-10-10 18:10:02.877 100 <13>1 2013-10-10T18:10:02.683864+00:00 app web.1 - - Exiting 
2013-10-10 18:10:06.718 108 <13>1 2013-10-10T18:10:06.642627+00:00 app web.2 - - => Booting Thin 
2013-10-10 18:10:06.816 165 <13>1 2013-10-10T18:10:06.642627+00:00 app web.2 - - => Rails 4.0.0 application starting in production on http://0.0.0.0:9887 
2013-10-10 18:10:06.816 142 <13>1 2013-10-10T18:10:06.642627+00:00 app web.2 - - => Run `rails server -h` for more startup options 
2013-10-10 18:10:06.816 121 <13>1 2013-10-10T18:10:06.642627+00:00 app web.2 - - => Ctrl-C to shutdown server 
2013-10-10 18:10:08.436 188 <45>1 2013-10-10T18:10:08.368414+00:00 heroku web.1 - - Error R12 (Exit timeout) -> At least one process failed to exit within 10 seconds of SIGTERM 

Stale article notification bug

Orientation is sending multiple emails with the same article listed. My hypothesis is that it's looping through the correct number of stale articles, but only grabbing the first one and sending a separate email for each of them.

Create Staging Environment

@olivierlacan was kind enough to set up orientation-staging on Heroku.

A few other things that would be Super Awesome:

  • Configuring Bugsnag to report only production errors (or creating a separate Bugsnag whatnot for staging errors)
  • Configuring Mandrill to send mail in the staging environment

These are mostly notes to self for now. I may end up adding to this issue or deleting it entirely.

Allow users to configure which emails they want to receive

It'd be nice to allow for an option to not receive emails from Orientation. I'd like "Some of your Orientation articles might be stale". For now I just have a filter to skip inbox/archive for these emails, but if people want to have this and stay up to date on them, it'd be nice to be able to enable/disable this depending on if the person has time to update articles.

"No results"

We need to say when no results are available when searching otherwise it leaves a weird feeling that maybe search doesn't work right.

image

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.