Skip to content

Commit 681dfc3

Browse files
gm2552claude
andcommitted
Split Getting Started out of Overview and promote it on the landing page
Move the "Where To Start" and "Modular Components" sections from overview.md into a new getting-started.md, linked from the hero and nav/sidebar (matching the directtrust-tools.github.io pattern). Also move the BareMetal Assembly Project sidebar entry to the top, and clean up copy (typos, grammar, wording) in Overview and Getting Started. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01TJcNswabKU3zekw6g5ccjF
1 parent de9f254 commit 681dfc3

4 files changed

Lines changed: 67 additions & 60 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,50 @@ export default defineConfig({
2424
logo: '/logo.png',
2525
siteTitle: false,
2626

27-
nav: [{ text: 'Overview', link: '/overview' }],
27+
nav: [
28+
{ text: 'Overview', link: '/overview' },
29+
{ text: 'Getting Started', link: '/getting-started' }
30+
],
2831

2932
// Hand-maintained: adding a page in a component repo's docs/ folder also
3033
// requires a sidebar entry here in the hub repo — the two live in
3134
// different repos, so this coupling can't be enforced automatically.
3235
sidebar: [
3336
{ text: 'Overview', link: '/overview' },
37+
{ text: 'Getting Started', link: '/getting-started' },
38+
{
39+
text: 'BareMetal Assembly Project',
40+
link: '/docs/direct-project-stock/',
41+
collapsed: true,
42+
items: [
43+
{
44+
text: 'Deployment Guide',
45+
link: '/docs/direct-project-stock/dep-guide',
46+
collapsed: true,
47+
items: [
48+
{
49+
text: 'HISP Only Deployment (no source)',
50+
link: '/docs/direct-project-stock/dep-hisp-only',
51+
collapsed: true,
52+
items: [
53+
{ text: 'Legacy HISP Deployment Model', link: '/docs/direct-project-stock/legacy-deployment' },
54+
{ text: 'Cloud Native HISP Deployment Model', link: '/docs/direct-project-stock/cloud-native-deployment' }
55+
]
56+
}
57+
]
58+
},
59+
{
60+
text: 'Deployment Options',
61+
link: '/docs/direct-project-stock/imp-options',
62+
collapsed: true,
63+
items: [
64+
{ text: 'Configuration and Message Monitor Storage', link: '/docs/direct-project-stock/config-store' },
65+
{ text: 'Single Use Certificates', link: '/docs/direct-project-stock/single-use-certs' },
66+
{ text: 'Enhanced Private Key Security', link: '/docs/direct-project-stock/enhanced-key-security' }
67+
]
68+
}
69+
]
70+
},
3471
{
3572
text: 'Security And Trust Agent',
3673
link: '/docs/agent/',
@@ -163,39 +200,6 @@ export default defineConfig({
163200
{ text: 'DNS Record Configuration', link: '/docs/dns/dns-rec-config' },
164201
{ text: 'Integration With GoDaddy', link: '/docs/dns/godaddy' }
165202
]
166-
},
167-
{
168-
text: 'BareMetal Assembly Project',
169-
link: '/docs/direct-project-stock/',
170-
collapsed: true,
171-
items: [
172-
{
173-
text: 'Deployment Guide',
174-
link: '/docs/direct-project-stock/dep-guide',
175-
collapsed: true,
176-
items: [
177-
{
178-
text: 'HISP Only Deployment (no source)',
179-
link: '/docs/direct-project-stock/dep-hisp-only',
180-
collapsed: true,
181-
items: [
182-
{ text: 'Legacy HISP Deployment Model', link: '/docs/direct-project-stock/legacy-deployment' },
183-
{ text: 'Cloud Native HISP Deployment Model', link: '/docs/direct-project-stock/cloud-native-deployment' }
184-
]
185-
}
186-
]
187-
},
188-
{
189-
text: 'Deployment Options',
190-
link: '/docs/direct-project-stock/imp-options',
191-
collapsed: true,
192-
items: [
193-
{ text: 'Configuration and Message Monitor Storage', link: '/docs/direct-project-stock/config-store' },
194-
{ text: 'Single Use Certificates', link: '/docs/direct-project-stock/single-use-certs' },
195-
{ text: 'Enhanced Private Key Security', link: '/docs/direct-project-stock/enhanced-key-security' }
196-
]
197-
}
198-
]
199203
}
200204
],
201205

docs/getting-started.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
---
2+
title: Getting Started
3+
---
4+
5+
# Getting Started
6+
7+
If you want to stand up an instance of the reference implementation right away, the fastest path is the [BareMetal Assembly Project](/docs/direct-project-stock/) for the Java platform. It bundles the reference implementation's components into a ready-to-deploy stack, so you don't need to build or wire the pieces together yourself.
8+
9+
To build all components, including the BareMetal assembly, from source instead of using a prebuilt package, follow the instructions [here](https://github.com/DirectProjectJavaRI/direct-ri-build).
10+
11+
## Understanding the Modular Components
12+
13+
If you'd rather understand how the reference implementation's components fit together before diving in, start with the module list below. The reference implementation follows a modular design for easy reuse and extensibility, with components available in both .Net and Java.
14+
15+
### Java Components
16+
17+
* [Commons Library](http://api.directproject.info/direct-common/6.0/)
18+
* [Security And Trust Agent](/docs/agent/)
19+
* [Gateway](/docs/gateway/)
20+
* [Message Monitoring](/docs/direct-msg-monitor/)
21+
* [Policy Enablement](/docs/direct-policy/)
22+
* [DNS Services](/docs/dns/)
23+
* [BareMetal Assembly Project](/docs/direct-project-stock/)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,6 @@ title: The DirectProject
1111
<p class="home-hero-tagline">Open source reference implementation of the Direct specifications</p>
1212
<div class="home-hero-actions">
1313
<a class="home-hero-btn brand" href="/overview">Overview</a>
14-
<a class="home-hero-btn alt" href="/docs/agent/">Security And Trust Agent</a>
14+
<a class="home-hero-btn alt" href="/getting-started">Getting Started</a>
1515
</div>
1616
</div>

docs/overview.md

Lines changed: 5 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,12 @@ title: Overview
44

55
# Overview
66

7-
The reference implementation is an open source and pre-assembled implementation of the Direct specifications. An implementation exists in both the .Net and Java languages and can be downloaded freely from a handful of websites. A subproject of Direct, called Bare Metal, contains a set of instructions on procuring the reference implementation and standing up a reference HISP from scratch using only the reference implementation assemblies.
7+
The reference implementation is an open source, pre-assembled implementation of the Direct specifications, available in both .Net and Java. A subproject called BareMetal provides everything needed to procure the reference implementation and stand up a HISP from scratch using only the reference implementation's assemblies.
88

9-
The reference implementation is a fully working model with all sorts of bells and whistles, but it's just a model. If you've ever delved into the world of embedded hardware or robotics, the starting point is usually a reference board. The board is a cookie cutter model with several modules, inputs, outputs, and maybe an operating system or programmable circuits. However, the reference board is not intended to be the final design that ultimately goes into your finished solution. It is tweaked and extended with custom modules, or some modules may be removed. The end product is a customized board that meets the specific needs of your solution.
9+
The reference implementation is a fully working model, but it's still just a model. Think of it like a reference board in embedded hardware or robotics: a cookie-cutter design with a standard set of modules, inputs, and outputs. It isn't meant to be the final product — it's tweaked, extended with custom modules, or trimmed down until it becomes a customized board that fits your solution.
1010

11-
The same is true for Direct. The reference implementation comes with a standard deployment model and software components such as the security and trust agent, the messaging gateway, a certificate store and a simple web or command line tool for configuration. However, the model does not meet the requirements of an industry-class production system, such as high availability, failover, scalability and disaster recovery. The only edge protocol supported is XD and POP/SMTP, and although this may work well for email clients, innovative edge clients and workflows may need other protocols such as REST, SOAP, and custom authentication and authorization modules.
11+
The same is true for Direct. The reference implementation ships with a standard deployment model and a set of software components the security and trust agent, the messaging gateway, a certificate store, and a simple web or command-line configuration tool. It does not, however, meet the requirements of an industry-class production system: high availability, failover, scalability, and disaster recovery. It also supports only the XDR and POP/SMTP edge protocols; other edge clients and workflows may need additional protocols such as REST or SOAP, along with custom authentication and authorization modules.
1212

13-
Finally, the reference implementation does not meet the policy requirements emerging from the various governance agencies. For example, the private certificate store in the reference implementation does not meet auditing requirements for access to private keys. Another example, the auditing subsystem does not write audit events to a storage mechanism with proper access controls. The reference implementation is stubbed to meet these requirements and supports plugging in custom instances of reference implementation interfaces and/or modules. For a HISP to become fully compliant with industry best practices, certificate policies and required operational procedures, investment in infrastructure and some software development is necessary.
13+
Nor does the reference implementation meet the policy requirements set by various governance agencies. For example, its private certificate store doesn't meet auditing requirements for access to private keys, and its audit subsystem doesn't write events to a storage mechanism with proper access controls. These areas are intentionally stubbed out so you can plug in custom implementations of the reference interfaces and modules to meet them. Becoming a fully compliant HISP — meeting industry best practices, certificate policies, and required operational procedures — takes additional investment in infrastructure and software development.
1414

15-
## Where To Start
16-
17-
If you want to jump right in with both feet and stand up an instance of the reference implementation, the obvious choice is to go to the BareMetal installation page for the Java platform.
18-
19-
If you want to understand the details of the reference implementation componenst and they how fit together, refer to the list of modules in the section below.
20-
21-
If you would like build all components including the BareMetal assembly from source code vs using a prebuilt BareMetal assembly, use the instuctions [here](https://github.com/DirectProjectJavaRI/direct-ri-build)
22-
23-
## Modular Components
24-
25-
The reference implementation adopts a modular design for easy asset reuse and extensibility. Components are available in both .Net and Java.
26-
27-
### Java Components
28-
29-
* [Commons Library](http://api.directproject.info/direct-common/6.0/)
30-
* [Security And Trust Agent](/docs/agent/)
31-
* [Gateway](/docs/gateway/)
32-
* [Message Monitoring](/docs/direct-msg-monitor/)
33-
* [Policy Enablement](/docs/direct-policy/)
34-
* [DNS Services](/docs/dns/)
35-
* [BareMetal Assembly Project](/docs/direct-project-stock/)
15+
Ready to stand up an instance or explore the individual components? Head over to [Getting Started](/getting-started).

0 commit comments

Comments
 (0)