NDK: [MAINTENANCE] Use the release branch for the latest NDK release,…

… instead of the main branch
CESNET · Oct 11, 2024 · 6557824 · 6557824
1 parent 32fb9b5
commit 6557824
Show file tree

Hide file tree

Showing 3 changed files with 9 additions and 9 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -21,9 +21,9 @@ jobs:
           mkdir public/html
           cp doc/source/index.html public/html/
           sphinx-build -M html doc/source public/devel
-          git checkout main
-          sphinx-build -M html doc/source public/main
-          mv public/main/html/ public/html/main
+          git checkout release
+          sphinx-build -M html doc/source public/release
+          mv public/release/html/ public/html/release
           mv public/devel/html/ public/html/devel
           touch public/html/.nojekyll
       - name: Deploy

diff --git a/README.md b/README.md
@@ -1,7 +1,7 @@
 # NDK-FPGA
 
 This repository contains FPGA part of the Network Development Kit (NDK) for FPGA acceleration cards. The NDK allows users to quickly and easily develop FPGA-accelerated network applications. The NDK is optimized for high throughput and scalability to support up to 400 Gigabit Ethernet. The NDK-based Minimal (reference) application is also included in this (NDK-FPGA) repository.
- 
+
 The NDK-based Minimal application is a simple example of how to build an FPGA application using the NDK. It can also be a starting point for your NDK-based application. The NDK-based Minimal application does not process network packets in any way; it only sends and receives them. If the DMA IP is enabled, then it forwards the network packets to the computer memory. You can find more detailed information in [the NDK-FPGA documentation (devel branch) here](https://cesnet.github.io/ndk-fpga/devel/).
 
 **The DMA Medusa IP is not part of the open-source NDK. If the DMA IP is disabled, it is replaced by a loopback. [You can get the NDK, including the DMA Medusa IP and professional support, through our partner BrnoLogic](https://support.brnologic.com/).**
@@ -49,8 +49,8 @@ The [NDK-FPGA documentation (devel branch) in chapter "How to start"](https://ce
 
 ## Documentation
 
-We use a documentation system based on the [Sphinx tool](https://www.sphinx-doc.org), which compiles complete documentation from source files in the [reStructuredText](https://docutils.sourceforge.io/rst.html) format. We also use the [Sphinx-vhdl](https://github.com/CESNET/sphinx-vhdl) for generating documentation from the VHDL code. The documentation automatically builds with each contribution to the devel/main branch and is available online here:
-- [**NDK-FPGA documentation (main branch)**](https://cesnet.github.io/ndk-fpga/main/)
+We use a documentation system based on the [Sphinx tool](https://www.sphinx-doc.org), which compiles complete documentation from source files in the [reStructuredText](https://docutils.sourceforge.io/rst.html) format. We also use the [Sphinx-vhdl](https://github.com/CESNET/sphinx-vhdl) for generating documentation from the VHDL code. The documentation automatically builds with each contribution to the devel/release branch and is available online here:
+- [**NDK-FPGA documentation (release branch)**](https://cesnet.github.io/ndk-fpga/release/)
 - [**NDK-FPGA documentation (devel branch)**](https://cesnet.github.io/ndk-fpga/devel/)
 
 ### How to manually build documentation
@@ -95,4 +95,4 @@ Unless otherwise noted, the content of this repository is available under the BS
 
 ## Repository Maintainer
 
-- Jakub Cabal, [email protected]
+- Jakub Cabal, [email protected]
diff --git a/doc/source/index.html b/doc/source/index.html
@@ -1,4 +1,4 @@
 <!DOCTYPE html>
 <meta charset="utf-8">
-<title>Redirecting to MAIN docs</title>
-<meta http-equiv="refresh" content="0; URL=./main/index.html">
+<title>Redirecting to RELEASE docs</title>
+<meta http-equiv="refresh" content="0; URL=./release/index.html">