docs: add badges to README, update various URLs

And remove reference to inaccessible video

Change-Id: I3ea826ac393847226d760002d700ae1ee648ff71

AUTHORS.rst

@@ -1,15 +1,15 @@
 Mini-NDN Authors
-=================
+================
 
 The following lists maintainers, primary developers, and all much-appreciated contributors to Mini-NDN in alphabetic order.
 The specific contributions of individual authors can be obtained from the git history of the [official Mini-NDN repository](https://github.com/named-data/mini-ndn).
-If you would like to become a contributor to the official repository, please follow the recommendations in https://github.com/named-data/.github/blob/master/CONTRIBUTING.md.
+If you would like to become a contributor to the official repository, please follow the recommendations in <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>.
 
 * Alexander Afanasyev <https://users.cs.fiu.edu/~afanasyev>
 * Italo Valcy S Brito <https://github.com/italovalcy>
 * Muktadir R. Chowdhury <https://github.com/alvyC>
 * Damian Coomes <https://github.com/dmcoomes>
-* ***(Maintainer)*** Saurab Dulal <https://dulalsaurab.github.io>
+* ***(Former Maintainer)*** Saurab Dulal <https://dulalsaurab.github.io>
 * Laqin Fan <https://github.com/laqinfan>
 * ***(Former Maintainer)*** Ashlesh Gawande <https://www.linkedin.com/in/agawande>
 * Nicholas Gordon <https://github.com/gorgonical>
@@ -27,14 +27,14 @@ If you would like to become a contributor to the official repository, please fol
 
 
 Technical Advisors
--------------------
+------------------
 
 * Lan Wang <http://www.cs.memphis.edu/~lanwang>
 * Beichuan Zhang <http://cs.arizona.edu/~bzhang>
 
 
 The Mini-CCNx team
--------------------
+------------------
 
 * Carlos Cabral <https://github.com/carlosmscabral>
 * Caio de Moraes Elias <https://github.com/ocaio>

README.md

@@ -1,32 +1,35 @@
-Mini-NDN
-========
+# Mini-NDN
 
-If you are new to the NDN community of software generally, read the
-[Contributor's Guide](https://github.com/named-data/.github/blob/master/CONTRIBUTING.md).
+![Latest version](https://img.shields.io/github/v/tag/named-data/mini-ndn?label=Latest%20version)
+[![Docker](https://github.com/named-data/mini-ndn/actions/workflows/docker.yml/badge.svg)](https://github.com/named-data/mini-ndn/actions/workflows/docker.yml)
 
 ### What is Mini-NDN?
 
 Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
 research on the NDN platform based on [Mininet](https://github.com/mininet/mininet).
 Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the
-[NDN project](http://named-data.net/codebase/platform/) to emulate an NDN network on a single system.
+[NDN project](https://named-data.net/codebase/platform/) to emulate an NDN network on a single system.
 
-Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all
-users and developers. For more information about licensing details and limitations,
-please refer to [COPYING.md](COPYING.md).
+Mini-NDN is free and open source software distributed under the GNU General Public License version 3.
+For more information about licensing details and limitations, please refer to [`COPYING.md`](COPYING.md).
 
 The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team.
-Mini-NDN is open to contribution from the public.
-For more details, please refer to [AUTHORS.rst](AUTHORS.rst).
+For more details, please refer to [`AUTHORS.rst`](AUTHORS.rst).
 Bug reports and feedback are highly appreciated and can be made through our
-[Redmine site](http://redmine.named-data.net/projects/mini-ndn) and the
-[mini-ndn mailing list](http://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn).
+[Redmine site](https://redmine.named-data.net/projects/mini-ndn) and the
+[mini-ndn mailing list](https://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn).
+
+Mini-NDN is open to contribution from the public.
+If you are new to the NDN software community and intend to contribute to the codebase, please read our
+[Contributor's Guide](https://github.com/named-data/.github/blob/main/CONTRIBUTING.md).
 
 ### Documentation
 
-Please refer to http://minindn.memphis.edu/ for installation, usage, and other documentation.
+Please refer to <https://minindn.memphis.edu/> for installation, usage, and other documentation.
 The documentation can also be built locally using:
 
-    ./docs/build.sh
+```shell
+./docs/build.sh
+```
 
 and is available under `docs/_build/html`.

docs/hackathon.rst

@@ -1,10 +1,10 @@
 Past NDN Hackathon projects
 ===========================
 
-- 1st NDN Hackathon: `NFD integration test <http://ndncomm.github.io/mini-ndn/>`_.
+- 1st NDN Hackathon: `NFD integration tests <https://ndncomm.github.io/mini-ndn/>`_.
 - 2st NDN Hackathon: `Mini-NDN metrics <https://github.com/2nd-ndn-hackathon/mini-ndn-metrics>`_.
 - 3rd NDN Hackathon: `Mini-NDN cluster <https://github.com/3rd-ndn-hackathon/mini-NDN-cluster>`_.
 - 4th NDN Hackathon: `Mini-NDN wifi <https://github.com/4th-ndn-hackathon/Mini-NDN-Wi-Fi>`_.
 - 7th NDN Hackathon: `Mini-NDN documentation <https://github.com/7th-ndn-hackathon/mini-ndn-documentation>`_.
 - 11th NDN Hackathon: `Mini-NDN improvements <https://11th-ndn-hackathon.named-data.net/hacks.html#8-mini-ndn-improvements>`_.
-- 12th NDN Hackathon: `Mini-NDN improvements and Refactoring <https://12th-ndn-hackathon.named-data.net/hacks.html#7-mini-ndn-improvements>`_.
+- 12th NDN Hackathon: `Mini-NDN improvements and refactoring <https://12th-ndn-hackathon.named-data.net/hacks.html#7-mini-ndn-improvements>`_.

docs/index.rst

@@ -1,8 +1,3 @@
-.. Mini-NDN documentation master file, created by
-   sphinx-quickstart on Mon Sep 23 11:15:54 2019.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
 Mini-NDN: A Mininet-based NDN emulator
 ======================================
 
@@ -23,9 +18,9 @@ Mini-NDN: A Mininet-based NDN emulator
 Helpful Links
 -------------
 
-* `NDN Website <http://named-data.net/>`_
-* `NDN Contributor's Guide <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`_
-* `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>`_
+* `NDN Website <https://named-data.net/>`__
+* `NDN Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__
+* `Mininet Documentation <https://mininet.org/>`__
+* `Mini-NDN redmine <https://redmine.named-data.net/projects/mini-ndn>`__
+* `Mailing list <https://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`__
 * :doc:`Mini-NDN Team <authors>`

docs/install.rst

@@ -17,8 +17,8 @@ You must have sudo privileges to install and run Mini-NDN.
 Using Docker
 ------------
 
-You can use the nightly build from GitHub package registry
-::
+You can use the nightly build from GitHub package registry::
+
     docker run -m 4g --cpus=4 -it --privileged \
             -v /lib/modules:/lib/modules \
             ghcr.io/named-data/mini-ndn:master bash
@@ -42,9 +42,10 @@ The provided Dockerfile can be used to build an image from scratch. To build wit
 
 Additional recommendations
 --------------------------
+
 - It is recommended to set reasonable constraints on memory (`-m`) and CPU cores (`--cpus`), especially on less
   powerful or non-dedicated systems.
-- `--privileged` is mandatory for underlying `Mininet <http://mininet.org/>`_ to utilize the virtual switch
+- `--privileged` is mandatory for underlying `Mininet <https://mininet.org/>`__ to utilize the virtual switch
 - The root directory on `run` is `/mini-ndn`, which contains the installation and examples.
 - The GUI may not work for now due to docker and xterm setup issues and is independent from Mini-NDN.
   If you intend to run the GUI, pass `-e DISPLAY -v /tmp/.X11-unix:/tmp/.X11-unix` to the `docker run` command.
@@ -67,7 +68,7 @@ Mini-NDN has the following dependencies:
 - `NDN Essential Tools (ndn-tools) <https://github.com/named-data/ndn-tools>`_
 - `NDN Traffic Generator <https://github.com/named-data/ndn-traffic-generator>`_
 - `infoedit <https://github.com/NDN-Routing/infoedit>`_
-- `Mininet <http://mininet.org/>`_
+- `Mininet <https://mininet.org/>`_
 - `Mininet-WiFi <https://mininet-wifi.github.io/>`_ (optional)
 
 To install Mini-NDN and its dependencies, clone this repository and run:
@@ -247,4 +248,4 @@ Using gpsd (Experimental)
 The gpsd application included currently is based on in-progress work and
 is not treated as part of the main dependencies. To use it, install the
 `gpsd` and `nc` (netcat) from your package manager, if not already present,
-to enable the functionality.
+to enable the functionality.

docs/introduction.rst

@@ -1,14 +1,14 @@
 Introduction
-=================
-
-If you are new to the NDN community of software generally, read the
-`Contributor's Guide <https://github.com/named-data/NFD/blob/master/CONTRIBUTING.md>`_.
+============
 
 What is Mini-NDN?
 -----------------
 
 Mini-NDN is a lightweight networking emulation tool that enables testing, experimentation, and
-research on the NDN platform. It was initially based on `Mini-CCNx <https://github.com/chesteve/mn-ccnx>`_ which was a fork of `Mininet <https://github.com/mininet/mininet>`_. Mini-NDN uses the NDN libraries, NFD, NLSR, and tools released by the `NDN project <http://named-data.net/codebase/platform/>`_ to emulate an NDN network on a single system.
+research on the NDN platform. It was initially based on `Mini-CCNx <https://github.com/chesteve/mn-ccnx>`__
+which was a fork of `Mininet <https://github.com/mininet/mininet>`__. Mini-NDN uses the NDN libraries,
+NFD, NLSR, and tools released by the `NDN project <https://named-data.net/codebase/platform/>`__
+to emulate an NDN network on a single system.
 
 The first release of Mini-NDN is developed by members of the NSF-sponsored NDN project team.
 Mini-NDN is open to contribution from the public.
@@ -18,23 +18,16 @@ Mini-NDN is open to contribution from the public.
 License
 _______
 
-Mini-NDN is open and free software licensed under the GPL 3.0 license. Mini-NDN is free to all
-users and developers. For more information about licensing details and limitations,
-please refer to COPYING.md.
+Mini-NDN is free and open source software distributed under the GNU General Public License
+version 3. For more information about licensing details and limitations, please refer to
+`COPYING.md <https://github.com/named-data/mini-ndn/blob/master/COPYING.md>`__.
 
 Feedback/Mailing List
 _____________________
 
 Bug reports and feedback are highly appreciated and can be made through our
-`Redmine site <http://redmine.named-data.net/projects/mini-ndn>`_ and the
-`mini-ndn mailing list <http://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`_.
-
-Video
-_____
-
-.. raw:: html
+`Redmine site <https://redmine.named-data.net/projects/mini-ndn>`__ and the
+`mini-ndn mailing list <https://www.lists.cs.ucla.edu/mailman/listinfo/mini-ndn>`__.
 
- 	<div id="video-container" class="col-md-6 ">
-        <p>Mini-NDN (content maybe outdated)</p>
-         <iframe width="600" height="345" src="https://www.youtube.com/embed/UxHPqaUwefg" frameborder="0" allowfullscreen=""></iframe>
-    </div>
+If you are new to the NDN software community and intend to contribute to the codebase, please read our
+`Contributor's Guide <https://github.com/named-data/.github/blob/main/CONTRIBUTING.md>`__.

docs/videos.rst

@@ -3,16 +3,20 @@ Video Tutorials
 
 May be outdated since version 0.5.0.
 
+Mini-NDN Demo at ACM ICN 2017
+-----------------------------
+
 .. raw:: html
 
-    <div id="video-container" class="col-md-6 ">
-        <p>Mini-NDN Demo at ACM, 2017</p>
-         <iframe width="400" height="230" src="https://www.youtube.com/embed/xYRPHZe18o0" frameborder="0" allowfullscreen=""></iframe>
+    <div id="video-container" class="col-md-6">
+    <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/xYRPHZe18o0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
     </div>
 
+Mini-NDN Overview
+-----------------
+
 .. raw:: html
 
-    <div id="video-container" class="col-md-6 "">
-        <p>Mini-NDN Overview </p>
-         <iframe width="400" height="230" src="https://www.youtube.com/embed/Da7t8yBWzv0" frameborder="0" allowfullscreen=""> 
+    <div id="video-container" class="col-md-6">
+    <iframe width="560" height="315" src="https://www.youtube-nocookie.com/embed/Da7t8yBWzv0" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
     </div>

minindn/util.py

@@ -1,6 +1,6 @@
 # -*- Mode:python; c-file-style:"gnu"; indent-tabs-mode:nil -*- */
 #
-# Copyright (C) 2015-2020, The University of Memphis,
+# Copyright (C) 2015-2025, The University of Memphis,
 #                          Arizona Board of Regents,
 #                          Regents of the University of California.
 #
@@ -43,8 +43,7 @@ def getSafeName(namePrefix):
     :param namePrefix: name of the prefix
     """
     # remove redundant "/"es, multiple "/"es are an invalid representation for empty name component
-    # https://named-data.net/doc/NDN-packet-spec/current/changelog.html#version-0-3
-    namePrefix= "/" + ("/".join(filter(None, namePrefix.split("/"))))
+    namePrefix = "/" + "/".join(filter(None, namePrefix.split("/")))
     return quote(namePrefix, safe='/')
 
 def ssh(login, cmd):