Restructure: placeholders for other protocols (w3c#213)

* restructure of the files to put up some space for AMQP and Binary protocols * binary format * spec extensions
mwear · Dec 5, 2018 · e89a1e9 · e89a1e9
1 parent ea4923d
commit e89a1e9
Show file tree

Hide file tree

Showing 19 changed files with 157 additions and 17 deletions.
diff --git a/extension-amqp.html b/extension-amqp.html
@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <title>Trace Context: AMQP protocol</title>
+    <script
+     src='https://www.w3.org/Tools/respec/respec-w3c-common'
+     class='remove' defer></script>
+    <script class='remove'>
+      var respecConfig = {
+        specStatus: "ED",
+        editors: [{
+          name: "Sergey Kanzhelev",
+          company: "Microsoft",
+          companyURL: "https://microsoft.com",
+          w3cid: "103966"
+        },
+        {
+          name: "Morgan McLean",
+          company: "Google",
+          companyURL: "https://google.com",
+          w3cid: "104128"
+        },
+        {
+          name: "Alois Reitbauer",
+          company: "Dynatrace",
+          companyURL: "https://dynatrace.com",
+          w3cid: "48276"
+        }],
+        github: {
+          repoURL: "https://github.com/w3c/trace-context/",
+          branch: "master",
+        },
+        edDraftURI: "https://w3c.github.io/trace-context/extension-amqp.html",
+        shortName: "trace-context",
+        format: "markdown",
+        subjectPrefix: "trace-context",
+        wg: "Distributed Tracing Working Group",
+        wgPublicList: "public-trace-context",
+        wgURI: "https://www.w3.org/2018/distributed-tracing/",
+        //isPreview: true, //this will add ugly box saying it's preview
+        otherLinks: [{
+          key: 'Discussions',
+          data: [{
+            value: 'We are on Gitter.',
+            href: 'https://gitter.im/TraceContext/Lobby'
+          }]
+        }],
+        wgPatentURI: "https://www.w3.org/2004/01/pp-impl/108594/status"
+      };
+    </script>
+  </head>
+  <body>
+        <section id='abstract' data-include="spec/AMQP/01-abstract.md" data-include-format='markdown'></section>
+        <section id='sotd' data-include="spec/AMQP/02-sotd.md" data-include-format='markdown'></section>
+
+        <section data-include="spec/AMQP/20-AMQP_FORMAT.md" data-include-format='markdown'></section>
+  </body>
+</html>
diff --git a/extension-binary.html b/extension-binary.html
@@ -0,0 +1,59 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset='utf-8'>
+    <title>Trace Context: binary protocol</title>
+    <script
+     src='https://www.w3.org/Tools/respec/respec-w3c-common'
+     class='remove' defer></script>
+    <script class='remove'>
+      var respecConfig = {
+        specStatus: "ED",
+        editors: [{
+          name: "Sergey Kanzhelev",
+          company: "Microsoft",
+          companyURL: "https://microsoft.com",
+          w3cid: "103966"
+        },
+        {
+          name: "Morgan McLean",
+          company: "Google",
+          companyURL: "https://google.com",
+          w3cid: "104128"
+        },
+        {
+          name: "Alois Reitbauer",
+          company: "Dynatrace",
+          companyURL: "https://dynatrace.com",
+          w3cid: "48276"
+        }],
+        github: {
+          repoURL: "https://github.com/w3c/trace-context/",
+          branch: "master",
+        },
+        edDraftURI: "https://w3c.github.io/trace-context/extension-binary.html",
+        shortName: "trace-context",
+        format: "markdown",
+        subjectPrefix: "trace-context",
+        wg: "Distributed Tracing Working Group",
+        wgPublicList: "public-trace-context",
+        wgURI: "https://www.w3.org/2018/distributed-tracing/",
+        //isPreview: true, //this will add ugly box saying it's preview
+        otherLinks: [{
+          key: 'Discussions',
+          data: [{
+            value: 'We are on Gitter.',
+            href: 'https://gitter.im/TraceContext/Lobby'
+          }]
+        }],
+        wgPatentURI: "https://www.w3.org/2004/01/pp-impl/108594/status"
+      };
+    </script>
+  </head>
+  <body>
+        <section id='abstract' data-include="spec/Binary/01-abstract.md" data-include-format='markdown'></section>
+        <section id='sotd' data-include="spec/Binary/02-sotd.md" data-include-format='markdown'></section>
+
+        <section data-include="spec/Binary/20-BINARY_FORMAT.md" data-include-format='markdown'></section>
+  </body>
+</html>
diff --git a/index.html b/index.html
@@ -51,14 +51,17 @@
     </script>
   </head>
   <body>
-        <section id='abstract' data-include="abstract/common-abstract.md" data-include-format='markdown'></section>
-        <section id='sotd' data-include="abstract/common-sotd.md" data-include-format='markdown'></section>
+        <section id='abstract' data-include="spec/01-abstract.md" data-include-format='markdown'></section>
+        <section id='sotd' data-include="spec/02-sotd.md" data-include-format='markdown'></section>
 
-        <section data-include="trace_context/overview.md" data-include-format='markdown'></section>
+        <section data-include="spec/10-overview.md" data-include-format='markdown'></section>
+        <section data-include="spec/11-fields-semantics.md" data-include-format='markdown'></section>
 
-        <section data-include="trace_context/HTTP_HEADER_FORMAT.md" data-include-format='markdown'></section>
+        <section data-include="spec/20-HTTP_HEADER_FORMAT.md" data-include-format='markdown'></section>
 
-        <section data-include="trace_context/privacy.md" data-include-format='markdown'></section>
-        <section data-include="trace_context/security.md" data-include-format='markdown'></section>
+        <section data-include="spec/40-other-protocols.md" data-include-format='markdown'></section>
+
+        <section data-include="spec/50-privacy.md" data-include-format='markdown'></section>
+        <section data-include="spec/51-security.md" data-include-format='markdown'></section>
   </body>
 </html>
diff --git a/abstract/common-abstract.md → spec/01-abstract.md b/abstract/common-abstract.md → spec/01-abstract.md
diff --git a/abstract/common-sotd.md → spec/02-sotd.md b/abstract/common-sotd.md → spec/02-sotd.md
diff --git a/trace_context/overview.md → spec/10-overview.md b/trace_context/overview.md → spec/10-overview.md
diff --git a/spec/11-fields-semantics.md b/spec/11-fields-semantics.md
@@ -0,0 +1 @@
+
diff --git a/trace_context/HTTP_HEADER_FORMAT.md → spec/20-HTTP_HEADER_FORMAT.md b/trace_context/HTTP_HEADER_FORMAT.md → spec/20-HTTP_HEADER_FORMAT.md
diff --git a/...e_context/HTTP_HEADER_FORMAT_RATIONALE.md → spec/21-HTTP_HEADER_FORMAT_RATIONALE.md b/...e_context/HTTP_HEADER_FORMAT_RATIONALE.md → spec/21-HTTP_HEADER_FORMAT_RATIONALE.md
diff --git a/spec/40-other-protocols.md b/spec/40-other-protocols.md
@@ -0,0 +1,11 @@
+# Other protocols
+
+Trace Context propagation is crucial to enable distributed tracing scenarios
+for applications spans multiple components. Http is one of the communication
+protocols used for cross components correlation. Extensions of this
+specification define the format of trace context serialization and
+deserialization for other protocols. Note, that those extensions may be at a
+different maturity level than this specification.
+
+- [AMQP](https://w3c.github.io/trace-context/extension-amqp.html).
+- [Binary](https://w3c.github.io/trace-context/extension-binary.html).
diff --git a/trace_context/privacy.md → spec/50-privacy.md b/trace_context/privacy.md → spec/50-privacy.md
diff --git a/trace_context/security.md → spec/51-security.md b/trace_context/security.md → spec/51-security.md
diff --git a/spec/AMQP/01-abstract.md b/spec/AMQP/01-abstract.md
@@ -0,0 +1,3 @@
+This is an extension document for the [Trace
+Context](https://w3c.github.io/trace-context/) specification. It defines the
+mapping of Trace Context fields to the AMQP protocol and specifics of AMQP implementation.
diff --git a/spec/AMQP/02-sotd.md b/spec/AMQP/02-sotd.md
@@ -0,0 +1,3 @@
+This is the First Public Working Draft
+([FPWD](https://www.w3.org/2017/Process-20170301/#working-draft)) of an AMQP
+trace context protocol specification.
diff --git a/spec/AMQP/20-AMQP_FORMAT.md b/spec/AMQP/20-AMQP_FORMAT.md
@@ -0,0 +1,3 @@
+# AMQP format
+
+TBD
diff --git a/spec/Binary/01-abstract.md b/spec/Binary/01-abstract.md
@@ -0,0 +1,3 @@
+This is an extension document for the [Trace
+Context](https://w3c.github.io/trace-context/) specification. It defines the
+mapping of Trace Context fields to the binary formats.
diff --git a/spec/Binary/02-sotd.md b/spec/Binary/02-sotd.md
@@ -0,0 +1,3 @@
+This is the First Public Working Draft
+([FPWD](https://www.w3.org/2017/Process-20170301/#working-draft)) of a binary
+trace context protocol specification.
diff --git a/spec/Binary/20-BINARY_FORMAT.md b/spec/Binary/20-BINARY_FORMAT.md
@@ -0,0 +1,3 @@
+# Binary format
+
+TBD
diff --git a/trace_context/README.md b/trace_context/README.md