Skip to content

Commit 4ea14e0

Browse files
gm2552gm2552
committed
Add the five remaining components to the unified docs site
Wires up gateway, direct-msg-monitor, direct-policy, dns, and direct-project-stock alongside agent: components.json entries, a hand-maintained sidebar section per component mirroring each one's own internal nav (Development/Deployment Guide structure), and flips their Overview page links from external to internal now that all six render as one site.
1 parent 20ac2ea commit 4ea14e0

4 files changed

Lines changed: 174 additions & 10 deletions

File tree

‎.gitignore‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,8 +7,14 @@ docs/.vitepress/dist/
77
docs/.vitepress/cache/
88

99
# Component docs fetched at build/dev time (scripts/fetch-docs.mjs) — the
10-
# source of truth lives in each component repo's own docs/ folder, not here
10+
# source of truth lives in each component repo's own docs/ folder, not here.
11+
# Keep this list in sync with the slugs in scripts/components.json.
1112
docs/agent/
13+
docs/gateway/
14+
docs/direct-msg-monitor/
15+
docs/direct-policy/
16+
docs/dns/
17+
docs/direct-project-stock/
1218

1319
# Local override for scripts/fetch-docs.mjs during development, so a
1420
# not-yet-pushed component repo can be pointed at a local filesystem path

‎docs/.vitepress/config.mts‎

Lines changed: 137 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,7 @@ export default defineConfig({
1010
logo: '/logo.png',
1111
siteTitle: false,
1212

13-
nav: [
14-
{ text: 'Overview', link: '/overview' },
15-
{ text: 'Security And Trust Agent', link: '/agent/' }
16-
],
13+
nav: [{ text: 'Overview', link: '/overview' }],
1714

1815
// Hand-maintained: adding a page in a component repo's docs/ folder also
1916
// requires a sidebar entry here in the hub repo — the two live in
@@ -49,6 +46,142 @@ export default defineConfig({
4946
]
5047
}
5148
]
49+
},
50+
{
51+
text: 'Gateway',
52+
link: '/gateway/',
53+
collapsed: true,
54+
items: [
55+
{
56+
text: 'Development Guide',
57+
link: '/gateway/dev-guide',
58+
collapsed: true,
59+
items: [
60+
{ text: 'Protocol Bridge Architecture', link: '/gateway/bridge-arch' },
61+
{ text: 'Writing A Protocol Bridge', link: '/gateway/write-a-bridge' }
62+
]
63+
},
64+
{
65+
text: 'Deployment Guide',
66+
link: '/gateway/dep-guide',
67+
collapsed: true,
68+
items: [
69+
{ text: 'SMTP Agent WebService Configuration', link: '/gateway/smtp-web-configuration' },
70+
{ text: 'Fined Grained Tuning', link: '/gateway/tuning' },
71+
{
72+
text: 'SMTP Protocol Implementation Deployment',
73+
link: '/gateway/smtp-deployments',
74+
collapsed: true,
75+
items: [
76+
{ text: 'Apache James Deployment', link: '/gateway/apache-james' },
77+
{ text: 'SpringBoot Deployement', link: '/gateway/spring-boot' },
78+
{ text: 'DNS Failure Generation Config', link: '/gateway/dsn-config' }
79+
]
80+
},
81+
{ text: 'PKCS11 Configuration', link: '/gateway/pkcs11-configuration' }
82+
]
83+
}
84+
]
85+
},
86+
{
87+
text: 'Message Monitoring',
88+
link: '/direct-msg-monitor/',
89+
collapsed: true,
90+
items: [
91+
{ text: 'Monitoring Overview', link: '/direct-msg-monitor/overview' },
92+
{
93+
text: 'Developers Guide',
94+
link: '/direct-msg-monitor/dev-guide',
95+
collapsed: true,
96+
items: [
97+
{ text: 'Message Monitor Architecture', link: '/direct-msg-monitor/mon-arch' },
98+
{ text: 'Correlation Component', link: '/direct-msg-monitor/mon-correlator' },
99+
{ text: 'Aggregator Component', link: '/direct-msg-monitor/aggregator' },
100+
{ text: 'Completion and Timeout Condition Components', link: '/direct-msg-monitor/comp-and-timeout' },
101+
{ text: 'Message Failure Generation', link: '/direct-msg-monitor/failure-gen' },
102+
{ text: 'Notification Duplication Checking', link: '/direct-msg-monitor/dup-checking' },
103+
{ text: 'Extending and Writing Custom Components', link: '/direct-msg-monitor/custom-components' }
104+
]
105+
},
106+
{
107+
text: 'Deployment Guide',
108+
link: '/direct-msg-monitor/dep-guide',
109+
collapsed: true,
110+
items: [
111+
{ text: 'Deployment and Configuration', link: '/direct-msg-monitor/dep-and-config' },
112+
{ text: 'Deployment Considerations', link: '/direct-msg-monitor/dep-considerations' }
113+
]
114+
}
115+
]
116+
},
117+
{
118+
text: 'Policy Enablement',
119+
link: '/direct-policy/',
120+
collapsed: true,
121+
items: [
122+
{
123+
text: 'Architecture Guide',
124+
link: '/direct-policy/arch-guide',
125+
collapsed: true,
126+
items: [
127+
{ text: 'Policy Engine Architecture', link: '/direct-policy/eng-arch' },
128+
{ text: 'Security and Trust (STA) Integration and Configuration', link: '/direct-policy/sta-int' }
129+
]
130+
},
131+
{
132+
text: 'Tools',
133+
link: '/direct-policy/tools',
134+
collapsed: true,
135+
items: [
136+
{ text: 'Simple Text Lexicon Version I', link: '/direct-policy/stext-lexicon' },
137+
{ text: 'Policy Builder', link: '/direct-policy/pol-builder' },
138+
{ text: 'Example Policies', link: '/direct-policy/examples' }
139+
]
140+
}
141+
]
142+
},
143+
{
144+
text: 'DNS Services',
145+
link: '/dns/',
146+
collapsed: true,
147+
items: [
148+
{ text: 'DNS Service Deployment', link: '/dns/dep-guide' },
149+
{ text: 'DNS Record Configuration', link: '/dns/dns-rec-config' },
150+
{ text: 'Integration With GoDaddy', link: '/dns/godaddy' }
151+
]
152+
},
153+
{
154+
text: 'BareMetal Assembly Project',
155+
link: '/direct-project-stock/',
156+
collapsed: true,
157+
items: [
158+
{
159+
text: 'Deployment Guide',
160+
link: '/direct-project-stock/dep-guide',
161+
collapsed: true,
162+
items: [
163+
{
164+
text: 'HISP Only Deployment (no source)',
165+
link: '/direct-project-stock/dep-hisp-only',
166+
collapsed: true,
167+
items: [
168+
{ text: 'Legacy HISP Deployment Model', link: '/direct-project-stock/legacy-deployment' },
169+
{ text: 'Cloud Native HISP Deployment Model', link: '/direct-project-stock/cloud-native-deployment' }
170+
]
171+
}
172+
]
173+
},
174+
{
175+
text: 'Deployment Options',
176+
link: '/direct-project-stock/imp-options',
177+
collapsed: true,
178+
items: [
179+
{ text: 'Configuration and Message Monitor Storage', link: '/direct-project-stock/config-store' },
180+
{ text: 'Single Use Certificates', link: '/direct-project-stock/single-use-certs' },
181+
{ text: 'Enhanced Private Key Security', link: '/direct-project-stock/enhanced-key-security' }
182+
]
183+
}
184+
]
52185
}
53186
],
54187

‎docs/overview.md‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ The reference implementation adopts a modular design for easy asset reuse and ex
2828

2929
* [Commons Library](http://api.directproject.info/direct-common/6.0/)
3030
* [Security And Trust Agent](/agent/)
31-
* [Gateway](https://directprojectjavari.github.io/gateway/)
32-
* [Message Monitoring](https://directprojectjavari.github.io/direct-msg-monitor/)
33-
* [Policy Enablement](https://directprojectjavari.github.io/direct-policy/)
34-
* [DNS Services](https://directprojectjavari.github.io/dns/)
35-
* [BareMetal Assembly Project](https://directprojectjavari.github.io/direct-project-stock/)
31+
* [Gateway](/gateway/)
32+
* [Message Monitoring](/direct-msg-monitor/)
33+
* [Policy Enablement](/direct-policy/)
34+
* [DNS Services](/dns/)
35+
* [BareMetal Assembly Project](/direct-project-stock/)

‎scripts/components.json‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,30 @@
33
"slug": "agent",
44
"repo": "https://github.com/DirectProjectJavaRI/agent.git",
55
"branch": "gh-pages"
6+
},
7+
{
8+
"slug": "gateway",
9+
"repo": "https://github.com/DirectProjectJavaRI/gateway.git",
10+
"branch": "gh-pages"
11+
},
12+
{
13+
"slug": "direct-msg-monitor",
14+
"repo": "https://github.com/DirectProjectJavaRI/direct-msg-monitor.git",
15+
"branch": "gh-pages"
16+
},
17+
{
18+
"slug": "direct-policy",
19+
"repo": "https://github.com/DirectProjectJavaRI/direct-policy.git",
20+
"branch": "gh-pages"
21+
},
22+
{
23+
"slug": "dns",
24+
"repo": "https://github.com/DirectProjectJavaRI/dns.git",
25+
"branch": "gh-pages"
26+
},
27+
{
28+
"slug": "direct-project-stock",
29+
"repo": "https://github.com/DirectProjectJavaRI/direct-project-stock.git",
30+
"branch": "gh-pages"
631
}
732
]

0 commit comments

Comments
 (0)