From bf4c131f8261e903f4af08c73c3d1be9eb81cc2b Mon Sep 17 00:00:00 2001 From: Davide Pesavento Date: Thu, 23 Feb 2023 20:32:01 -0500 Subject: [PATCH] docs: update several URLs to point to docs.named-data.net Change-Id: I4bab897f17e2b929675119198c9eab0309b6cc3e --- .github/workflows/docs.yml | 3 -- CITATION.cff | 2 +- docs/INSTALL.rst | 4 +- docs/index.rst | 4 +- docs/named_data_theme/named_data_header.html | 2 +- docs/overview.rst | 19 ++++---- docs/release-notes/release-notes-0.1.0.rst | 2 +- docs/release-notes/release-notes-0.6.6.rst | 4 +- docs/release-notes/release-notes-0.7.0.rst | 2 +- docs/releases.rst | 44 +++++++++---------- nfd.conf.sample.in | 2 +- .../nfd-status.xsl | 2 +- 12 files changed, 43 insertions(+), 47 deletions(-) diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index 915954c4..b0f5c82e 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -1,9 +1,6 @@ name: Docs on: push: - paths-ignore: - - '*.md' - - '.mailmap' workflow_dispatch: inputs: skip-deploy: diff --git a/CITATION.cff b/CITATION.cff index 623178da..dbcae282 100644 --- a/CITATION.cff +++ b/CITATION.cff @@ -3,7 +3,7 @@ message: If you use NFD in your research, please cite it as below. license: GPL-3.0-or-later repository-code: "https://github.com/named-data/NFD" title: Named Data Networking Forwarding Daemon -url: "https://named-data.net/doc/NFD/" +url: "https://docs.named-data.net/NFD/" preferred-citation: authors: - name: Named Data Networking Project Team diff --git a/docs/INSTALL.rst b/docs/INSTALL.rst index b960b9a0..188ceebc 100644 --- a/docs/INSTALL.rst +++ b/docs/INSTALL.rst @@ -91,7 +91,7 @@ checkout the correct release tag (e.g., ``*-0.8.1``) from both repositories. Prerequisites ~~~~~~~~~~~~~ -Install the `ndn-cxx library `__ +Install the `ndn-cxx library `__ and its prerequisites. On Linux, NFD needs the following dependencies to enable optional features: @@ -278,7 +278,7 @@ of NDN using the following applications and libraries. Sample applications: - + `Simple examples using the ndn-cxx library `__ + + `Simple examples using the ndn-cxx library `__ + `Simple examples using the python-ndn library `__ Real applications and libraries: diff --git a/docs/index.rst b/docs/index.rst index f586626e..79f8fdcb 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -18,7 +18,7 @@ NFD: Named Data Networking Forwarding Daemon releases **NFD** is a network forwarder that implements and evolves together with the Named Data -Networking (NDN) `protocol `__. +Networking (NDN) `protocol `__. NFD is a core component of the `NDN Platform `__. Documentation @@ -64,7 +64,7 @@ For developers Issues ------ -Please submit any bugs or feature requests to the +Please submit any bug reports or feature requests to the `NFD issue tracker `__. License diff --git a/docs/named_data_theme/named_data_header.html b/docs/named_data_theme/named_data_header.html index c0588964..9bade403 100644 --- a/docs/named_data_theme/named_data_header.html +++ b/docs/named_data_theme/named_data_header.html @@ -32,7 +32,7 @@ $mathjax diff --git a/docs/overview.rst b/docs/overview.rst index e45286a4..b13b5911 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -1,26 +1,25 @@ NFD Overview ============ -NDN Forwarding Daemon (NFD) is a network forwarder that implements and evolves together -with the Named Data Networking (NDN) `protocol `__. +NDN Forwarding Daemon (NFD) is a network forwarder that implements and evolves together with +the Named Data Networking (NDN) `protocol `__. Since the initial public release in 2014, NFD has been a core component of the `NDN Platform `__. NFD is developed by a community effort. Although the first release was mostly done by the -members of `NSF-sponsored NDN project team -`__, it already contains significant -contributions from people outside the project team (for more details, refer to `AUTHORS.md -`__). We strongly encourage -participation from all interested parties, since broader community support is key for NDN -to succeed as a new Internet architecture. Bug reports and feedback are highly -appreciated and can be made through `Redmine site +members of `NSF-sponsored NDN project team `__, +it already contains significant contributions from people outside the project team (for more +details, refer to `AUTHORS.md `__). +We strongly encourage participation from all interested parties, since broader community +support is key for NDN to succeed as a new Internet architecture. Bug reports and feedback +are highly appreciated and can be made through our `Redmine site `__ and the `ndn-interest mailing list `__. The main design goal of NFD is to support diverse experimentation of NDN technology. The design emphasizes *modularity* and *extensibility* to allow easy experiments with new protocol features, algorithms, and applications. We have not fully optimized the code for -performance. The intention is that performance optimizations are one type of experiments +performance. The intention is that performance optimizations are one type of experiments that developers can conduct by trying out different data structures and different algorithms; over time, better implementations may emerge within the same design framework. To facilitate such experimentation with the forwarder, the NFD team has also written a diff --git a/docs/release-notes/release-notes-0.1.0.rst b/docs/release-notes/release-notes-0.1.0.rst index a6fea305..bd76dfb2 100644 --- a/docs/release-notes/release-notes-0.1.0.rst +++ b/docs/release-notes/release-notes-0.1.0.rst @@ -7,7 +7,7 @@ This is an incomplete list of features that are implemented in NFD version 0.1.0 - **Packet Format** - + `NDN-TLV `__ + + `NDN-TLV `__ + LocalControlHeader, to allow apps to set outgoing face and learn incoming face - **Faces** diff --git a/docs/release-notes/release-notes-0.6.6.rst b/docs/release-notes/release-notes-0.6.6.rst index 822a8d0a..e01fe172 100644 --- a/docs/release-notes/release-notes-0.6.6.rst +++ b/docs/release-notes/release-notes-0.6.6.rst @@ -5,8 +5,8 @@ Release date: April 29, 2019 .. note:: This is the last release to support the `NDN packet format version 0.2.1 - `__. The next release will support - only the `v0.3 packet format `__. + `__. The next release will support + only the `v0.3 packet format `__. New features ^^^^^^^^^^^^ diff --git a/docs/release-notes/release-notes-0.7.0.rst b/docs/release-notes/release-notes-0.7.0.rst index e04ec090..38eaaf75 100644 --- a/docs/release-notes/release-notes-0.7.0.rst +++ b/docs/release-notes/release-notes-0.7.0.rst @@ -6,7 +6,7 @@ Release date: January 13, 2020 New features ^^^^^^^^^^^^ -- Support only `NDN packet format version 0.3 `__ +- Support only `NDN packet format version 0.3 `__ (:issue:`4805`, :issue:`4581`, :issue:`4913`) - Initial support for ``PitToken`` (:issue:`4532`) diff --git a/docs/releases.rst b/docs/releases.rst index 067e78a2..541760e1 100644 --- a/docs/releases.rst +++ b/docs/releases.rst @@ -10,127 +10,127 @@ All NFD Releases release-notes/* * **NFD version 22.12** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 22.02** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.7.1** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.7.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.6** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.5** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.4** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.3** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.2** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.1** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.6.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.5.1** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.5.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `, `Documentation `__) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.4.1** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.4.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.3.4** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.3.3** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.3.2** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.3.1** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.3.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) * **NFD version 0.2.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) @@ -142,7 +142,7 @@ All NFD Releases `src (git) `__ * **NFD version 0.1.0** - (:doc:`Release Notes `, `Documentation `__) + (:doc:`Release Notes `) `src (git) `__, `src (tarball) `__ (`checksum `__) diff --git a/nfd.conf.sample.in b/nfd.conf.sample.in index e929dc9d..660beb2d 100644 --- a/nfd.conf.sample.in +++ b/nfd.conf.sample.in @@ -352,7 +352,7 @@ rib ; ; trust-anchors, which are briefly defined in this file. For more information refer to ; ; validator configuration file format documentation: ; ; - ; ; https://named-data.net/doc/ndn-cxx/current/tutorials/security-validator-config.html + ; ; https://docs.named-data.net/ndn-cxx/current/tutorials/security-validator-config.html ; ; ; ; A trust-anchor is a pre-trusted certificate. This can be any certificate that is the ; ; root of certification chain (e.g., NDN testbed root certificate) or an existing diff --git a/tools/nfd-status-http-server-files/nfd-status.xsl b/tools/nfd-status-http-server-files/nfd-status.xsl index d2015b19..f0656c6a 100644 --- a/tools/nfd-status-http-server-files/nfd-status.xsl +++ b/tools/nfd-status-http-server-files/nfd-status.xsl @@ -22,7 +22,7 @@ - Powered by NFD version . + Powered by NFD version .