Add format+example for adding year+last modified year for each article (

#322) * Add format+example for adding year+last modified year for each article Signed-off-by: Christophe Bedard <bedard.christophe@gmail.com> Signed-off-by: Chris Lalancette <clalancette@openrobotics.org>
ros2 · Oct 1, 2021 · 12f61b1 · 12f61b1
1 parent 90f09cd
commit 12f61b1
Show file tree

Hide file tree

Showing 45 changed files with 325 additions and 55 deletions.
diff --git a/articles/010_why_ros2.md b/articles/010_why_ros2.md
@@ -6,6 +6,8 @@ abstract:
   This article captures the reasons for making breaking changes to the ROS API, hence the 2.0.
 published: true
 author: Brian Gerkey
+date_written: 2014-06
+last_modified: 2015-07
 categories: Overview
 ---
 
@@ -17,7 +19,11 @@ categories: Overview
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 We started work on ROS in November 2007.
 A lot has happened since then and we believe that it is now time to build the next generation ROS platform.

diff --git a/articles/020_ros_with_dds.md b/articles/020_ros_with_dds.md
@@ -6,6 +6,8 @@ abstract:
   This article makes the case for using DDS as the middleware for ROS, outlining the pros and cons of this approach, as well as considering the impact to the user experience and code API that using DDS would have.
   The results of the "ros_dds" prototype are also summarized and used in the exploration of the issue.
 author: '[William Woodall](https://github.com/wjwwood)'
+date_written: 2014-06
+last_modified: 2019-07
 published: true
 categories: Middleware
 ---
@@ -23,7 +25,11 @@ For details on how ROS 2 has been implemented, see the [Core Documentation](http
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 Terminology:
 

diff --git a/articles/030_ros_with_zeromq.md b/articles/030_ros_with_zeromq.md
@@ -8,6 +8,8 @@ abstract:
   This article also covers the results of the ZeroMQ based prototype made by OSRF.
 published: true
 author: '[William Woodall](https://github.com/wjwwood)'
+date_written: 2014-06
+last_modified: 2019-05
 ---
 
 {:toc}
@@ -20,7 +22,11 @@ author: '[William Woodall](https://github.com/wjwwood)'
 
 > This document pre-dates the decision to build ROS 2 on top of DDS.
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 While this article covers proposals and related experiments for building a new middleware specifically around ZeroMQ, it also generally captures the idea of building a new middleware out of a few component libraries.
 This strategy of composing existing libraries into a middleware is in contrast to wrapping up an existing end-to-end middleware which provides most if not all of the middleware needs for ROS out of the box.

diff --git a/articles/040_stories.md b/articles/040_stories.md
@@ -6,6 +6,8 @@ abstract:
   This article captures some stories which drive the direction of features in ROS.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2016-12
+last_modified: 2016-12
 categories: Overview
 ---
 
@@ -17,7 +19,11 @@ categories: Overview
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 The article enumerates a few stories which sketch what will be possible with ROS in the future.
 The list is by no means exhaustive.

diff --git a/articles/050_ros_rpc_design.md b/articles/050_ros_rpc_design.md
@@ -7,6 +7,8 @@ abstract:
   We focus here on specifying the user API and leave the implementation unspecified.
   It is expected that there are one or more RPC implementations which can be used, such as Apache Thrift, ROS RPC, or MsgPack.
 author: '[Tully Foote](https://github.com/tfoote)'
+date_written: 2014-06
+last_modified: 2019-05
 published: true
 ---
 
@@ -25,7 +27,11 @@ It can be considered memoranda and not necessarily the intention of how to devel
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 In ROS there are two types of Remote Procedure Call (RPC) primitives.
 ROS Services are basic request-response style RPCs, while ROS Actions additionally are preemptible and offer feedback while requests are being processed.

diff --git a/articles/055_ros_parameter_design.md b/articles/055_ros_parameter_design.md
@@ -6,6 +6,8 @@ abstract:
   This article is proposed design for the interfaces for interacting with parameters in ROS 2.
   We focus here on specifying the system design and leave the implementation unspecified.
 author: '[Tully Foote](https://github.com/tfoote)'
+date_written: 2015-09
+last_modified: 2019-05
 published: true
 ---
 
@@ -18,7 +20,11 @@ published: true
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Background
 

diff --git a/articles/060_ros_middleware_interface.md b/articles/060_ros_middleware_interface.md
@@ -7,6 +7,8 @@ abstract:
   It will outline the targeted use cases as well as their requirements and constraints.
   Based on that the developed middleware interface is explained.
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2014-08
+last_modified: 2017-09
 published: true
 categories: Middleware
 ---
@@ -19,7 +21,11 @@ categories: Middleware
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## The *middleware interface*
 

diff --git a/articles/080_ros_documentation_system.md b/articles/080_ros_documentation_system.md
@@ -5,6 +5,8 @@ permalink: articles/ros_documentation_system.html
 abstract:
   This article describes the proposed system for doing documentation for ROS 2.
 author: '[William Woodall](https://github.com/wjwwood)'
+date_written: 2015-01
+last_modified: 2016-02
 published: false
 ---
 
@@ -16,7 +18,11 @@ published: false
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 This document is meant to capture the results of discussions about the way we (the ROS 2 developers) would like documentation to work in ROS 2 and polish those results into a proposal.
 It is likely that this document should be refined and made into a REP once a suitable design is settled on.

diff --git a/articles/100_ament.md b/articles/100_ament.md
@@ -6,6 +6,8 @@ abstract:
   This article describes the build system "ament_cmake" and the meta build tool "ament_tools".
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2015-07
+last_modified: 2018-06
 categories: Overview
 ---
 
@@ -17,7 +19,11 @@ categories: Overview
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 <div class="alert alert-warning" markdown="1">
 When this article was originally written `ament_tools` was the ROS 2 specific build tool.

diff --git a/articles/101_build_tool.md b/articles/101_build_tool.md
@@ -6,6 +6,8 @@ abstract:
   This article describes the rationale for a universal build tool.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2017-03
+last_modified: 2021-01
 categories: Overview
 ---
 
@@ -17,7 +19,11 @@ categories: Overview
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Preface
 

diff --git a/articles/110_interface_definition.md b/articles/110_interface_definition.md
@@ -6,6 +6,8 @@ abstract:
   This article specifies the file format describing the data structures exchanged by ROS 2 components to interact with each other.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2015-06
+last_modified: 2020-02
 categories: Interfaces
 ---
 
@@ -21,7 +23,11 @@ With the transition to use ``IDL`` for specifying interfaces in ROS 2 Dashing th
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/111_mapping_dds_types.md b/articles/111_mapping_dds_types.md
@@ -6,6 +6,8 @@ abstract:
   This article specifies the mapping between the ROS interface types and the DDS types.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2015-06
+last_modified: 2020-02
 categories: Interfaces
 ---
 
@@ -21,7 +23,11 @@ With the transition to use ``IDL`` for specifying interfaces in ROS 2 Dashing th
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/112_generated_interfaces_cpp.md b/articles/112_generated_interfaces_cpp.md
@@ -6,6 +6,8 @@ abstract:
   This article describes the generated C++ code for ROS 2 interfaces.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2015-06
+last_modified: 2019-03
 categories: Interfaces
 ---
 
@@ -21,7 +23,11 @@ With the transition to use ``IDL`` for specifying interfaces in ROS 2 Dashing th
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/114_generated_interfaces_python.md b/articles/114_generated_interfaces_python.md
@@ -6,6 +6,8 @@ abstract:
   This article describes the generated Python code for ROS 2 interfaces.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2016-01
+last_modified: 2019-03
 categories: Interfaces
 ---
 
@@ -21,7 +23,11 @@ With the transition to use ``IDL`` for specifying interfaces in ROS 2 Dashing th
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/115_idl.md b/articles/115_idl.md
@@ -6,6 +6,8 @@ abstract:
   This describes defining interfaces using a subset of the [Interface Definition Language](https://www.omg.org/spec/IDL/) (IDL).
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2019-03
+last_modified: 2020-07
 categories: Interfaces
 ---
 
@@ -17,7 +19,11 @@ categories: Interfaces
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/116_legacy_interface_definition.md b/articles/116_legacy_interface_definition.md
@@ -6,6 +6,8 @@ abstract:
   This article specifies the file format coming from ROS 1 describing the data structures exchanged by ROS components to interact with each other.
 published: true
 author: '[Dirk Thomas](https://github.com/dirk-thomas)'
+date_written: 2019-03
+last_modified: 2021-02
 categories: Interfaces
 ---
 
@@ -17,7 +19,11 @@ categories: Interfaces
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Scope
 

diff --git a/articles/117_wide_strings.md b/articles/117_wide_strings.md
@@ -6,6 +6,8 @@ abstract:
   This article describes how ROS 2 will support sending multi-byte character data using the [Unicode](https://en.wikipedia.org/wiki/Unicode) standard.
   It also describes how such data will be sent over the ROS 1 bridge.
 author: '[Chris Lalancette](https://github.com/clalancette)'
+date_written: 2019-05
+last_modified: 2020-07
 published: true
 ---
 
@@ -18,7 +20,11 @@ published: true
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 ## Background
 

diff --git a/articles/120_realtime_background.md b/articles/120_realtime_background.md
@@ -5,6 +5,8 @@ permalink: articles/realtime_background.html
 abstract: This article is a brief survey of real-time computing requirements and methods to achieve real-time performance.
 published: true
 author: Jackie Kay
+date_written: 2016-01
+last_modified: 2016-05
 ---
 
 {:toc}
@@ -15,7 +17,11 @@ author: Jackie Kay
 {{ page.abstract }}
 </div>
 
-Original Author: {{ page.author }}
+Authors: {{ page.author }}
+
+Date Written: {{ page.date_written }}
+
+Last Modified: {% if page.last_modified %}{{ page.last_modified }}{% else %}{{ page.date_written }}{% endif %}
 
 This document seeks to summarize the requirements of real-time computing and the challenges of implementing real-time performance.
 It also lays out options for how ROS 2 could be structured to enforce real-time compatibility.