Skip to content

[MTC] Improve MTC Log docs - #1143

Merged
phbnf merged 2 commits into
transparency-dev:mainfrom
phbnf:docslog
Aug 26, 2026
Merged

[MTC] Improve MTC Log docs#1143
phbnf merged 2 commits into
transparency-dev:mainfrom
phbnf:docslog

Conversation

@phbnf

@phbnf phbnf commented Aug 26, 2026

Copy link
Copy Markdown
Contributor

Towards #945.

@phbnf
phbnf requested a review from roger2hk August 26, 2026 16:52
@phbnf
phbnf marked this pull request as ready for review August 26, 2026 16:54
@phbnf
phbnf requested a review from a team as a code owner August 26, 2026 16:54
Comment thread cmd/mtc/log/README.md Outdated
Comment on lines +30 to +31
- **`NewOptions()`**: Creates an `Options` builder to configure storage
backends, landmark intervals, maximum certificate lifetime, signers, and

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Update the text to indicate it is a landmarks storage backend. It's easy to get confused with Tessera storage backend.

Suggested change
- **`NewOptions()`**: Creates an `Options` builder to configure storage
backends, landmark intervals, maximum certificate lifetime, signers, and
- **`NewOptions()`**: Creates an `Options` builder to configure landmarks storage
backends, landmark intervals, maximum certificate lifetime, signers, and

Comment thread cmd/mtc/log/posix/README.md Outdated

### Main functionalities

See [mtc/log/README.md](../).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
See [mtc/log/README.md](../).
See [mtc/log/README.md](../README.md).

Comment thread cmd/mtc/log/posix/README.md Outdated
This directory contains an MTC ([`draft-ietf-plants-merkle-tree-certs`](https://ietf-plants-wg.github.io/merkle-tree-certs/draft-ietf-plants-merkle-tree-certs.html))
issuance log server backed by [Tessera's POSIX storage implementation](/storage/posix/).

This document contains [Documentation](#documentation), and a [Codelab](#codelab).

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This document contains [Documentation](#documentation), and a [Codelab](#codelab).
This document contains [Documentation](#documentation) and a [Codelab](#codelab).

Comment thread cmd/mtc/log/posix/README.md Outdated
(e.g. 32473.106)
- `log_number`: The issuance log number (strictly positive).
- `private_key`: Location of private key file. If unset, uses the contents of
the LOG_PRIVATE_KEY environment variable.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
the LOG_PRIVATE_KEY environment variable.
the `LOG_PRIVATE_KEY` environment variable.

@phbnf
phbnf merged commit a8f33c5 into transparency-dev:main Aug 26, 2026
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants