You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by ig...@apache.org on 2013/09/02 21:38:50 UTC
git commit: sdk docs: fix links & formatting in preface
Updated Branches:
refs/heads/master 471655ca1 -> 8ea6c7f3a
sdk docs: fix links & formatting in preface
Project: http://git-wip-us.apache.org/repos/asf/trafficserver/repo
Commit: http://git-wip-us.apache.org/repos/asf/trafficserver/commit/8ea6c7f3
Tree: http://git-wip-us.apache.org/repos/asf/trafficserver/tree/8ea6c7f3
Diff: http://git-wip-us.apache.org/repos/asf/trafficserver/diff/8ea6c7f3
Branch: refs/heads/master
Commit: 8ea6c7f3acfde87216c81c3c8a3d278bfe078231
Parents: 471655c
Author: Igor Galić <i....@brainsware.org>
Authored: Mon Sep 2 21:38:11 2013 +0200
Committer: Igor Galić <i....@brainsware.org>
Committed: Mon Sep 2 21:38:11 2013 +0200
----------------------------------------------------------------------
doc/sdk/getting-started.en.rst | 2 ++
doc/sdk/header-based-plugin-examples.en.rst | 2 ++
doc/sdk/how-to-create-trafficserver-plugins.en.rst | 2 ++
doc/sdk/http-transformation-plugin.en.rst | 2 +-
doc/sdk/index.en.rst | 4 ++++
doc/sdk/new-protocol-plugins.en.rst | 2 ++
doc/sdk/preface.en.rst | 16 +++++++---------
7 files changed, 20 insertions(+), 10 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/getting-started.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/getting-started.en.rst b/doc/sdk/getting-started.en.rst
index aa1535b..a39d0cf 100644
--- a/doc/sdk/getting-started.en.rst
+++ b/doc/sdk/getting-started.en.rst
@@ -1,3 +1,5 @@
+.. _sdk-getting-started:
+
Getting Started
***************
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/header-based-plugin-examples.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/header-based-plugin-examples.en.rst b/doc/sdk/header-based-plugin-examples.en.rst
index beb30db..2b28300 100644
--- a/doc/sdk/header-based-plugin-examples.en.rst
+++ b/doc/sdk/header-based-plugin-examples.en.rst
@@ -1,3 +1,5 @@
+.. _header-based-plugin-examples:
+
Header-Based Plugin Examples
*****************************
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/how-to-create-trafficserver-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/how-to-create-trafficserver-plugins.en.rst b/doc/sdk/how-to-create-trafficserver-plugins.en.rst
index 55c69da..9e7a11c 100644
--- a/doc/sdk/how-to-create-trafficserver-plugins.en.rst
+++ b/doc/sdk/how-to-create-trafficserver-plugins.en.rst
@@ -1,3 +1,5 @@
+.. _how-to-create-traffic-server-plugins:
+
How to Create Traffic Server Plugins
************************************
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/http-transformation-plugin.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/http-transformation-plugin.en.rst b/doc/sdk/http-transformation-plugin.en.rst
index b7acfe1..b78b5f6 100644
--- a/doc/sdk/http-transformation-plugin.en.rst
+++ b/doc/sdk/http-transformation-plugin.en.rst
@@ -1,4 +1,4 @@
-.. _transform-plugin:
+.. _http-transformation-plugin:
HTTP Transformation Plugins
***************************
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/index.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/index.en.rst b/doc/sdk/index.en.rst
index cab4d0c..54e5fef 100644
--- a/doc/sdk/index.en.rst
+++ b/doc/sdk/index.en.rst
@@ -1,3 +1,5 @@
+.. _programmers-guide:
+
Programmers' Guide
******************
@@ -34,6 +36,8 @@ supported different operating systems and more functions than the
current version. As a result, some of the sections may refer to
functionality that no longer exists.
+.. These links need fixing..
+
If you find any such issues, you may want to submit a `bug or a
patch <https://issues.apache.org/jira/secure/CreateIssue!default.jspa?pid=12310963>`__.
Or find out how to `find bugs <>`__, `create useful bug reports <>`__ or
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/new-protocol-plugins.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/new-protocol-plugins.en.rst b/doc/sdk/new-protocol-plugins.en.rst
index 7b325a7..13614a5 100644
--- a/doc/sdk/new-protocol-plugins.en.rst
+++ b/doc/sdk/new-protocol-plugins.en.rst
@@ -1,3 +1,5 @@
+.. _new-protocol-plugins:
+
New Protocol Plugins
********************
http://git-wip-us.apache.org/repos/asf/trafficserver/blob/8ea6c7f3/doc/sdk/preface.en.rst
----------------------------------------------------------------------
diff --git a/doc/sdk/preface.en.rst b/doc/sdk/preface.en.rst
index b7f6e93..2c18876 100644
--- a/doc/sdk/preface.en.rst
+++ b/doc/sdk/preface.en.rst
@@ -1,3 +1,5 @@
+.. _sdk-preface:
+
Preface
********
@@ -28,16 +30,12 @@ The *Traffic Server Software Developer's Kit* is a reference for
creating plugins. **Plugins** are programs that add services (such as
filtering or content transformation) or entire features (such as new
protocol support) to Traffic Server. If you are new to writing Traffic
-Server plugins, then read the first two chapters, `Getting
-Started <../getting-started>`__ and `Creating Traffic Server
-Plugins <../how-to-create-trafficserver-plugins>`__, and use the
-remaining chapters as needed. `Header-Based Plugin
-Examples <../header-based-plugin-examples>`__ provides details about
-plugins that work on HTTP headers, while `HTTP Transformation
-Plugins <../http-transformation-plugin>`__ explains how to write a
+Server plugins, then read the first two chapters, :ref:`sdk-getting-started`
+and :ref:`how-to-create-to-create-trafficserver-plugins`, and use the
+remaining chapters as needed. :ref:`header-based-plugin-examples` provides details about
+plugins that work on HTTP headers, while :ref:`http-transformation-plugin` explains how to write a
plugin that transforms or scans the body of an HTTP response. If you
-want to support your own protocol on Traffic Server, then reference `New
-Protocol Plugins <../new-protocol-plugins>`__.
+want to support your own protocol on Traffic Server, then reference :ref:`new-protocol-plugins`.
Audience
--------