aurora-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From wfar...@apache.org
Subject svn commit: r1719621 - in /aurora/site: ./ publish/documentation/latest/ publish/documentation/latest/client-commands/ publish/documentation/latest/deploying-aurora-scheduler/ publish/documentation/latest/sla/ publish/documentation/latest/storage-confi...
Date Sat, 12 Dec 2015 03:02:44 GMT
Author: wfarner
Date: Sat Dec 12 03:02:43 2015
New Revision: 1719621

URL: http://svn.apache.org/viewvc?rev=1719621&view=rev
Log:
Site: fix broken links to source code.

Modified:
    aurora/site/Rakefile
    aurora/site/publish/documentation/latest/client-commands/index.html
    aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html
    aurora/site/publish/documentation/latest/index.html
    aurora/site/publish/documentation/latest/sla/index.html
    aurora/site/publish/documentation/latest/storage-config/index.html
    aurora/site/publish/documentation/latest/test-resource-generation/index.html
    aurora/site/publish/documentation/latest/thrift-deprecation/index.html
    aurora/site/source/documentation/latest.html.md
    aurora/site/source/documentation/latest/client-commands.md
    aurora/site/source/documentation/latest/deploying-aurora-scheduler.md
    aurora/site/source/documentation/latest/sla.md
    aurora/site/source/documentation/latest/storage-config.md
    aurora/site/source/documentation/latest/test-resource-generation.md
    aurora/site/source/documentation/latest/thrift-deprecation.md

Modified: aurora/site/Rakefile
URL: http://svn.apache.org/viewvc/aurora/site/Rakefile?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/Rakefile (original)
+++ aurora/site/Rakefile Sat Dec 12 03:02:43 2015
@@ -37,6 +37,17 @@ task :update_docs do
   Dir.chdir("#{docs_dir}/latest/") {
     Dir.glob('*.md').each { |doc|
       puts "working on: #{doc}"
+
+      # Hack to rewrite links to '../CONTRIBUTING.md'.
+      IO.write(doc, File.open(doc, :encoding => 'utf-8') { |f|
+        f.read.gsub(/\.\.\/CONTRIBUTING\.md/, 'contributing/')
+      })
+
+      # Hack to rewrite links pointing to source files in the repository.
+      IO.write(doc, File.open(doc, :encoding => 'utf-8') { |f|
+        f.read.gsub(/\]\(\.\.\/([^\)]+\))/, '](https://github.com/apache/aurora/blob/master/\1)')
+      })
+
       IO.write(doc, File.open(doc, :encoding => 'utf-8') { |f|
         f.read.gsub(/\(([A-Za-z0-9-]+)\.md(#[^\)]+)?\)/, '(/documentation/latest/\1/\2)')
       })

Modified: aurora/site/publish/documentation/latest/client-commands/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/client-commands/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/client-commands/index.html (original)
+++ aurora/site/publish/documentation/latest/client-commands/index.html Sat Dec 12 03:02:43
2015
@@ -244,7 +244,7 @@ acknowledging (“heartbeating&rdquo
 service updates where explicit job health monitoring is vital during the entire job update
 lifecycle. Such job updates would rely on an external service (or a custom client) periodically
 pulsing an active coordinated job update via a
-<a href="../api/src/main/thrift/org/apache/aurora/gen/api.thrift">pulseJobUpdate RPC</a>.</p>
+<a href="https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/api.thrift">pulseJobUpdate
RPC</a>).</p>
 
 <p>A coordinated update is defined by setting a positive
 <a href="/documentation/latest/configuration-reference/#updateconfig-objects">pulse<em>interval</em>secs</a>
value in job configuration

Modified: aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html (original)
+++ aurora/site/publish/documentation/latest/deploying-aurora-scheduler/index.html Sat Dec
12 03:02:43 2015
@@ -294,7 +294,7 @@ See <a href="/documentation/latest/confi
 <pre class="highlight plaintext"><code>-tier_config=path/to/tiers/config.json
 </code></pre>
 
-<p>Example <a href="../src/test/resources/org/apache/aurora/scheduler/tiers-example.json">tier
configuration file</a>.</p>
+<p>Example <a href="https://github.com/apache/aurora/blob/master/src/test/resources/org/apache/aurora/scheduler/tiers-example.json">tier
configuration file</a>).</p>
 
 <h3 id="maintaining-an-aurora-installation">Maintaining an Aurora Installation</h3>
 

Modified: aurora/site/publish/documentation/latest/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/index.html (original)
+++ aurora/site/publish/documentation/latest/index.html Sat Dec 12 03:02:43 2015
@@ -79,7 +79,7 @@
 <h2 id="developers">Developers</h2>
 
 <ul>
-<li><a href="../CONTRIBUTING.md">Contributing to the project</a></li>
+<li><a href="contributing/">Contributing to the project</a></li>
 <li><a href="/documentation/latest/developing-aurora-scheduler/">Developing the
Aurora Scheduler</a></li>
 <li><a href="/documentation/latest/developing-aurora-client/">Developing the
Aurora Client</a></li>
 <li><a href="/documentation/latest/committers/">Committers Guide</a></li>

Modified: aurora/site/publish/documentation/latest/sla/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/sla/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/sla/index.html (original)
+++ aurora/site/publish/documentation/latest/sla/index.html Sat Dec 12 03:02:43 2015
@@ -108,7 +108,7 @@ relevant to uptime calculations. By appl
 transition records, we can build a deterministic downtime trace for every given service instance.</p>
 
 <p>A task going through a state transition carries one of three possible SLA meanings
-(see <a href="../src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java">SlaAlgorithm.java</a>
for
+(see <a href="https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java">SlaAlgorithm.java</a>)
for
 sla-to-task-state mapping):</p>
 
 <ul>
@@ -158,7 +158,7 @@ metric that helps track the dependency o
 <li>Per job - <code>sla_&lt;job_key&gt;_mtta_ms</code></li>
 <li>Per cluster - <code>sla_cluster_mtta_ms</code></li>
 <li>Per instance size (small, medium, large, x-large, xx-large). Size are defined in:
-<a href="../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java">ResourceAggregates.java</a>
+<a href="https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java">ResourceAggregates.java</a>)
 
 <ul>
 <li>By CPU:</li>
@@ -199,7 +199,7 @@ reflecting on the overall time it takes
 <li>Per job - <code>sla_&lt;job_key&gt;_mttr_ms</code></li>
 <li>Per cluster - <code>sla_cluster_mttr_ms</code></li>
 <li>Per instance size (small, medium, large, x-large, xx-large). Size are defined in:
-<a href="../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java">ResourceAggregates.java</a>
+<a href="https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java">ResourceAggregates.java</a>)
 
 <ul>
 <li>By CPU:</li>

Modified: aurora/site/publish/documentation/latest/storage-config/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/storage-config/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/storage-config/index.html (original)
+++ aurora/site/publish/documentation/latest/storage-config/index.html Sat Dec 12 03:02:43
2015
@@ -95,7 +95,7 @@ for Mesos replicated log files to ensure
 
 <p>ZooKeeper path used for Mesos replicated log quorum discovery.</p>
 
-<p>See <a href="../src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java">code</a>
for
+<p>See <a href="https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java">code</a>)
for
 other available Mesos replicated log configuration options and default values.</p>
 
 <h3 id="backup-configuration-flags">Backup configuration flags</h3>

Modified: aurora/site/publish/documentation/latest/test-resource-generation/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/test-resource-generation/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/test-resource-generation/index.html (original)
+++ aurora/site/publish/documentation/latest/test-resource-generation/index.html Sat Dec 12
03:02:43 2015
@@ -44,7 +44,7 @@
 <h2 id="background">Background</h2>
 
 <p>The Aurora source repository and distributions contain several
-<a href="../src/test/resources/org/apache/thermos/root/checkpoints">binary files</a>
to
+<a href="https://github.com/apache/aurora/blob/master/src/test/resources/org/apache/thermos/root/checkpoints">binary
files</a>) to
 qualify the backwards-compatibility of thermos with checkpoint data. Since
 thermos persists state to disk, to be read by the thermos observer), it is important that
we have
 tests that prevent regressions affecting the ability to parse previously-written data.</p>

Modified: aurora/site/publish/documentation/latest/thrift-deprecation/index.html
URL: http://svn.apache.org/viewvc/aurora/site/publish/documentation/latest/thrift-deprecation/index.html?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/publish/documentation/latest/thrift-deprecation/index.html (original)
+++ aurora/site/publish/documentation/latest/thrift-deprecation/index.html Sat Dec 12 03:02:43
2015
@@ -48,7 +48,7 @@ client/server RPC protocol as well as fo
 correctly handling additions and renames of the existing members, field removals must be
done
 carefully to ensure backwards compatibility and provide predictable deprecation cycle. This
 document describes general guidelines for making Thrift schema changes to the existing fields
in
-<a href="../api/src/main/thrift/org/apache/aurora/gen/api.thrift">api.thrift</a>.</p>
+<a href="https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/api.thrift">api.thrift</a>).</p>
 
 <p>It is highly recommended to go through the
 <a href="http://diwakergupta.github.io/thrift-missing-guide/">Thrift: The Missing Guide</a>
first to refresh on
@@ -75,10 +75,10 @@ communicate with scheduler/client from v
 * Do not remove or rename the old field
 * Add a new field as an eventual replacement of the old one and implement a dual read/write
 anywhere the old field is used
-* Check <a href="../api/src/main/thrift/org/apache/aurora/gen/storage.thrift">storage.thrift</a>
to see if the
+* Check <a href="https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/storage.thrift">storage.thrift</a>)
to see if the
 affected struct is stored in Aurora scheduler storage. If so, you most likely need to backfill
 existing data to ensure both fields are populated eagerly on startup
-See <a href="../src/main/java/org/apache/aurora/scheduler/storage/StorageBackfill.java">StorageBackfill.java</a>
+See <a href="https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/storage/StorageBackfill.java">StorageBackfill.java</a>)
 * Add a deprecation jira ticket into the vCurrent+1 release candidate
 * Add a TODO for the deprecated field mentioning the jira ticket</p>
 

Modified: aurora/site/source/documentation/latest.html.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest.html.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest.html.md (original)
+++ aurora/site/source/documentation/latest.html.md Sat Dec 12 03:02:43 2015
@@ -27,7 +27,7 @@ We encourage you to ask questions on the
  * [Generating test resources](/documentation/latest/test-resource-generation/)
 
 ## Developers
- * [Contributing to the project](../CONTRIBUTING.md)
+ * [Contributing to the project](contributing/)
  * [Developing the Aurora Scheduler](/documentation/latest/developing-aurora-scheduler/)
  * [Developing the Aurora Client](/documentation/latest/developing-aurora-client/)
  * [Committers Guide](/documentation/latest/committers/)

Modified: aurora/site/source/documentation/latest/client-commands.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/client-commands.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/client-commands.md (original)
+++ aurora/site/source/documentation/latest/client-commands.md Sat Dec 12 03:02:43 2015
@@ -200,7 +200,7 @@ acknowledging ("heartbeating") job updat
 service updates where explicit job health monitoring is vital during the entire job update
 lifecycle. Such job updates would rely on an external service (or a custom client) periodically
 pulsing an active coordinated job update via a
-[pulseJobUpdate RPC](../api/src/main/thrift/org/apache/aurora/gen/api.thrift).
+[pulseJobUpdate RPC](https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/api.thrift)).
 
 A coordinated update is defined by setting a positive
 [pulse_interval_secs](/documentation/latest/configuration-reference/#updateconfig-objects)
value in job configuration

Modified: aurora/site/source/documentation/latest/deploying-aurora-scheduler.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/deploying-aurora-scheduler.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/deploying-aurora-scheduler.md (original)
+++ aurora/site/source/documentation/latest/deploying-aurora-scheduler.md Sat Dec 12 03:02:43
2015
@@ -204,7 +204,7 @@ Specify a tier configuration file path:
 
     -tier_config=path/to/tiers/config.json
 
-Example [tier configuration file](../src/test/resources/org/apache/aurora/scheduler/tiers-example.json).
+Example [tier configuration file](https://github.com/apache/aurora/blob/master/src/test/resources/org/apache/aurora/scheduler/tiers-example.json)).
 
 ### Maintaining an Aurora Installation
 

Modified: aurora/site/source/documentation/latest/sla.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/sla.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/sla.md (original)
+++ aurora/site/source/documentation/latest/sla.md Sat Dec 12 03:02:43 2015
@@ -61,7 +61,7 @@ relevant to uptime calculations. By appl
 transition records, we can build a deterministic downtime trace for every given service instance.
 
 A task going through a state transition carries one of three possible SLA meanings
-(see [SlaAlgorithm.java](../src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java)
for
+(see [SlaAlgorithm.java](https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/sla/SlaAlgorithm.java))
for
 sla-to-task-state mapping):
 
 * Task is UP: starts a period where the task is considered to be up and running from the
Aurora
@@ -108,7 +108,7 @@ metric that helps track the dependency o
 * Per job - `sla_<job_key>_mtta_ms`
 * Per cluster - `sla_cluster_mtta_ms`
 * Per instance size (small, medium, large, x-large, xx-large). Size are defined in:
-[ResourceAggregates.java](../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java)
+[ResourceAggregates.java](https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java))
   * By CPU:
     * `sla_cpu_small_mtta_ms`
     * `sla_cpu_medium_mtta_ms`
@@ -144,7 +144,7 @@ reflecting on the overall time it takes
 * Per job - `sla_<job_key>_mttr_ms`
 * Per cluster - `sla_cluster_mttr_ms`
 * Per instance size (small, medium, large, x-large, xx-large). Size are defined in:
-[ResourceAggregates.java](../src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java)
+[ResourceAggregates.java](https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/base/ResourceAggregates.java))
   * By CPU:
     * `sla_cpu_small_mttr_ms`
     * `sla_cpu_medium_mttr_ms`

Modified: aurora/site/source/documentation/latest/storage-config.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/storage-config.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/storage-config.md (original)
+++ aurora/site/source/documentation/latest/storage-config.md Sat Dec 12 03:02:43 2015
@@ -43,7 +43,7 @@ for Mesos replicated log files to ensure
 #### -native_log_zk_group_path
 ZooKeeper path used for Mesos replicated log quorum discovery.
 
-See [code](../src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java)
for
+See [code](https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/log/mesos/MesosLogStreamModule.java))
for
 other available Mesos replicated log configuration options and default values.
 
 ### Backup configuration flags

Modified: aurora/site/source/documentation/latest/test-resource-generation.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/test-resource-generation.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/test-resource-generation.md (original)
+++ aurora/site/source/documentation/latest/test-resource-generation.md Sat Dec 12 03:02:43
2015
@@ -2,7 +2,7 @@
 
 ## Background
 The Aurora source repository and distributions contain several
-[binary files](../src/test/resources/org/apache/thermos/root/checkpoints) to
+[binary files](https://github.com/apache/aurora/blob/master/src/test/resources/org/apache/thermos/root/checkpoints))
to
 qualify the backwards-compatibility of thermos with checkpoint data. Since
 thermos persists state to disk, to be read by the thermos observer), it is important that
we have
 tests that prevent regressions affecting the ability to parse previously-written data.

Modified: aurora/site/source/documentation/latest/thrift-deprecation.md
URL: http://svn.apache.org/viewvc/aurora/site/source/documentation/latest/thrift-deprecation.md?rev=1719621&r1=1719620&r2=1719621&view=diff
==============================================================================
--- aurora/site/source/documentation/latest/thrift-deprecation.md (original)
+++ aurora/site/source/documentation/latest/thrift-deprecation.md Sat Dec 12 03:02:43 2015
@@ -6,7 +6,7 @@ client/server RPC protocol as well as fo
 correctly handling additions and renames of the existing members, field removals must be
done
 carefully to ensure backwards compatibility and provide predictable deprecation cycle. This
 document describes general guidelines for making Thrift schema changes to the existing fields
in
-[api.thrift](../api/src/main/thrift/org/apache/aurora/gen/api.thrift).
+[api.thrift](https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/api.thrift)).
 
 It is highly recommended to go through the
 [Thrift: The Missing Guide](http://diwakergupta.github.io/thrift-missing-guide/) first to
refresh on
@@ -30,10 +30,10 @@ communicate with scheduler/client from v
 * Do not remove or rename the old field
 * Add a new field as an eventual replacement of the old one and implement a dual read/write
 anywhere the old field is used
-* Check [storage.thrift](../api/src/main/thrift/org/apache/aurora/gen/storage.thrift) to
see if the
+* Check [storage.thrift](https://github.com/apache/aurora/blob/master/api/src/main/thrift/org/apache/aurora/gen/storage.thrift))
to see if the
 affected struct is stored in Aurora scheduler storage. If so, you most likely need to backfill
 existing data to ensure both fields are populated eagerly on startup
-See [StorageBackfill.java](../src/main/java/org/apache/aurora/scheduler/storage/StorageBackfill.java)
+See [StorageBackfill.java](https://github.com/apache/aurora/blob/master/src/main/java/org/apache/aurora/scheduler/storage/StorageBackfill.java))
 * Add a deprecation jira ticket into the vCurrent+1 release candidate
 * Add a TODO for the deprecated field mentioning the jira ticket
 



Mime
View raw message