Prepare 0.5.0 release
Small fix to properly handle ndnsec identity check message and also update copyright years in several files.
Change-Id: I1fae8749f7d755f4af1ccca519c236480ff3f824
diff --git a/docs/authors.rst b/docs/authors.rst
new file mode 100644
index 0000000..94292d0
--- /dev/null
+++ b/docs/authors.rst
@@ -0,0 +1 @@
+.. include:: ../AUTHORS.rst
\ No newline at end of file
diff --git a/docs/conf.py b/docs/conf.py
index 54591c1..45fb6f2 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -53,4 +53,9 @@
# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
\ No newline at end of file
+html_static_path = ['_static']
+
+# Need to specify the line below if custom conf.py
+# https://github.com/readthedocs/readthedocs.org/issues/2569
+# https://stackoverflow.com/questions/56336234/build-fail-sphinx-error-contents-rst-not-found
+master_doc = 'index'
diff --git a/docs/experiment.rst b/docs/experiment.rst
index 58cc303..af95117 100644
--- a/docs/experiment.rst
+++ b/docs/experiment.rst
@@ -128,6 +128,10 @@
in the ``minindn/apps`` folder. Or users may choose to directly run their application on nodes
such as ndnpingserver is run in ``minindn/helpers/experiment.py``.
+**Note:** A certain log-level can be set-up for all the NFD or NLSR nodes at once by passing it as an argument during the startup.
+
+``nfds = AppManager(self.ndn, self.ndn.net.hosts, Nfd, logLevel='DEBUG')`` (same for NLSR)
+
Execution
---------
@@ -233,3 +237,25 @@
``/tmp/minindn/<node-name>/security`` Note that no NLSR publishes the root
certificate, Mini-NDN installs root.cert in security folder for each
NLSR.
+
+Routing Options
+----------------
+
+Link State Routing (NLSR)
+_________________________
+By default, Mini-NDN uses `NLSR <https://github.com/named-data/NLSR>`__ for route management i.e route computation, route installation and so on. Additionally, the command line utility ``nlsrc`` can be used to advertise and withdraw prefixes and route status.
+
+
+NDN Routing Helper
+____________________
+Computes link-state or hyperbolic route/s from a given minindn topology and installs them in the FIB. The major benefit of the routing helper is to eliminate the overhead of NLSR when using larger topology. See ``examples/static_routing_experiment.py`` on how to use the helper class.
+
+**IMPORTANT:** NLSR and NDN Routing Helper are mutually exclusive, meaning you can only use one at a time, not both.
+
+**Note:** The current version of ``ndn_routing_helper`` is still in the experimental phase. It doesn't support node or link failure and runtime prefix advertisement/withdrawal. If you find any bug please report `here <https://redmine.named-data.net/projects/mini-ndn>`__ or contact the :doc:`authors <authors>`.
+
+IP Routing Helper
+____________________
+
+The routing helper allows to run IP-based evaluations with Mini-NDN. It configures static IP routes to all nodes, which means that all nodes can reach all other nodes in the network
+reachable, even when relaying is required. Please see ``examples/ip_rounting_experiment.py`` for a simple example.
diff --git a/docs/index.rst b/docs/index.rst
index d7d8f01..afc5d11 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -27,3 +27,4 @@
* `Mininet Documentation <http://mininet.org/>`_
* `Mini-NDN redmine <https://redmine.named-data.net/projects/mini-ndn>`_
* `Mailing list <http://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`_
+* :doc:`Mini-NDN Team <authors>`
diff --git a/docs/release-notes.rst b/docs/release-notes.rst
index 79cbb0f..67c5fc4 100644
--- a/docs/release-notes.rst
+++ b/docs/release-notes.rst
@@ -1,6 +1,62 @@
Release Notes
=============
+Mini-NDN version 0.5.0 (Major changes since version 0.4.0)
+----------------------------------------------------------
+
+**Breaking Changes**:
+
+- `Mini-NDN re-design <https://redmine.named-data.net/issues/5062>`__: simple and robust design with better quality, control, and more consistency with Mininet
+
+**New features**:
+
+- Add a script to generate up-to-date NDN testbed topologies for Mini-NDN
+
+- Add Mini-NDN utility application for PCAP logging
+
+- Add NDN routing helper to compute centralized LS and HR routes
+
+- Add routing helper to allow IP communication in experiments
+
+- Add startup experiments for NLSR and current testbed topology
+
+- Move the NDNPing wrapper method to a helper class
+
+- Create a helper class to provide a wrapper around ``nfdc``
+
+**Improvements and Bug Fixes**:
+
+- Change workDir and resultDir to be class attribute
+
+- Quiet apt install for Vagrant
+
+- Fix route computation bug in ``ndn_routing_helper``
+
+- Fix overwriting of existing prefixes in ``ndn_routing_helper``
+
+- Move log files to resultDir after evaluation finishes
+
+- Check for duplicate HR coordinates in the topology file
+
+- Check PSync integration and add a tests case for it
+
+- Bug fixes in nfdc and experiments
+
+- Added functionality to check Mini-NDN dependencies
+
+- Parser fix to avoid an infinite loop
+
+- Allow use of NFD and NLSR PPA with Mini-NDN
+
+- Remove arbitrary arguments in favor of parsing arguments from experiment files
+
+- Auto-complete command-line arguments
+
+- Add option to set CS size
+
+- Adjust to use ndn-cxx logging
+
+
Mini-NDN version 0.4.0 (changes since version 0.3.0)
----------------------------------------------------