mirror of
https://github.com/apricote/hcloud-upload-image.git
synced 2026-01-13 13:21:01 +00:00
feat: docs website (#80)
Deploy the documentation to GitHub Pages using `mdbook` and a little more content for it. Can be visited at https://apricote.github.io/hcloud-upload-image.
This commit is contained in:
parent
c175ca0352
commit
d144b85e3d
15 changed files with 118 additions and 3 deletions
2
docs/.gitignore
vendored
Normal file
2
docs/.gitignore
vendored
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
book
|
||||
https:
|
||||
22
docs/SUMMARY.md
Normal file
22
docs/SUMMARY.md
Normal file
|
|
@ -0,0 +1,22 @@
|
|||
# Summary
|
||||
|
||||
[Introduction](introduction.md)
|
||||
|
||||
# Guides
|
||||
|
||||
- [Uploading Images](guides/README.md)
|
||||
- [Fedora CoreOS ↗](https://docs.fedoraproject.org/en-US/fedora-coreos/provisioning-hetzner/#_creating_a_snapshot)
|
||||
- [Flatcar Container Linux ↗](https://www.flatcar.org/docs/latest/installing/cloud/hetzner/#building-the-snapshots-1)
|
||||
- [Talos Linux ↗](https://www.talos.dev/v1.10/talos-guides/install/cloud-platforms/hetzner/#hcloud-upload-image)
|
||||
|
||||
# Reference
|
||||
|
||||
- [CLI](reference/cli/hcloud-upload-image.md)
|
||||
- [`upload`](reference/cli/hcloud-upload-image_upload.md)
|
||||
- [`cleanup`](reference/cli/hcloud-upload-image_cleanup.md)
|
||||
- [Go Library](reference/go-library.md)
|
||||
|
||||
---
|
||||
|
||||
[Changelog CLI](changelog.md)
|
||||
[Changelog Go Library](changelog-hcloudimages.md)
|
||||
8
docs/book.toml
Normal file
8
docs/book.toml
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
[book]
|
||||
language = "en"
|
||||
multilingual = false
|
||||
src = "."
|
||||
title = "hcloud-upload-image"
|
||||
|
||||
[output.html]
|
||||
git-repository-url = "https://github.com/apricote/hcloud-upload-image"
|
||||
3
docs/changelog-hcloudimages.md
Normal file
3
docs/changelog-hcloudimages.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Changelog Library
|
||||
|
||||
{{#include ../hcloudimages/CHANGELOG.md:2: }}
|
||||
3
docs/changelog.md
Normal file
3
docs/changelog.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Changelog CLI
|
||||
|
||||
{{#include ../CHANGELOG.md:2: }}
|
||||
7
docs/guides/README.md
Normal file
7
docs/guides/README.md
Normal file
|
|
@ -0,0 +1,7 @@
|
|||
# Uploading Images
|
||||
|
||||
Check out these docs from other projects to learn how to use `hcloud-upload-image`:
|
||||
|
||||
- [Fedora CoreOS ↗](https://docs.fedoraproject.org/en-US/fedora-coreos/provisioning-hetzner/#_creating_a_snapshot)
|
||||
- [Flatcar Container Linux ↗](https://www.flatcar.org/docs/latest/installing/cloud/hetzner/#building-the-snapshots-1)
|
||||
- [Talos Linux ↗](https://www.talos.dev/v1.10/talos-guides/install/cloud-platforms/hetzner/#hcloud-upload-image)
|
||||
3
docs/introduction.md
Normal file
3
docs/introduction.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Introduction
|
||||
|
||||
{{#include ../README.md:2:}}
|
||||
3
docs/reference/go-library.md
Normal file
3
docs/reference/go-library.md
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
# Go Library
|
||||
|
||||
You can find the documentation at [pkg.go.dev/github.com/apricote/hcloud-upload-image/hcloudimages ↗](https://pkg.go.dev/github.com/apricote/hcloud-upload-image/hcloudimages).
|
||||
Loading…
Add table
Add a link
Reference in a new issue