Skip to content

Commit d18ad1c

Browse files
authored
Improve developer documentation (#97)
* Improve developer documentation Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> * Address spell checking issues Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com> --------- Signed-off-by: Arrobo, Gabriel <gabriel.arrobo@intel.com>
1 parent 2f7a372 commit d18ad1c

File tree

4 files changed

+28
-8
lines changed

4 files changed

+28
-8
lines changed

conf.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ def get_version():
3737

3838
# The full version, including alpha/beta/rc tags
3939
# release = version # Temporarily set to 'Latest'
40-
release = u'Latest'
40+
release = u'latest'
4141

4242
# -- General configuration ---------------------------------------------------
4343

developer/aiab.rst

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,12 @@
77
Aether In a Box - 4G
88
====================
99

10-
Currently `Aether OnRamp <https://docs.aetherproject.org/onramp/overview.html>`_
11-
doesn't support 4G deployment.
10+
Aether in a Box (AiaB) has been deprecated and replaced by `Aether OnRamp <https://docs.aetherproject.org/onramp/overview.html>`_.
11+
12+
Aether OnRamp is the recommended way to deploy and test SD-Core. For 4G deployments,
13+
OnRamp provides support through the **Physical eNBs blueprint**, which supports
14+
4G-based versions of both SD-Core and AMP.
15+
16+
For detailed information about deploying 4G with physical eNBs, see the
17+
`Physical eNBs Blueprint <https://docs.aetherproject.org/onramp/blueprints.html#physical-enbs>`_
18+
in the Aether OnRamp documentation.

developer/aiab5g.rst

Lines changed: 17 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,21 @@
77
Aether In a Box - 5G
88
====================
99

10-
Previously developers used Aether in a Box (AiaB) environment to test SD-Core. But AiaB is
11-
now deprecated and Aether OnRamp is suggested way for developers to install Aether.
10+
Aether in a Box (AiaB) has been deprecated and replaced by `Aether OnRamp <https://docs.aetherproject.org/onramp/overview.html>`_.
1211

13-
The documentation for deploying SD-Core (Private 5G) solution on a Kubernetes cluster is
14-
located in `Aether OnRamp <https://docs.aetherproject.org/onramp/overview.html>`_,
15-
where specifics about setting up Aether 5G, running 5G test, troubleshooting, and other details are described.
12+
Aether OnRamp is the recommended way to deploy and test SD-Core. It provides an incremental
13+
path for users to learn about, customize, experiment with, and deploy Aether with live 5G traffic.
14+
15+
OnRamp supports multiple deployment scenarios through various **blueprints**, including:
16+
17+
* Quick Start deployment (single VM or server)
18+
* Emulated RAN using gNBSim
19+
* Physical RAN with real gNBs
20+
* Multiple UPFs configuration
21+
* UERANSIM for throughput testing
22+
* SD-RAN integration
23+
* OAI and srsRAN 5G support
24+
25+
For comprehensive documentation on deploying SD-Core (Private 5G) on a Kubernetes cluster,
26+
including setup, testing, troubleshooting, and operational details, visit the
27+
`Aether OnRamp Documentation <https://docs.aetherproject.org/onramp/overview.html>`_.

dict.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -241,6 +241,7 @@ smftest
241241
spgw
242242
spgwc
243243
sriov
244+
srsRAN
244245
sst
245246
stabilisation
246247
tac

0 commit comments

Comments
 (0)