Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

some copy tweaks

first crack at home page. some typos fixed elsewhere. first cut at
architecture description.
  • Loading branch information...
commit 2c90dbb3d2a1dd24ec0006620fc20f32a95e483b 1 parent 5990f48
@adrianrf adrianrf authored
View
34 content/bdsm/basics.haml
@@ -59,16 +59,23 @@
%h2
Modules
%p
-Firstly, you'll want to start out easy, by calling on the rich set of pre-written BDSM modules. They amount to an amazing toy-chest of deliciously wicked functionality that comes your way in easily-assimilated DSL form. You say it; they obey it.
+ Firstly, you'll want to start out easy, by calling on the rich set of pre-written BDSM modules.
+ They're an amazing toy-chest of deliciously wicked functionality that comes your way in easily-assimilated DSL form.
+ You say it; they obey it.
%p
- Modules operate a lot like a programming language's standard libraries do; load the library, then
+ Modules operate a lot like a programming language's standard libraries do: first, load the library; then
go to town with its full functionality.
- %p
-And when you have your system groveling obediently at your ankles, just begging to lick right between your toes in that oh-so-delicious favorite spot, you may could perhaps be completely satiated.
-What's that? No? Too easy? You need more; much, much more, from your abject slaves?
- No problem! Writing your own exquisite-crafted extensions is far from being some huge test of your personal capacity for tolerating pain. Not at all. In fact, we bet you'll squeal with delight!
- %p
- Developing your own powerful system scripts isn't just electrifyingly fast with BDSM, it's more stimulating than plugging a 12-foot Van De Graaf generator directly into nickel-plated nipple clamps!
+%p
+ And when you have your system groveling obediently at your ankles, just begging to lick right between your toes in
+ that oh-so-delicious favorite spot of yours, you may perhaps become completely satiated.
+%p
+ What's that? Too easy? You demand more; much, much more, from your abject slaves?
+%p
+ No problem! Writing your own exquisitely-crafted extension is far from being a huge test of your personal capacity
+ for tolerating pain. (In fact, we bet you'll actually squeal with delight!)
+%p
+ And developing your own powerful system scripts isn't just electrifyingly fast with BDSM, it's more stimulating than plugging a 12-foot
+ Van De Graaf generator directly into nickel-plated nipple clamps!
%p
You can
%a{:href => "/extensions/"}
@@ -78,9 +85,12 @@ What's that? No? Too easy? You need more; much, much more, from your abject slav
%h2
Language-Agnostic
%p
- THe "B" in BDSM means 'Bash...' - not (sadly) because it's the quaint British synonym for fisticuffs that we all secretly wish it were... but simply because that is what it is written in primarily: the Bourne-Again Shell. The world's most popular command-line interpreter
- (sorry, no, Bill: DOS doesn't count. and don't talk to me about Cisco, darling - that nasty greasy stuff just goes sour and smelly in nothing flat. And it marks the carpet something awful.)
+ THe "B" in BDSM means 'Bash...' - not, (sadly), because it's the quaint British synonym for fisticuffs
+ that we all secretly wish it were... but simply because that is what it is written in primarily: the Bourne-Again Shell.
+ Probably the world's most popular command-line interpreter
+ (sorry, no, Bill: DOS doesn't count. and don't talk to me about Cisco, darling - that nasty greasy stuff just goes sour and smelly
+ in nothing flat. And it marks the carpet something awful.)
%p
That being said, each and every extension action may be written in any
- language. The requirement for an extension action is that it is an executable
- file of a type that the system recognizes.
+ language you wish. The key requirement for an extension action is simply that it is an executable
+ file of a type that your operating system recognizes.
View
9 content/credits/funding.haml
@@ -11,18 +11,17 @@
%h1
Who Funds BDSM?
%p
- The vast majority of BDSM development, including speaking about it at events, has happened on my own personal time and budget.
+ The vast majority of BDSM development, including speaking about it at events, represents a significant investment of
+ my own personal time and money.
%p
That said, there is a
%a{:href => "http://bdsm.beginrescueend.com/credits/donations/"}
growing list of awesome people
who have donated to the project!
%p
- We also have two 'official sponsors',
+ We also have our first 'official sponsor',
%ul
%li
%a{:href => "http://www.blueboxgrp.com/"}
Blue Box Group, LLC
- donates a VPS to run BDSM's website on.
- %li
- [wayneeseguin: who else should we be identifying here???]
+ generously donates a VPS to run BDSM's website on.
View
4 content/credits/thanks.haml
@@ -5,5 +5,7 @@
Many Thanks!
%h3
- Thank you so much to those of you who invested the time and took the risk to be private beta-testers for BDSM, and who have provided much excellent feedback. Your contributions have made BDSM what it is at its best; its shortcomings are mine alone.
+ Thank you so much to those of you who invested the time and took the risk to be private beta-testers for BDSM,
+ and who have provided much excellent feedback. Your contributions have made BDSM what it is at its best;
+ its shortcomings are mine alone.
View
18 content/development.haml
@@ -10,10 +10,11 @@
%a{:href => "/development/"} Development
%p
- Before developing on core, extensions or site be sure to setup the BDSM development environment first. After
+ Before developing contributions for BDSM's core, extensions or site, be sure to setup your BDSM development environment first.
+ After
%a{:href => "/bdsm/install"}
installing BDSM
- on your system, as your development user you can setup the BDSM development environment by issuing the following command.
+ on your system, while logged into your regular user account, you can setup the BDSM development environment with one command.
%pre.code
:preserve
bdsm core dev setup
@@ -25,19 +26,20 @@
%li
BDSM project module interactive component, the commands
%ul
- %li p - Change directories to given project / subproject.
- %li pe - Change directories to given project / subprojevct and open it in the $EDITOR (vim if no has been EDITOR set).
- %li po - Change directories to given project / subproject and open it in the filesystem viewer.
+ %li p - Change directory to given project / subproject.
+ %li pe - Change directory to given project / subproject, and open it in your $EDITOR (vim if no EDITOR has been set).
+ %li po - Change directory to given project / subproject, and open it in the filesystem viewer.
%li
- Core, extensions and site repositories into the projects path ($HOME/projects/bdsm/ by default).
+ Core, extensions and site repositories are placed in the projects path (by default, $HOME/projects/bdsm/).
- Once the command has completed, you may open a new shell and start using the project functions. For example, to switch directories to the core and start editing it type the following.
+ As soon as the command completes, you can open a new shell and start using the project functions.
+ For example, to switch directories to BDSM's core, and start editing it, just type:
%pre.code
:preserve
user ~/ $ pe bdsm core
user ~/projects/bdsm/ $ # Editor also launched here
- The p, pe and po commands operate on a prefix basis, the shortest match wins.
+ The p, pe and po commands operate on a prefix basis; the shortest match wins.
%pre.code
:preserve
user ~/ $ pe bd c
View
16 content/development/contributing.haml
@@ -20,15 +20,16 @@
appreciate people helping out in the IRC channel and giving support.
%p
- We also greatly appreciate documentation patches, submitted from the bdsm-site
- repository (url below).
+ We also greatly appreciate documentation patches, submitted from the bdsm-site
+ repository (url below).
%p
If you do have programming chops, riding shotgun
on a remote pair-programming session is an extremely useful way to build awarenss and support for BDSM's benefits.
%p
- And if you are interested in adding your own coding contributions to BDSM, there are a few things you should be aware of; and a few things in particular that will make the whole process a lot smoother overall.
+ And if you are interested in adding your own coding contributions to BDSM, there are a few things you should be aware of;
+ and a few things in particular to make the whole process a lot smoother overall.
%h2 General Guidelines
@@ -44,8 +45,13 @@
BDSM scripts, then refactor from there.
%li
Drop into our IRC room (#beginrescueend on freenode) and chat with
- wayneeseguin or mpapis if you have a particular task in mind:
- we'll be happy to let you know if perhaps someone else has already started on it; and we can connect you, if perhaps you might like to team up.
+ wayneeseguin or mpapis:
+ %ul
+ %li
+ if you have a particular task in mind, we'll be happy to let you know if someone else
+ has already started on it (and we can connect you, if you'd like to team up.)
+ %li
+ if you're willing to just pitch in, we'll be thrilled to let you know where you could probably make the biggest impact
%h2 Handy Tips
View
4 content/extensions.haml
@@ -10,10 +10,10 @@
%a{:href => "/extensions/"} Extensions
%p
- Please read the
+ Please read about the
%a{:href => "/extensions/basics"}
basics of extensions
- thoroughly before using BDSM.
+ thoroughly, before using BDSM.
%h2
Core Extension documentation
View
20 content/extensions/basics.haml
@@ -15,13 +15,14 @@
%h2
Description
%p
- Extensions are best described as a namespaced collection of executable files
- called 'actions'.
+ Extensions are namespaced collections of executable files called 'actions'.
%h2
Actions
%p
- Actions can comprise scripts and/or binaries. The key requirement is that their file type is recognized as executable by your operating system. However, as a precaution, BDSM restrains them just a little bit further:
+ Actions can comprise scripts and/or binaries. The one absolute requirement is that their file types are
+ recognized as executable by your operating system. However, as a precaution, BDSM restrains them
+ just a little bit further:
%p
A valid extension must always provide at least a 'help' action. (How else could it be a useful, worthy slave?)
@@ -45,19 +46,22 @@
Any options you pass at the end of the command are communicated to the
particular action via a specific exported environment variable.
%p
- So, no matter the native language an action is written in, everything it needs to know to perform its job obediently and with alacrity is available to it in one simple, standardized way: by reading its process environment.
+ So, no matter the native language an action is written in, everything it needs to know
+ to perform its job obediently and with alacrity is available to it in one simple, standardized way:
+ by reading its process environment.
%h2
Installing
%p
- At the moment, there's just one straightforward way to install new extensions into bdsm: you simply summon them from the main repository, via bdsm's command-line interface. (For your convenience [and amusement], we're also developing some other future methods for extension installation, too.)
+ At the moment, there's just one straightforward way to install new extensions into bdsm:
+ you simply summon them from the main repository, via bdsm's command-line interface.
+ (For your convenience [and amusement], we're also developing some other future methods for extension installation, too.)
%p
- Here's how it goes. First,
- we pull the extension repository down to your local system,
+ Here's how it goes. First, pull the extension repository down to your local system,
%pre.code
:preserve
- root# bdsm get head; bdsm sets update all ; bdsm ext update all
+ root# bdsm get head ; bdsm sets update all ; bdsm ext update all
%p
Internal extensions (found at https://github.com/wayneeseguin/bdsm-extensions)
View
85 content/index.haml
@@ -15,38 +15,87 @@
%p
Badass Delectable Scripting Modules (BDSM) Framework
-%h2 Goal
+%h2 What It Is
%p
- The goal of BDSM is to create a framework for maintaining and sharing server
- side scripts while exposing them through a consistent command line interface (CLI).
+ BDSM is a powerful new framework for developing, maintaining and sharing system scripts,
+ while exposing them for easy automation via a clean, consistent DSL-centric command-line interface.
+
+%h2 Why You'd Care
+
+%p
+ With BDSM, thousands of tools, utilities and applications running on your machine become
+ incredibly easy to automate and control. You'll find it quite invaluable for website development, too.
+%p
+ BDSM cuts away all the tedious, funky syntax that festoons your everyday command-line experience,
+ in favor of a lean, mean Ruby-like Domain-Specific Language,
+ just tailor-made for cracking your whip on those unruly system management tasks. Short, crisp words of command can convey such a tremendously
+ %em spine-tingling
+ authority, after all.
+%p
+ So, whether you're just looking for easier ways to run your own personal *nix-based machine
+ more efficiently, or whether you're already administering dozens, hundreds or
+ %em thousands
+ of machines at a time with a tool like Puppet or Chef, chances are excellent that BDSM will save you major headaches.
+%p
+ (In the latter case, the abstraction that BDSM painlessly interjects helps to seriously de-clutter your Puppet or Chef
+ work - making it easier to get things running right in the first place; significantly more portable across execution environments;
+ and far easier to maintain. What's not to love, in your own intensely personal way?)
%h2 Architecture
%p
- BDSM itself is the core framework. Users may write / install 'extensions'
- (think plugins) to the core framework in order to add CLI functionality to BDSM.
+ BDSM itself delivers a robust core framework, with minimal prerequisites. You just need GNU coreutils, plus Bash or ZShell.
+ (Your distro probably includes these already.)
+%p
+ One layer up from its core, BDSM includes a broad set of modules, which perform a comparable role to the standard
+ run-time loadable libraries found in classic programming languages.
+%p
+ Then, BDSM extensions step up another level, calling the lower-level functions provided by the modules to
+ implement the specific behaviors (aka actions) you'll command, as your scripts interface with the applications
+ and services running on your target machine environment.
+%p
+ Dozens of extensions are in active development by a burgeoning crew of Open Source contributors right now,
+ with a diverse selection immediately available to get things off to a quite thrilling start.
+%p
+ And should you find that some critical action you need doesn't exist yet (our out-of-the-box goal for 1.0.0
+ is to have everything at least 90% of people want already in there), it's extremely easy to write
+ your own extension. Pick any language you like: C, Ruby, Perl, Lua, you name it;
+ if it can spit out an executable file that will run in your intended environment, you can use it.
%h2 Creating Extensions
%p
- There are only a few requirements for the 'extensions'. The extension must be a
- directory. Within this directory are (at least) the subdirectory bin/ with at
- least one executable file called 'help'. Additionally in the root of the
- extension directory there must be a text file called VERSION with a version
- number that follows semantic versioning (http://semver.org/) in the format of
- X.Y.Z where X,Y and Z are positive integers.
+ There are only a few requirements for a BDSM extension:
+ %ul
+ %li
+ All extensions get their own individual directory.
+ %li
+ Within each extension's main directory (minimally) you'll find a bin/ subdirectory
+ %ul
+ %li
+ with at least one executable file inside, called 'help'.
+ %li
+ Additionally, in the root of its main directory, every extension needs a VERSION text file,
+ complying with semantic versioning convention
+ %a{ :href => "http://semver.org/" }
+ (http://semver.org/);
+ i.e. in the format X.Y.Z, where X,Y & Z are all positive integers.
%p
- The contents of the bin directory can be *any* executable file. This means for
- example that C compiled binaries, Ruby Scripts, python, lua, etc... may all be
- used according to requrements and/or user preferences. Of course the extensions
- which *I* write will likely be in Shell script ;)
+ The bin/ directory can contain *any* executable file type. So, C-compiled binaries, Ruby,
+ python, lua, etc. (not forgetting Shell scripts!) may all be used; whatever you prefer.
%h2 Support
%p
- BDSM is continuously evolving thanks to constant community feedback.
- The developer (Wayne E. Seguin) is highly responsive, addresses issues
- quickly and cares about helping the community grow.
+ BDSM is continuously and rapidly evolving, thanks to constant community feedback.
+ BDSM's core developers (Wayne E. Seguin and Michal Papis) are highly responsive, address issues
+ quickly and are fully committed to helping the BDSM community grow.
+%br
+ (And the community's computers? Waiting breathlessly, attentively, and
+ %em above all, obediently;
+ ready and eager to leap to fulfill the
+ %strong slightest whim
+ of their mistresses and masters, of course. :)
Please sign in to comment.
Something went wrong with that request. Please try again.