Skip to content

Instantly share code, notes, and snippets.

@jendiamond
Last active December 20, 2015 17:29
Show Gist options
  • Save jendiamond/6169493 to your computer and use it in GitHub Desktop.
Save jendiamond/6169493 to your computer and use it in GitHub Desktop.
Bundler Website/Documentation

General Notes

  1. Each page except the main page could have a small bundler logo at the top left as an index/HOME link
  2. A side Bar would be very useful
  3. There are 11 Learn More Pages - This needs it's own Link - Perhaps in side Bar and in the Learn About section
  4. There are 6 Man Pages - This needs it's own Link - Perhaps in side Bar and in the Learn About section
  5. There are a lot of horizontal rule tags separating the page sections which looks cluttered and a bit confusing. I think the pages just need to be broken down into smaller bits than using anchor tags to move around. It will make the information clearer and easier to navigate.

Site Breakdown with Notes


Would you like to

Notes

  1. Maybe you don't need the heading "Would you like to" if these are the only buttons on this page. You could add; "Read Man Pages" and "Get Involved"

Get Started

Notes

  1. Needs to have it's own page

Links on the Page
Learn More: Gemfiles
Learn More: bundle install
Learn More Bundler.Setup
Learn More Executables This is a man page.


Report a Bug

Notes

  1. Maybe it should link to a page that explains a bit about reporting a bug or th entire ISSUES.md with a link to the ISSUES.md Similar to how the "What's new Page links to the CHANGELOG

What's New

Notes

  1. The heading "What's New" on the What's New page could stand to be a larger header tag than the rest so it is clear that what is below is a list of what is actually new.

Links on the Page
CHANGELOG


Read Documentation

Notes

  1. Needs it's own page.

Use Bundler with

Notes

  1. This could be called Bundler with ??
  2. Each page ie: Rails 3, Rails 2.3, Sinatra, needs it's own top bar or some kind of link back to the Read Documentation section and the ability to go to the other choices from that page; links to Rails 2.3 Sinatra Rubygems and RubyMine from the Rails 3 page

Rails 3

Links on the Page
Learn More Groups

Rails 2.3

Notes
  1. The Learn More Rails 3 button links to an tag in the Rails 3 Guide. To clarify what you are aiming to show maybe there could be a note in the Rails 3 guide or just include that info in the Rails 2.3 guide.

Links on the Page
Learn More Groups
Learn More Rails 3 This is an anchor tag to the Rails 3 Guide.

Sinatra

Ruby Gems

Ruby Motion


Learn About

Gemfile

Notes
  1. Can the info. on the Rubygems version specifiers link be included on a page within our site? and maybe refer to or link to that page as reference or source material?

Links on the Page
Gemfile Manual
Rubygems version specifiers This is an outside link.
Learn More Bundler.require
Learn More Rails Git
Learn More Groups
Learn More Rails Directive

Installing

Links on the Page

Learn More Bundler Setup
Learn More Bundler.require
Learn More Groups
Learn More Deploying

Updating

Installing

Links on the Page

Learn More Packing
Learn More Executables This is a man page.
Heroku Bundler Documentation This is an outside link.

Gems from Git

Other Commands

Notes
  1. Should this button be called Command Line Reference
  2. This might be good to have in the side bar

Why Bundler Exists

The Man Pages

Notes
  1. There are several man pages. Maybe this should link to a page that has links to all the man pages.

a. Gemfile manual
b. install
c. update
d. exec
e. confi
f. packag
g. bundle


Get Involved

#bundler on IRC

Connects to an invite to join the IRC channel

Mailing List

Connects to the Google Groups Page

Contributing

404 Page

Core Team

Notes

  1. Maybe this should go to the Contributors page and have a link on that page to sign up or make that button more clear in it's title like: Sign up for Blog posts Not sure but it is a misleading button.

Bundler Dev Swag

Notes

  1. This would probably be better in a side bar

Footer Bar with Panda & Fluffy Yak

Notes

  1. These are all duplicated in other places and are incomplete lists. It seems like it would be better to make them complete lists and include them in other area. Then the footer could be used for a real navigation bar.

Commands

Man pages for install, update, exec, config, and package. Does Not include all the man pages.

Usage

"Learn More" links. Does Not include all the Learn More links.

This could use it's own page or be combined into another page.

Frameworks

This is the same as the "Use Bundler with" section except that it is missing Rails 2.3

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment