Skip to content

Commit 445cadb

Browse files
authored
docs: Improve setec documentation UX (#130)
Updates tailscale/tailscale#15207
1 parent 472f7ca commit 445cadb

File tree

1 file changed

+15
-1
lines changed

1 file changed

+15
-1
lines changed

docs/README.md

+15-1
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,14 @@
1-
# Documentation for Setec
1+
# setec
2+
3+
Setec is a lightweight secrets management service that uses Tailscale for access control.
4+
5+
> [!IMPORTANT]
6+
> File issues in our [primary open source repository](https://github.com/tailscale/tailscale/issues).
27
38
## Table of Contents
49

510
- [Background](#background)
11+
- [Get started](#get-started)
612
- [API Overview](#api-overview)
713
- [Basic Operations](#basic-operations)
814
- [Current Active Versions](#current-active-versions)
@@ -14,6 +20,9 @@
1420
- [Automatic Updates](#automatic-updates)
1521
- [Bootstrapping and Availability](#bootstrapping-and-availability)
1622
- [Testing](#testing)
23+
24+
### Additional documentation
25+
1726
- [API documentation](api.md)
1827
- [Running a setec server](server.md)
1928

@@ -44,9 +53,14 @@ surface for managing secrets in third-party deployment environments: All the
4453
secrets are stored in one place, with access controls and audit logs to allow
4554
forensics in the event of a compromise.
4655

56+
## Get started
57+
58+
To set up a setec server, follow the instructions in [Running a setec server](server.md).
4759

4860
## API Overview
4961

62+
See also the [full API documentation](api.md).
63+
5064
A **secret** in `setec` is a named collection of values. Each value is an
5165
arbitrary byte string identified by an integer **version number**.
5266

0 commit comments

Comments
 (0)