Skip to content

Commit 32382c9

Browse files
committed
docs: port docs to https://docsify.js.org/#/
1 parent 7c79f00 commit 32382c9

26 files changed

+1022
-162
lines changed
Loading
Loading
Loading
Loading

.nojekyll

Whitespace-only changes.

NAV.md

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
* SDKs
2+
* [Go](https://github.com/testground/sdk-go)
3+
* [Rust](https://github.com/testground/sdk-rust)
4+
* [JS](https://github.com/testground/sdk-js)
5+
* [Nim](https://github.com/status-im/testground-nim-sdk)

README.md

+5-10
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,9 @@
22

33
![](.gitbook/assets/image%20%283%29%20%281%29.png)
44

5-
{% hint style="info" %}
6-
You are reading the Testground documentation for the [master](https://github.com/testground/testground) branch.
7-
8-
The Testground team maintains documentation for the `master` branch and for the latest stable release.
9-
{% endhint %}
5+
> You are reading the Testground documentation for the [master](https://github.com/testground/testground) branch.
6+
>
7+
> The Testground team maintains documentation for the `master` branch and for the latest stable release.
108
119
## Overview
1210

@@ -66,7 +64,7 @@ The Testground project was started at Protocol Labs because we couldn't find a p
6664
* Comparative testing 🌖
6765
* Backwards/forward-compatibility testing 🌖
6866
* Interoperability testing 🌑
69-
* Continuous integration 🌑
67+
* Continuous integration 🌑
7068
* Stakeholder/acceptance testing 🌑
7169

7270
### 📄 Simple, normalized, formal runtime environment for tests
@@ -121,7 +119,4 @@ Emit and collect/export/download test outputs \(logs, assets, event trails, run
121119

122120
## Documentation issues
123121

124-
{% hint style="warning" %}
125-
**This docs site is work-in-progress!** You're bound to find dragons 🐉 in some sections, so please bear with us! If something looks wrong, please [open a docs issue](https://github.com/testground/testground/issues/new?assignees=&labels=docs&template=DOCS.md&title=docs%20site:%20%3Cdescribe%20the%20problem%3E) on our main repo.
126-
{% endhint %}
127-
122+
!> **This docs site is work-in-progress!** You're bound to find dragons 🐉 in some sections, so please bear with us! If something looks wrong, please [open a docs issue](https://github.com/testground/testground/issues/new?assignees=&labels=docs&template=DOCS.md&title=docs%20site:%20%3Cdescribe%20the%20problem%3E) on our main repo.

SUMMARY.md

-1
Original file line numberDiff line numberDiff line change
@@ -47,4 +47,3 @@
4747
* [docker:go](builder-library/docker-go.md)
4848
* [exec:go](builder-library/exec-go.md)
4949
* [docker:generic](builder-library/docker-generic.md)
50-

builder-library/docker-go.md

+1-6
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,7 @@ Most build failures are caused by a problem with the plan code rather than the b
3030

3131
when using the `docker:go` builder, plans are build using a standard template. This template is typically all that is needed, but for some plans, the default docker build may be too inflexible. For cases such as this, the Dockerfile can be extended to include custom directives.
3232

33-
{% hint style="info" %}
34-
If you want to just provide your own Dockerfile, use the `docker:generic` builder instead.
35-
{% endhint %}
33+
?> If you want to just provide your own Dockerfile, use the `docker:generic` builder instead.
3634

3735
This feature is best explained by showing how it works. This is the default Dockerfile the `docker:go` builder will use to build plans. Notice that this is a go template. The template has a few points where customizations can be added.
3836

@@ -112,6 +110,3 @@ post_runtime_copy = "RUN echo 'at post_runtime_copy'"
112110
See an example plan which uses a customized Dockerfile, see [here](https://github.com/testground/testground/tree/master/plans/dockercustomize)
113111

114112
Interested in how this works? All the Testground builders can be seen [here](https://github.com/testground/testground/tree/master/pkg/build)
115-
116-
117-

concepts-and-architecture/daemon-and-client.md

+3-6
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,9 @@ The Testground runtime revolves around a traditional daemon/client architecture,
44

55
This architecture is flexible enough to run the daemon within a shared cluster, with many users, developers, and integrations \(e.g. GitHub Actions\) hitting the same daemon to schedule build and run jobs.
66

7-
{% hint style="info" %}
8-
At the moment, we do not run Testground in shared-cluster deployments; most developers spin up personal Kubernetes clusters, and run both the daemon and the client on their own development machines, pointing the local daemon to the remote k8s API.
9-
10-
However, as of Testground v0.5, **we do support running the daemon within a Kubernetes cluster as a pod.** This capability is vital to pave the way for shared-cluster deployments, which will enable much more efficient resource utilization and CI workflows.
11-
{% endhint %}
7+
> At the moment, we do not run Testground in shared-cluster deployments; most developers spin up personal Kubernetes clusters, and run both the daemon and the client on their own development machines, pointing the local daemon to the remote k8s API.
8+
>
9+
> However, as of Testground v0.5, **we do support running the daemon within a Kubernetes cluster as a pod.** This capability is vital to pave the way for shared-cluster deployments, which will enable much more efficient resource utilization and CI workflows.
1210
1311
## Testground Daemon
1412

@@ -63,4 +61,3 @@ You can also wait for the task completion when building or running by appending
6361
```text
6462
$ testground build single --plan=example --builder=exec:go --wait
6563
```
66-

0 commit comments

Comments
 (0)