Skip to content

Commit 2246b79

Browse files
authored
Merge pull request #70 from cisco-open/fix/naming-documentation
Point to right .md names for documentation purposes
2 parents bd0e288 + 83aa61d commit 2246b79

File tree

5 files changed

+10
-9
lines changed

5 files changed

+10
-9
lines changed

README.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -155,10 +155,9 @@ kubectl apply -f ./dev/test-pod-dhcp.yaml
155155

156156
## Documentation
157157

158-
- [Configuration Reference](docs/configuration.md) - Configuration options and device setup
159-
- [Architecture](docs/architecture.md) - Technical architecture details
160-
- [API Reference](docs/api.md) - RESTCONF API details
161-
- [API Reference](docs/api.md) - RESTCONF API details
158+
- [Configuration Reference](docs/CONFIGURATION.md) - Configuration options and device setup
159+
- [Architecture](docs/ARCHITECTURE.md) - Technical architecture details
160+
- [API Reference](docs/API.md) - RESTCONF API details
162161

163162
## Project Structure
164163

docs/API.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@ This document details the RESTCONF APIs used by the Cisco Virtual Kubelet Provid
55
## RESTCONF Endpoints
66

77
### Base URL
8-
```
8+
9+
```bash
910
https://<device-ip>/restconf
1011
```
1112

docs/ARCHITECTURE.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ type AppHostingProvider struct {
7373
```
7474

7575
**Implemented Interface Methods**:
76+
7677
- `CreatePod(ctx, pod)` - Deploy container to device
7778
- `UpdatePod(ctx, pod)` - Update container configuration
7879
- `DeletePod(ctx, pod)` - Remove container from device

docs/CONFIGURATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Currently supported:
88
- **Cisco Catalyst 8000V** (cat8kv) virtual routers running IOS-XE 17.15.4c
99
- **Cisco Catalyst 9000** (cat9k) virtual routers running IOS-XE 17.18.2
1010

11-
NOTE: Other versions that support Cisco App Hosting may work but have not been validated
11+
**NOTE:** Other versions that support Cisco App Hosting may work but have not been validated
1212

1313
## Device Prerequisites
1414

mkdocs.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ markdown_extensions:
3333
emoji_generator: !!python/name:material.extensions.emoji.to_svg ""
3434
nav:
3535
- Welcome: 'index.md'
36-
- Architecture: 'architecture.md'
37-
- Configuration: 'configuration.md'
38-
- API Reference: 'api.md'
36+
- Architecture: 'ARCHITECTURE.md'
37+
- Configuration: 'CONFIGURATION.md'
38+
- API Reference: 'API.md'
3939
theme:
4040
name: material
4141
features:

0 commit comments

Comments
 (0)