Skip to content

Commit

Permalink
Adding results of the documentation sprint.
Browse files Browse the repository at this point in the history
git-svn-id: https://calagator.googlecode.com/svn/trunk@1167 54c6411d-1744-0410-a9eb-b99409f43359
  • Loading branch information
reidab committed Sep 20, 2008
1 parent 90d549a commit f235781
Show file tree
Hide file tree
Showing 4 changed files with 98 additions and 6 deletions.
76 changes: 75 additions & 1 deletion app/views/site/about.html.erb
Original file line number Diff line number Diff line change
@@ -1 +1,75 @@
Here is an about page, it tells us about Calagator.
<div class='copy_block'>
<h1><a name='about'>About Us</a></h1>
<h2>What</h2>

<p>Calagator is a unified calendar for the technology community of Portland, Oregon. We are an all-volunteer effort and encourage anyone to import, create, and edit events. Calagator also refers to the open source software running this site.</p>

<p>Calagator aggregates events so that users can visit a single source to discover interesting activities. Event planners use Calagator to check for possible scheduling conflicts, allowing them to make smarter decisions. Many people check it to find out what they could do this evening.</p>

<h2>Who</h2>

<p>Calagator grew from a broad technology community discussion about how we find and share local events. The Calagator project started in January 2008 with the formation of a mailing list, followed by an initial code sprint a few weeks later. We chose to build a public, non-commercial software project and website for sharing events.</p>

<p>Development of this project is focused around code sprint meetings. Because we used agile development methods from the start, we were able to share a functioning calendar site at the end of the first meeting. These practices help regular contributors share their knowledge of the project with new developers and reduce the barrier to entry. The application uses Ruby on Rails, but we actively encourage non-Ruby developers to participate. Our code sprints also involve community members who contribute design, project direction, and documentation.</p>

<h1>Getting Started</h1>
<h2><a name='find_local_events'>Find Local Events</a></h2>
<h3>Browse</h3>
<ul>
<li><a href='http://calagator.org/'>Browse an overview</a> of events for the next two weeks.</li>
<li><a href='http://calagator.org/events'>Browse events</a> in the future and past, and filter by date.</li>
<li><a href='http://calagator.org/venues'>Browse venues</a> and view future events occurring at each venue.</li>
</ul>

<h3>Search</h3>
<ul>
<li><strong>Search</strong> for events at the top of each page.</li>
</ul>

<h3>Export</h3>
<ul>
<li><strong>Subscribe</strong> to a list of events with your favorite calendar or feed reader.</li>
<li><strong>Send</strong> a single event to your favorite calendar.</li>
</ul>

<h2><a name='share_local_events'>Share Local Events</a></h2>

<ul>
<li><a href='http://calagator.org/events/new'>Add</a> an event by entering its details.</li>
<li><a href='http://calagator.org/sources/new/'>Import</a> event(s) by entering a URL to a feed or webpage, or via a bookmarklet.</li>
<li><strong>Improve</strong> content by editing events and venues.</li>
</ul>

<h1><a name='get_involved'>Get Involved</a></h1>
<p>Anyone can participate. There are no entrance requirements other than interest and enthusiasm for the project goals.</p>

<h3>Step 1: Sign up for the <a href='http://groups.google.com/group/pdx-tech-calendar/' title="PDX Tech Calendar on Google Groups">mailing list</a>.</h3>

<h3>Step 2: Contribute!</h3>
<h4>Use the site.</h4>
<ul>
<li><a href='#find_local_events'>Learn about</a> and <a href='#share_local_events'>share events</a>.</li>
<li>Spread the word! (<a href='http://twitter.com'>twitter</a>, your own blog, direct people to the events that you added above).</li>
</ul>

<h4>Help garden the site.</h4>
<ul>
<li>Help us remove <a href='/events/duplicates'>duplicate events</a> and <a href='/events/duplicates'>duplicate venues</a>.</li>
<li>Add details to existing events and venues.</li>
<li>Correct missing venues and incomplete venue addresses.</li>
<li>Edit our <a href='http://code.google.com/p/calagator/w/list'>wiki</a> to improve our documentation.</li>
</ul>

<h4>Come to code sprints.</h4>
<p>You don't have to be a programmer; our code sprints are general work sessions, and we also work on <strong>design</strong> issues, <strong>documentation</strong>, and discuss <strong>project direction</strong>. If you are interested in <storng>programming</storng>, or learning Ruby or Rails, our pair programming environment is an excellent environment to learn using Agile methods. We'll be glad to help you set things up.</p>

<h4>Help the developers.</h4>
<ul>
<li>File <a href='http://code.google.com/p/calagator/issues/list'>bug reports</a>.</li>
<li>Verify <a href='http://code.google.com/p/calagator/issues/list'>bug reports</a>.</li>
</ul>

<h4>Contribute code.</h4>
<p>Calagator is a <a href='http://rubyonrails.org/'>Ruby on Rails</a> web application that can be run on any platform, including strange and exotic platforms from the far PNW (Redmond, WA). You can find more details on downloading the source and running it locally at our <a href='http://code.google.com/p/calagator/wiki/DevelopmentSoftware'>Google Code Page</a>. Calagator will not run well on a shared hosting account, so we recommend sticking to local development unless you intend to deploy it in a production environment.</p>

</div>
17 changes: 15 additions & 2 deletions app/views/site/index.html.erb
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,16 @@
<% @times_to_events ||= @times_to_events_deferred.call %>
<div id="project_description">
<h2>Hi there.</h2>
<p class='first'>Calagator is an all-volunteer effort to provide a unified calendar for technical communities and user groups in Portland, Oregon. Anyone can contribute information by importing, creating and editing entries.</p>
<p class='first'><strong>Calagator</strong> is a unified calendar for the technology community of Portland, Oregon. We are an all-volunteer effort and encourage anyone to import, create, and edit events.</p>

<h4>Get Started</h4>
<ul>
<li><a href='/about#find_local_events'>Find Local Events</a></li>
<li><a href='/about#share_local_events'>Share Local Events</a></li>
<li><a href='/about#get_involved'>Get Involved</a></li>
<li><a href='/about'>Find Out About Us</a></li>
</ul>

<p>You can also read our project news <%= link_to 'blog', blog_path %>, participate in <%= link_to 'discussions', forum_path %>, and report <%= link_to 'issues', issues_path %>. This site's <%= link_to 'software', code_path %> is all open-source and we're always looking for new people to join us in making the best calendar aggregator possible.</p>
</div>

<div id="whats_happening">
Expand All @@ -23,3 +30,9 @@
</div>
</div>
<% end %>






4 changes: 4 additions & 0 deletions app/views/site/styles/_layout.css.erb
Original file line number Diff line number Diff line change
Expand Up @@ -127,6 +127,10 @@ body {
margin-top: 0;
}

.copy_block {
width: 45em;
}

/* @end */

/* @group Event Table
Expand Down
7 changes: 4 additions & 3 deletions app/views/site/styles/_typography.css.erb
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@ h1,h2,h3,h4,h5,h6 { font-weight: normal; }

/* h2 { font-size: 3em; line-height: 1; margin-bottom: 0.5em; } */
h1 { font-size: 1.7em; margin-bottom: 0.75em; font-weight: bold; }
h2 { font-size: 1.5em; line-height: 1; margin-bottom: 1em; }
h2 { font-size: 1.5em; line-height: 1; margin-bottom: .5em; }
h3 { font-size: 1.2em; line-height: 1.25; margin-bottom: 1.25em; font-weight: bold}
h4 { font-size: 1em; font-weight: bold; margin-bottom: 1.5em; }
h4 { font-size: 1em; font-weight: bold; margin-bottom: .5em; }
h5 { font-size: 1em; font-weight: bold; }

h1.bar { color: <%= @colors[:creme] %>; background: <%= @colors[:teal] %>;}
Expand All @@ -55,7 +55,8 @@ p img.inline{ float: none; margin: 1.5em 1.5em;}

a:focus,
a:hover { color: <%= @colors[:dark_grey] %>; text-decoration: underline; }
a { color: <%= @colors[:teal] %>; text-decoration: none;}
a:link { color: <%= @colors[:teal] %>; text-decoration: none;}
a:visited { color: <%= @colors[:dark_green] %>; text-decoration: none;}

.dark a { color: <%= @colors[:white] %>; text-decoration: underline; }

Expand Down

0 comments on commit f235781

Please sign in to comment.