Hani Gamal hanigamal

A Very Short Guide to Writing Guides

This is just a few thoughts on the topic of writing technical guides. This was intended for Basho's engineering team, but this may apply to open source projects in general.

Audience

It's commonly preached that the first step in writing is to identify your audience; to whom are you writing? This is the most well known, most repeated, and most overlooked step of writing in general and technical writing in particular. Take this document, for example. My audience is technical people who need to communicate technical information, and not teenagers, so I shy away from images of pop icons and memes. I use jargon and words like "identify" rather than "peep this".

Pronouns

NOTE

THIS GUIDE IS OLD! Go to http://echo.co/blog/os-x-1010-yosemite-local-development-environment-apache-php-and-mysql-homebrew for the Yosemite version.

Prerequisites

Xcode

Go to http://developer.apple.com/downloads, log in with your Apple ID (free) and download the newest version of either Command Line Tools (OS X Lion) for Xcode or Command Line Tools (OS X Mountain Lion) for Xcode. Run the installer in the dmg and you'll have the LLVM compiler, make, and other build tools.

Laravel 4 Thoughts/Questions/Etc.

This is just a random list of notes, as I dig into Laravel 4. If you have any feedback/solutions, please leave a comment. I'll be compiling everything for an article on Nettuts+, when the framework is officially in Beta. This will be updated over the course of the week.

Running composer dump-autoload after every new controller is a pain. Can this not be automated through artisan controller:make ControllerName?
Seems that some of the View HTML helpers are missing. No HTML::script().
Route::resource('tasks', 'TasksController') doesn't seem to create named routes. This is a big deal, if not. What's the solution?

There's no shortage of good resources for learning laravel. So instead of the usual introductory tutorial were just gonna learn Laravel by building a project from scratch and that's gonna be a User Management System.

I don't know if my definition of a User Management System is correct but here's my idea of what's it's capable of doing:

Register Roles
Register Users
Update Users

	<?php namespace App;

	use Illuminate\Database\Eloquent\Builder as BaseBuilder;

	class Builder extends BaseBuilder{

	/**
	* Override getModels so it send attributes to the newInstance methods (in newExisting)
	*/
	public function getModels($columns = array('*'))

	#!/bin/bash
	sudo apt-get --yes purge xserver* x11-common x11-utils x11-xkb-utils x11-xserver-utils xarchiver xauth xkb-data console-setup xinit lightdm libx{composite,cb,cursor,damage,dmcp,ext,font,ft,i,inerama,kbfile,klavier,mu,pm,randr,render,res,t,xf86}* lxde* lx{input,menu-data,panel,polkit,randr,session,session-edit,shortcut,task,terminal} obconf openbox gtk* libgtk* alsa* nano python-pygame python-tk python3-tk scratch tsconf
	sudo apt-get -y purge aspell hunspell-en-us iptraf libaspell15 libhunspell-1.2-0 lxde lxsession lxtask lxterminal squeak-vm whiptail zenity gdm gnome-themes-standard python-pygame
	apt-get --yes purge xdg-tools desktop-file-utils omxplayer python3-numpy python3
	sudo apt-get remove xserver-xorg
	sudo apt-get purge ^lx
	sudo apt-get --yes autoremove
	sudo apt-get --yes autoclean
	sudo apt-get --yes clean

	//manifest.json
	{
	"name": "bookmark-search-export",
	"version": "1.0",
	"manifest_version": 2,
	"description": "This extention will dump all bookmarks",
	"browser_action": {
	"default_icon": "icon.png"
	},
	"background": {

	import re, random

	def shuffle_one(word):
	if len(word) <= 3:
	return word

	middle = list(word[1:-1])
	random.shuffle(middle)

	return word[0] + ''.join(middle) + word[-1]

	import android.accounts.Account;
	import android.accounts.AccountManager;
	import android.annotation.TargetApi;
	import android.content.Context;
	import android.content.SharedPreferences;
	import android.content.SharedPreferences.Editor;
	import android.os.Build;
	import android.preference.PreferenceManager;

	import com.google.android.gms.auth.GoogleAuthUtil;

	<?php if ( ! defined('BASEPATH')) exit('No direct script access allowed');

	$config['views_path'] = APPPATH . 'views/blade/';
	$config['cache_path'] = APPPATH . 'cache/blade/';