Skip to content

Commit 046d685

Browse files
see7elucaaamaral
authored andcommitted
chore: Fix documentation links to ensure correct file extensions and improve clarity
- Updated links in alerts_troubleshooting.md, alert.md, and other files to include the correct .md extension for consistency. - Adjusted API endpoint formatting in proposals and howtos for better readability. - Ensured all references to configuration steps and troubleshooting guides are accurate and up-to-date. Signed-off-by: Gabryel Nóbrega <[email protected]>
1 parent 2e7945e commit 046d685

File tree

80 files changed

+152
-152
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

80 files changed

+152
-152
lines changed

.github/workflows/docs-test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ jobs:
4444
- name: Verify build output
4545
run: |
4646
cd docusaurus/
47-
test -d build-test && echo "✅ Build successful"
47+
test -d build && echo "✅ Build successful"
4848
4949
markdown-lint:
5050
name: Markdown Format Check

docusaurus/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,8 @@
1313
"write-translations": "docusaurus write-translations",
1414
"write-heading-ids": "docusaurus write-heading-ids",
1515
"test": "node test.js",
16-
"build:test": "docusaurus build --dev --no-minify --out-dir ./build-test",
17-
"check-links": "lychee ./build_test/**/*.html --exclude-mail --exclude './**/proposal/**'"
16+
"build:test": "docusaurus build --dev --no-minify --out-dir ./build",
17+
"check-links": "lychee ./build/**/*.html --exclude-mail --exclude './**/proposal/**'"
1818
},
1919
"dependencies": {
2020
"@docusaurus/core": "3.7.0",

docusaurus/sidebars.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
1515
const sidebars = {
1616
// By default, Docusaurus generates a sidebar from the docs folder structure
17-
tutorialSidebar: [{type: 'autogenerated', dirName: '.'}],
17+
versionSidebar: [{type: 'autogenerated', dirName: '.'}],
1818

1919
// But you can create a sidebar manually
2020
/*

docusaurus/versioned_docs/version-1.0.0/lte/config_agw.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ original_id: config_agw
1111
Before beginning to configure your Magma Access Gateway, you will need to make
1212
sure that it is running all services without crashing. You will also need a
1313
working Orchestrator setup. Please follow the instructions in
14-
"[Deploying Orchestrator](../orc8r/deploy_intro)" for a
14+
"[Deploying Orchestrator](../orc8r/deploy_intro.md)" for a
1515
successful Orchestrator installation.
1616

17-
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb)".
17+
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb.md)".
1818
For this part, we strongly recommend that you SSH into the AGW box from a host
1919
machine instead of using the AGW directly.
2020

docusaurus/versioned_docs/version-1.0.0/lte/enodebd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ original_id: enodebd
77
# eNodeB Configuration
88
## Prerequisites
99

10-
Make sure you follow the instructions in "[Deploying Orchestrator](../orc8r/deploy_intro)" for successful
11-
installation of Orchestrator and the instructions in "[AGW Configuration](config_agw)" to provision and
10+
Make sure you follow the instructions in "[Deploying Orchestrator](../orc8r/deploy_intro.md)" for successful
11+
installation of Orchestrator and the instructions in "[AGW Configuration](config_agw.md)" to provision and
1212
configure your Access Gateway (AGW).
1313

1414
## S1 interface

docusaurus/versioned_docs/version-1.0.X/lte/config_agw.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ original_id: config_agw
1111
Before beginning to configure your Magma Access Gateway, you will need to make
1212
sure that it is running all services without crashing. You will also need a
1313
working Orchestrator setup. Please follow the instructions in
14-
"[Deploying Orchestrator](../orc8r/deploy_intro)" for a
14+
"[Deploying Orchestrator](../orc8r/deploy_intro.md)" for a
1515
successful Orchestrator installation.
1616

17-
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb)".
17+
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb.md)".
1818
For this part, we strongly recommend that you SSH into the AGW box from a host
1919
machine instead of using the AGW directly.
2020

docusaurus/versioned_docs/version-1.0.X/lte/enodebd.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,8 @@ original_id: enodebd
77
# eNodeB Configuration
88
## Prerequisites
99

10-
Make sure you follow the instructions in "[Deploying Orchestrator](../orc8r/deploy_intro)" for successful
11-
installation of Orchestrator and the instructions in "[AGW Configuration](config_agw)" to provision and
10+
Make sure you follow the instructions in "[Deploying Orchestrator](../orc8r/deploy_intro.md)" for successful
11+
installation of Orchestrator and the instructions in "[AGW Configuration](config_agw.md)" to provision and
1212
configure your Access Gateway (AGW).
1313

1414
## S1 interface

docusaurus/versioned_docs/version-1.1.X/faq/magma_faq.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ This section lists some of the commonly asked questions related to Magma operati
7676
- Login to Gateway, then run `sudo checkin_cli.py`.
7777

7878
### Where can I find API endpoint?
79-
- If you have followed the [install guide](../orc8r/deploy_install), it'll be at `https://api.youdomain.com/apidocs/v1/` (the trailing slash is important).
79+
- If you have followed the [install guide](../orc8r/deploy_install.md), it'll be at `https://api.youdomain.com/apidocs/v1/` (the trailing slash is important).
8080
- You will need to load the `admin_operator.pfx` certificate into your keychain/browser, otherwise, API access will be blocked.
8181

8282
### How can I use Swagger UI to trigger API request?

docusaurus/versioned_docs/version-1.1.X/lte/config_agw.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ original_id: config_agw
1111
Before beginning to configure your Magma Access Gateway, you will need to make
1212
sure that it is running all services without crashing. You will also need a
1313
working Orchestrator setup. Please follow the instructions in
14-
"[Deploying Orchestrator](../orc8r/deploy_intro)" for a
14+
"[Deploying Orchestrator](../orc8r/deploy_intro.md)" for a
1515
successful Orchestrator installation.
1616

17-
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb)".
17+
You also should have completed all the steps in "[Access Gateway Setup (On Bare Metal)](setup_deb.md)".
1818
For this part, we strongly recommend that you SSH into the AGW box from a host
1919
machine instead of using the AGW directly.
2020

docusaurus/versioned_docs/version-1.1.X/lte/dev_notes.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ continues to grow.
1414
## Configuration/system settings
1515

1616
If you have a gateway running in a VM (as described in the [Quick Start
17-
Guide](../basics/quick_start_guide)), the `magma` directory is shared between
17+
Guide](../basics/quick_start_guide.md)), the `magma` directory is shared between
1818
the guest and host machine, so changes made on either system reflect on the
1919
other. Exceptions to this rule are the systemd unit files and python scripts.
2020
Changes to these files on the guest or host need to be manually synced.
@@ -73,7 +73,7 @@ To connect a physical eNodeB to the gateway VM:
7373
3. In gateway VM, modify the `nat_iface` in `/etc/magma/pipelined.yml` from
7474
`eth2` to `eth0`. Restart all services.
7575
4. In the gateway VM, follow the steps in [EnodeB
76-
Configuration](enodebd#basic-troubleshooting). Make sure the `earfcn` set in the
76+
Configuration](./enodebd.md#basic-troubleshooting). Make sure the `earfcn` set in the
7777
enodebd section of `gateway.mconfig` is the one that is supported by the eNodeB
7878
under consideration.
7979

@@ -113,7 +113,7 @@ created by the MME service. The Mme service creates a new log file with name
113113

114114
Many services have a command line interface (CLI) that can be used for
115115
debugging and configuration. Check the [AGW
116-
Readme](readme_agw.md#command-line-interfaces) for more details.
116+
Readme]((./readme_agw.md#command-line-interfaces) for more details.
117117

118118
### Analyzing raw network packets
119119

@@ -166,7 +166,7 @@ dependent on are already running. Follow the steps below:
166166
### Checking Redis entries for stateless services
167167

168168
When the services are running in stateless mode, as described in [Testing
169-
stateless Access Gateway](s1ap_tests#testing-stateless-access-gateway), you can
169+
stateless Access Gateway](./s1ap_tests.md#testing-stateless-access-gateway), you can
170170
connect to the redis service with `redis-cli -p 6380`. Then on the shell, you
171171
can list all the keys with `KEYS *`. The keys for state follow the pattern
172172
`<IMSI>:<Service/MME task>`. For example:

0 commit comments

Comments
 (0)