docs: Update website documentation
Change-Id: I01fa76eabc327a5638627b27bc51e6330d5ad210
Refs: #4213, #4039
diff --git a/docs/source/_templates/indexcontent.html b/docs/source/_templates/indexcontent.html
index 4420c36..f7134ce 100644
--- a/docs/source/_templates/indexcontent.html
+++ b/docs/source/_templates/indexcontent.html
@@ -5,6 +5,7 @@
<h1>{{ docstitle|e }}</h1>
<p>
+This website includes the ndnSIM documentation and is intended to help the community use the simulator for NDN experimentation. It is not intended to present the principles or the design of the NDN architecture and communication model.
We invite you to <a href="http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim" target="_blank">join our mailing list</a> to see and participate in discussions about ndnSIM implementation and simulations in general (<a href="http://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a>).
</p>
@@ -58,8 +59,9 @@
<td width="50%" valign="top">
<h2>ndnSIM Versions</h2>
<div class="tile">
- <p class="biglink"><a class="biglink" href="#">ndnSIM 2.3</a><br/>
+ <p class="biglink"><a class="biglink" href="#">ndnSIM 2.4</a><br/>
<span class="linkdescr">latest version</span></p>
+ <p class="biglink"><a class="biglink" href="http://ndnsim.net/2.3/">ndnSIM 2.3</a><br/>
<p class="biglink"><a class="biglink" href="http://ndnsim.net/2.2/">ndnSIM 2.2</a><br/>
<p class="biglink"><a class="biglink" href="http://ndnsim.net/2.1/">ndnSIM 2.1</a><br/>
<p class="biglink"><a class="biglink" href="http://ndnsim.net/2.0/">ndnSIM 2.0</a><br/>
@@ -76,6 +78,9 @@
<p>If you are referring to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
<ul>
<li>
+ S. Mastorakis, A. Afanasyev, and L. Zhang, "On the Evolution of ndnSIM: an Open-Source Simulator for NDN Experimentation," ACM SIGCOMM Computer Communication Review (CCR), July 2017 (<a class="reference external" href="https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf">PDF</a>) (<a class="reference external" href="http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim">BibTex</a>)
+ </li>
+ <li>
S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, “ndnSIM 2: An updated NDN simulator for NS-3,” NDN, Technical Report NDN-0028, Revision 2, 2016 (<a class="reference external" href="https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf">PDF</a>) (<a class="reference external" href="http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399">BibTex</a>)
</li>
<li>
@@ -97,6 +102,9 @@
<p class="biglink"><a class="biglink" href="http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim" target="_blank">ndnSIM mailing list</a><br/>
<span class="linkdescr"><a href="http://www.lists.cs.ucla.edu/pipermail/ndnsim/" target="_blank">mailing list archives</a></span></p>
+ <p class="biglink"><a class="biglink" href="{{ pathto("community-contributions") }}">Community Contributions</a><br/>
+ <span class="linkdescr">very much appreciated contributions of the ndnSIM user community</span></p>
+
<p class="biglink"><a class="biglink" href="{{ pathto("meta/authors") }}">ndnSIM Team</a></p>
<p class="biglink"><a class="biglink" href="{{ pathto("meta/copying") }}">Copyright and License</a></p>
</div>
diff --git a/docs/source/community-contributions.rst b/docs/source/community-contributions.rst
new file mode 100644
index 0000000..0135fda
--- /dev/null
+++ b/docs/source/community-contributions.rst
@@ -0,0 +1,37 @@
+.. _community-contributions:
+
+Contributions of the ndnSIM User Community
+==========================================
+
+Some of the very much appreciated contributions of the user community include
+the following:
+
+#. **Script for automated installation on Ubuntu 14.04, 15.04, 16.04 and 17.04.**
+
+ The `script <http://mohittahiliani.blogspot.in/2015/10/ns-3-installing-ndnsim-on-ubuntu.html>`__
+ was created and is maintained by Kiran Ramesh, Karthik S, Ayush Agarwal,
+ Viyom Mittal, Vivek Jain, and Mohit P. Tahiliani,
+ Wireless Information Networking Group (WiNG), NITK Surathkal.
+
+#. **Adding custom fields to packets in ndnSIM 2.3 without forking the entire repository.**
+
+ The `article <https://lo.calho.st/networks/adding-custom-packet-fields-to-packets-in-ndnsim-2-3-without-forking-the-entire-repository/>`__
+ was published by Travis Mick.
+
+#. **Run ndnSIM with scenario template without root access.**
+
+ The `article <http://chkr.at/wordpress/?p=99/>`__
+ was published by Christian Kreuzberger.
+
+#. **How-To: Install ndnSIM with BRITE on Ubuntu 14.04.**
+
+ The `article <https://chkr.at/wordpress/?p=62>`__
+ was published by Christian Kreuzberger.
+
+#. **Installing ndnSIM on Ubuntu 15.04.**
+
+ The `article <http://bupeanubuntu.blogspot.com/2015/08/installing-ndnsim-on-ubuntu-1504.html>`__
+ was published by Bhupendra Moharil.
+
+.. note:: If you have contributed to ndnSIM, please let us know, so that we can
+ add your contribution.
diff --git a/docs/source/conf.py b/docs/source/conf.py
index 8a5d508..8bdfd9f 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -50,7 +50,7 @@
# if os.getenv('GOOGLE_ANALYTICS', None):
# addExtensionIfExists('sphinxcontrib.googleanalytics')
-
+
# Add any paths that contain templates here, relative to this directory.
templates_path = ['_templates']
@@ -65,14 +65,14 @@
# General information about the project.
project = u''
-copyright = u'2011-2015 (c) Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang'
+copyright = u'2011-2017 (c) Alexander Afanasyev, Spyridon Mastorakis, Ilya Moiseenko, and Lixia Zhang'
# The version info for the project you're documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
-version = '2.1'
+version = '2.4'
# The full version, including alpha/beta/rc tags.
release = 'ndnSIM'
diff --git a/docs/source/getting-started.rst b/docs/source/getting-started.rst
index c193c0a..3b74f68 100644
--- a/docs/source/getting-started.rst
+++ b/docs/source/getting-started.rst
@@ -9,7 +9,6 @@
ndnSIM 2.x has been successfully compiled and used on following platforms:
-- Ubuntu Linux 14.04 (32- and 64-bit platform)
- Ubuntu Linux 16.04 (32- and 64-bit platform)
- macOS 10.10
- macOS 10.11
diff --git a/docs/source/intro.rst b/docs/source/intro.rst
index 20fc56f..9dd0908 100644
--- a/docs/source/intro.rst
+++ b/docs/source/intro.rst
@@ -21,7 +21,7 @@
- Allows [simulation of real applications](http://ndnsim.net/2.1/guide-to-simulate-real-apps.html)
written against ndn-cxx library
-
+
A new release of `NS-3 based Named Data Networking (NDN) simulator <http://ndnsim.net/1.0/>`__
went through a number of extensive refactoring and rewriting. The key new features of the
new version:
@@ -62,7 +62,9 @@
More documentation
------------------
-Overall structure of ndnSIM is described in our technical reports:
+Overall structure of ndnSIM is described in our paper and technical reports:
+
+- **S. Mastorakis, A. Afanasyev, and L. Zhang, "On the Evolution of ndnSIM: an Open-Source Simulator for NDN Experimentation," ACM SIGCOMM Computer Communication Review (CCR), July 2017** (`PDF <https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf>`__, `BibTex <http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim>`__)
- **S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM 2: An updated NDN simulator for NS-3," NDN, Technical Report NDN-0028, Revision 2, 2016** (`PDF <https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399>`__)
diff --git a/docs/source/metric.rst b/docs/source/metric.rst
index 29b2973..67aa355 100644
--- a/docs/source/metric.rst
+++ b/docs/source/metric.rst
@@ -248,7 +248,7 @@
Content store trace helper
--------------------------
-NOTE: This tracer works ONLY when the content store structure of ndnSIM is used!
+NOTE: This tracer works ONLY when the OldContentStore structure is used!
- :ndnsim:`ndn::CsTracer`
diff --git a/docs/source/tutorial.rst b/docs/source/tutorial.rst
index 69cd53d..373184a 100644
--- a/docs/source/tutorial.rst
+++ b/docs/source/tutorial.rst
@@ -4,9 +4,7 @@
=======
The ndnSIM 2.0 is NS-3 module that implements Named Data Networking (NDN) communication
-model, the clean slate Internet design. ndnSIM is specially optimized for simulation
-purposes and has a cleaner and more extensible internal structure comparing to the
-existing NDN implementation (NDNx).
+model, the clean slate Internet design.
We invite you to `join our mailing list
<http://www.lists.cs.ucla.edu/mailman/listinfo/ndnsim>`_ to see and participate in
@@ -31,6 +29,7 @@
parallel-simulations
guide-to-simulate-real-apps
ndnsim-research-papers
+ community-contributions
.. toctree::
@@ -45,6 +44,8 @@
If you refer to ndnSIM in a published work, please cite the following papers, not just the ndnSIM website. Thank you!
+- **S. Mastorakis, A. Afanasyev, and L. Zhang, "On the Evolution of ndnSIM: an Open-Source Simulator for NDN Experimentation," ACM SIGCOMM Computer Communication Review (CCR), July 2017** (`PDF <https://ccronline.sigcomm.org/wp-content/uploads/2017/08/sigcomm-ccr-final112-full-letter.pdf>`__, `BibTex <http://web.cs.ucla.edu/~mastorakis/bibtex-ndnsim>`__)
+
- **S. Mastorakis, A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM 2: An updated NDN simulator for NS-3," NDN, Technical Report NDN-0028, Revision 2, 2016** (`PDF <https://named-data.net/wp-content/uploads/2016/11/ndn-0028-2-ndnsim-v2.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/399>`__)
- **A. Afanasyev, I. Moiseenko, and L. Zhang, "ndnSIM: NDN simulator for NS-3," NDN, Technical Report NDN-0005, 2012** (`PDF <https://named-data.net/wp-content/uploads/TRndnsim.pdf>`__, `BibTex <http://lasr.cs.ucla.edu/afanasyev/bibwiki/bibtex/367>`__)
diff --git a/examples/ndn-different-strategy-per-prefix.cpp b/examples/ndn-different-strategy-per-prefix.cpp
index fcf12f5..808124d 100644
--- a/examples/ndn-different-strategy-per-prefix.cpp
+++ b/examples/ndn-different-strategy-per-prefix.cpp
@@ -17,7 +17,7 @@
* ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
-// ndn-multiple-strategies.cpp
+// ndn-different-strategy-per-prefix.cpp
#include "ns3/core-module.h"
#include "ns3/network-module.h"
diff --git a/examples/ndn-grid-multiple-strategies.cpp b/examples/ndn-grid-multiple-strategies.cpp
index b6ca0ed..a97c3d0 100644
--- a/examples/ndn-grid-multiple-strategies.cpp
+++ b/examples/ndn-grid-multiple-strategies.cpp
@@ -17,7 +17,7 @@
* ndnSIM, e.g., in COPYING.md file. If not, see <http://www.gnu.org/licenses/>.
**/
-// ndn-multiple-strategies.cpp
+// ndn-grid-multiple-strategies.cpp
#include "ns3/core-module.h"
#include "ns3/network-module.h"