Skip to content

Commit

Permalink
chore(docs): Migrating to vercel (#3583)
Browse files Browse the repository at this point in the history
updating docgen
  • Loading branch information
xoscar authored Jan 30, 2024
1 parent e72a7e8 commit 0e123e0
Show file tree
Hide file tree
Showing 21 changed files with 794 additions and 5 deletions.
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,5 @@ config.yml
server/tracetest.yaml
server/html

# autogenerated with `cd cli; make docgen`
docs/docs/cli/reference/

__debug*
web/cypress/downloads
97 changes: 97 additions & 0 deletions docs/docs/cli/reference/cli-sidebar.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@

/** @type {import('@docusaurus/plugin-content-docs/lib/sidebars/types').SidebarItem[]} */
const pages = [

{
type: "doc",
label: "tracetest",
id: "cli/reference/tracetest"
},
{
type: "doc",
label: "tracetest apply",
id: "cli/reference/tracetest_apply"
},
{
type: "doc",
label: "tracetest completion",
id: "cli/reference/tracetest_completion"
},
{
type: "doc",
label: "tracetest completion bash",
id: "cli/reference/tracetest_completion_bash"
},
{
type: "doc",
label: "tracetest completion fish",
id: "cli/reference/tracetest_completion_fish"
},
{
type: "doc",
label: "tracetest completion powershell",
id: "cli/reference/tracetest_completion_powershell"
},
{
type: "doc",
label: "tracetest completion zsh",
id: "cli/reference/tracetest_completion_zsh"
},
{
type: "doc",
label: "tracetest configure",
id: "cli/reference/tracetest_configure"
},
{
type: "doc",
label: "tracetest dashboard",
id: "cli/reference/tracetest_dashboard"
},
{
type: "doc",
label: "tracetest delete",
id: "cli/reference/tracetest_delete"
},
{
type: "doc",
label: "tracetest export",
id: "cli/reference/tracetest_export"
},
{
type: "doc",
label: "tracetest get",
id: "cli/reference/tracetest_get"
},
{
type: "doc",
label: "tracetest list",
id: "cli/reference/tracetest_list"
},
{
type: "doc",
label: "tracetest run",
id: "cli/reference/tracetest_run"
},
{
type: "doc",
label: "tracetest server",
id: "cli/reference/tracetest_server"
},
{
type: "doc",
label: "tracetest server install",
id: "cli/reference/tracetest_server_install"
},
{
type: "doc",
label: "tracetest start",
id: "cli/reference/tracetest_start"
},
{
type: "doc",
label: "tracetest version",
id: "cli/reference/tracetest_version"
},
]

module.exports = pages;
35 changes: 35 additions & 0 deletions docs/docs/cli/reference/tracetest.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CLI Reference
## tracetest

CLI to configure, install and execute tests on a Tracetest server

### Synopsis

CLI to configure, install and execute tests on a Tracetest server

### Options

```
-c, --config string config file will be used by the CLI (default "config.yml")
-h, --help help for tracetest
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest apply](tracetest_apply.md) - Apply resources
* [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell
* [tracetest configure](tracetest_configure.md) - Configure your tracetest CLI
* [tracetest dashboard](tracetest_dashboard.md) - Opens the Tracetest Dashboard URL
* [tracetest delete](tracetest_delete.md) - Delete resources
* [tracetest export](tracetest_export.md) - Export resource
* [tracetest get](tracetest_get.md) - Get resource
* [tracetest list](tracetest_list.md) - List resources
* [tracetest run](tracetest_run.md) - run resources
* [tracetest server](tracetest_server.md) - Manage your tracetest server
* [tracetest start](tracetest_start.md) - Start Tracetest
* [tracetest version](tracetest_version.md) - Display this CLI tool version

###### Auto generated by spf13/cobra on 30-Jan-2024
34 changes: 34 additions & 0 deletions docs/docs/cli/reference/tracetest_apply.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# CLI Reference
## tracetest apply

Apply resources

### Synopsis

Apply (create/update) resources to your Tracetest server

```
tracetest apply analyzer|config|datastore|demo|env|organization|pollingprofile|test|testrunner|testsuite|variableset [flags]
```

### Options

```
-f, --file string path to the definition file
-h, --help help for apply
```

### Options inherited from parent commands

```
-c, --config string config file will be used by the CLI (default "config.yml")
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server

###### Auto generated by spf13/cobra on 30-Jan-2024
35 changes: 35 additions & 0 deletions docs/docs/cli/reference/tracetest_completion.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# CLI Reference
## tracetest completion

Generate the autocompletion script for the specified shell

### Synopsis

Generate the autocompletion script for tracetest for the specified shell.
See each sub-command's help for details on how to use the generated script.


### Options

```
-h, --help help for completion
```

### Options inherited from parent commands

```
-c, --config string config file will be used by the CLI (default "config.yml")
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest](tracetest.md) - CLI to configure, install and execute tests on a Tracetest server
* [tracetest completion bash](tracetest_completion_bash.md) - Generate the autocompletion script for bash
* [tracetest completion fish](tracetest_completion_fish.md) - Generate the autocompletion script for fish
* [tracetest completion powershell](tracetest_completion_powershell.md) - Generate the autocompletion script for powershell
* [tracetest completion zsh](tracetest_completion_zsh.md) - Generate the autocompletion script for zsh

###### Auto generated by spf13/cobra on 30-Jan-2024
54 changes: 54 additions & 0 deletions docs/docs/cli/reference/tracetest_completion_bash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,54 @@
# CLI Reference
## tracetest completion bash

Generate the autocompletion script for bash

### Synopsis

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package.
If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(tracetest completion bash)

To load completions for every new session, execute once:

#### Linux:

tracetest completion bash > /etc/bash_completion.d/tracetest

#### macOS:

tracetest completion bash > $(brew --prefix)/etc/bash_completion.d/tracetest

You will need to start a new shell for this setup to take effect.


```
tracetest completion bash
```

### Options

```
-h, --help help for bash
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
-c, --config string config file will be used by the CLI (default "config.yml")
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 30-Jan-2024
45 changes: 45 additions & 0 deletions docs/docs/cli/reference/tracetest_completion_fish.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,45 @@
# CLI Reference
## tracetest completion fish

Generate the autocompletion script for fish

### Synopsis

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

tracetest completion fish | source

To load completions for every new session, execute once:

tracetest completion fish > ~/.config/fish/completions/tracetest.fish

You will need to start a new shell for this setup to take effect.


```
tracetest completion fish [flags]
```

### Options

```
-h, --help help for fish
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
-c, --config string config file will be used by the CLI (default "config.yml")
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 30-Jan-2024
42 changes: 42 additions & 0 deletions docs/docs/cli/reference/tracetest_completion_powershell.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
# CLI Reference
## tracetest completion powershell

Generate the autocompletion script for powershell

### Synopsis

Generate the autocompletion script for powershell.

To load completions in your current shell session:

tracetest completion powershell | Out-String | Invoke-Expression

To load completions for every new session, add the output of the above command
to your powershell profile.


```
tracetest completion powershell [flags]
```

### Options

```
-h, --help help for powershell
--no-descriptions disable completion descriptions
```

### Options inherited from parent commands

```
-c, --config string config file will be used by the CLI (default "config.yml")
-o, --output string output format [pretty|json|yaml]
-s, --server-url string server url
-v, --verbose display debug information
```

### SEE ALSO

* [tracetest completion](tracetest_completion.md) - Generate the autocompletion script for the specified shell

###### Auto generated by spf13/cobra on 30-Jan-2024
Loading

0 comments on commit 0e123e0

Please sign in to comment.