From 91840dc1eaed31bd180af50ab64151f79df5c4a6 Mon Sep 17 00:00:00 2001 From: Trent Mick Date: Fri, 26 Aug 2011 11:00:21 -0700 Subject: [PATCH] docs: page titles --- docs/client.md | 4 ++-- docs/dn.md | 4 ++-- docs/errors.md | 5 ++--- docs/examples.md | 5 ++--- docs/filters.md | 4 ++-- docs/guide.md | 15 ++++++++------- docs/server.md | 5 ++--- 7 files changed, 20 insertions(+), 22 deletions(-) diff --git a/docs/client.md b/docs/client.md index 33e812d..343d434 100644 --- a/docs/client.md +++ b/docs/client.md @@ -1,12 +1,12 @@ --- -title: ldapjs +title: Client API | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs Client API This document covers the ldapjs client API and assumes that you are familiar with LDAP. If you're not, read the [guide](http://ldapjs.org/guide.html) first. diff --git a/docs/dn.md b/docs/dn.md index 1caf8da..ba311ac 100644 --- a/docs/dn.md +++ b/docs/dn.md @@ -1,12 +1,12 @@ --- -title: ldapjs +title: DN API | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs DN API This document covers the ldapjs DN API and assumes that you are familiar with LDAP. If you're not, read the [guide](http://ldapjs.org/guide.html) first. diff --git a/docs/errors.md b/docs/errors.md index a0f57bd..554db56 100644 --- a/docs/errors.md +++ b/docs/errors.md @@ -1,13 +1,12 @@ --- -title: ldapjs -brand: spartan +title: Errors API | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs Errors API This document covers the ldapjs errors API and assumes that you are familiar with LDAP. If you're not, read the [guide](http://ldapjs.org/guide.html) first. diff --git a/docs/examples.md b/docs/examples.md index 19a93e1..30f611c 100644 --- a/docs/examples.md +++ b/docs/examples.md @@ -1,13 +1,12 @@ --- -title: ldapjs -brand: spartan +title: Examples | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs Examples This page contains a (hopefully) growing list of sample code to get you started with ldapjs. diff --git a/docs/filters.md b/docs/filters.md index 9fc1a6c..c20403b 100644 --- a/docs/filters.md +++ b/docs/filters.md @@ -1,12 +1,12 @@ --- -title: ldapjs +title: Filters API | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs Filters API This document covers the ldapjs filters API and assumes that you are familiar with LDAP. If you're not, read the [guide](http://ldapjs.org/guide.html) first. diff --git a/docs/guide.md b/docs/guide.md index df9a544..d71f592 100644 --- a/docs/guide.md +++ b/docs/guide.md @@ -1,13 +1,12 @@ --- -title: ldapjs -brand: spartan +title: LDAP Guide | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# This guide +# LDAP Guide This guide was written assuming that you (1) don't know anything about ldapjs, and perhaps more importantly (2) know little, if anything about LDAP. If you're @@ -100,9 +99,11 @@ get out of the way so you can just use the "good parts." With the initial fluff out of the way, let's do something crazy to teach you some LDAP. Let's put an LDAP server up over the top of your (Linux) host's /etc/passwd and /etc/group files. Usually sysadmins "go the other way," and -replace /etc/passwd with a PAM module to LDAP. While this is probably not -a super useful real-world use case, it will teach you some of the basics. -If it is useful to you, then that's gravy. +replace /etc/passwd with a +[PAM](http://en.wikipedia.org/wiki/Pluggable_authentication_module "Pluggable +authentication module") module to LDAP. While this is probably not a super +useful real-world use case, it will teach you some of the basics. If it is +useful to you, then that's gravy. ## Install @@ -210,7 +211,7 @@ error, but it's for the tree `o=myhost`. That means our bind went through, and our search failed, since we haven't yet added a search handler. Just one more small thing to do first. -Remember earlier I said there was no authorization rules baked into LDAP? Well, +Remember earlier I said there were no authorization rules baked into LDAP? Well, we added a bind route, so the only user that can authenticate is `cn=root`, but what if the remote end doesn't authenticate at all? Right, nothing says they *have to* bind, that's just what the common clients do. Let's add a quick diff --git a/docs/server.md b/docs/server.md index e88b751..b5cb459 100644 --- a/docs/server.md +++ b/docs/server.md @@ -1,13 +1,12 @@ --- -title: ldapjs -brand: spartan +title: Server API | ldapjs markdown2extras: wiki-tables logo-color: green logo-font-family: google:Aldrich, Verdana, sans-serif header-font-family: google:Aldrich, Verdana, sans-serif --- -# Overview +# ldapjs Server API This document covers the ldapjs server API and assumes that you are familiar with LDAP. If you're not, read the [guide](http://ldapjs.org/guide.html) first.