Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation #3693

Merged
merged 23 commits into from
Oct 2, 2024
Merged

Add documentation #3693

merged 23 commits into from
Oct 2, 2024

Conversation

thallgren
Copy link
Member

This PR essentially copies the latest documentation from telepresence.io into the docs directory and adjusts it for deployment on telepresence.io.

See #3678 for more info.

Signed-off-by: Thomas Hallgren <[email protected]>
Helm Chart will show the telepresence-edgy icon instead of the
old Ambassador Labs logo.

Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
Might restore this sample later on using minikube or kind.

Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
Adds a new `relnotesgen` tool that generates a reasonable markdown
formatted file from the yaml described in our CHANGELOG.yml. This tool
is then used in the `make generate` target to generated the
`docs/releaseNotes.md`.

The generation means that the release notes are readable already in this
repository. It also means that a lot of logic can be removed from the
telepresence.io website.

Signed-off-by: Thomas Hallgren <[email protected]>
Uses syntax like:
```
> [!NOTE]
> This is a note
```
instead of:
```
<Alert>
This is a note
</Alert>
```

Signed-off-by: Thomas Hallgren <[email protected]>
The MDX version, suitable for telepresence.io.

Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
Signed-off-by: Thomas Hallgren <[email protected]>
@thallgren thallgren added the ok to test Applied by maintainers when a PR is ready to have tests run on it label Oct 2, 2024
@github-actions github-actions bot removed the ok to test Applied by maintainers when a PR is ready to have tests run on it label Oct 2, 2024
@thallgren thallgren merged commit 8b98987 into release/v2 Oct 2, 2024
11 checks passed
@thallgren thallgren deleted the thallgren/add-documentation branch October 2, 2024 15:41
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.

1 participant