Skip to content

Commit

Permalink
make docs
Browse files Browse the repository at this point in the history
Signed-off-by: Jason Hall <jason@chainguard.dev>
  • Loading branch information
imjasonh committed Jan 11, 2024
1 parent 1b19578 commit 7b3a4be
Show file tree
Hide file tree
Showing 18 changed files with 130 additions and 54 deletions.
33 changes: 17 additions & 16 deletions docs/md/melange.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange"
slug: melange
url: /docs/md/melange.md
url: /open-source/melange/reference/melange/
draft: false
images: []
type: "article"
Expand All @@ -14,23 +14,24 @@ toc: true
### Options

```
-h, --help help for melange
-h, --help help for melange
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange build](/docs/md/melange_build.md) - Build a package from a YAML configuration file
* [melange bump](/docs/md/melange_bump.md) - Update a Melange YAML file to reflect a new package version
* [melange completion](/docs/md/melange_completion.md) - Generate completion script
* [melange convert](/docs/md/melange_convert.md) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files
* [melange index](/docs/md/melange_index.md) - Creates a repository index from a list of package files
* [melange keygen](/docs/md/melange_keygen.md) - Generate a key for package signing
* [melange lint](/docs/md/melange_lint.md) - EXPERIMENTAL COMMAND - Lints an APK, checking for problems and errors
* [melange package-version](/docs/md/melange_package-version.md) - Report the target package for a YAML configuration file
* [melange query](/docs/md/melange_query.md) - Query a Melange YAML file for information
* [melange sign](/docs/md/melange_sign.md) - Sign an APK package
* [melange sign-index](/docs/md/melange_sign-index.md) - Sign an APK index
* [melange test](/docs/md/melange_test.md) - Test a package with a YAML configuration file
* [melange update-cache](/docs/md/melange_update-cache.md) - Update a source artifact cache
* [melange version](/docs/md/melange_version.md) - Prints the version
* [melange build](/open-source/melange/reference/melange_build/) - Build a package from a YAML configuration file
* [melange bump](/open-source/melange/reference/melange_bump/) - Update a Melange YAML file to reflect a new package version
* [melange completion](/open-source/melange/reference/melange_completion/) - Generate completion script
* [melange convert](/open-source/melange/reference/melange_convert/) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files
* [melange index](/open-source/melange/reference/melange_index/) - Creates a repository index from a list of package files
* [melange keygen](/open-source/melange/reference/melange_keygen/) - Generate a key for package signing
* [melange lint](/open-source/melange/reference/melange_lint/) - EXPERIMENTAL COMMAND - Lints an APK, checking for problems and errors
* [melange package-version](/open-source/melange/reference/melange_package-version/) - Report the target package for a YAML configuration file
* [melange query](/open-source/melange/reference/melange_query/) - Query a Melange YAML file for information
* [melange sign](/open-source/melange/reference/melange_sign/) - Sign an APK package
* [melange sign-index](/open-source/melange/reference/melange_sign-index/) - Sign an APK index
* [melange test](/open-source/melange/reference/melange_test/) - Test a package with a YAML configuration file
* [melange update-cache](/open-source/melange/reference/melange_update-cache/) - Update a source artifact cache
* [melange version](/open-source/melange/reference/melange_version/) - Prints the version

4 changes: 2 additions & 2 deletions docs/md/melange_build.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange build"
slug: melange_build
url: /docs/md/melange_build.md
url: /open-source/melange/reference/melange_build/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -66,5 +66,5 @@ melange build [flags]

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_bump.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange bump"
slug: melange_bump
url: /docs/md/melange_bump.md
url: /open-source/melange/reference/melange_bump/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -32,7 +32,13 @@ melange bump [flags]
-h, --help help for bump
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_completion.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange completion"
slug: melange_completion
url: /docs/md/melange_completion.md
url: /open-source/melange/reference/melange_completion/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -54,7 +54,13 @@ melange completion [bash|zsh|fish|powershell]
-h, --help help for completion
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

16 changes: 11 additions & 5 deletions docs/md/melange_convert.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange convert"
slug: melange_convert
url: /docs/md/melange_convert.md
url: /open-source/melange/reference/melange_convert/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -30,10 +30,16 @@ Convert is an EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild
--wolfi-defaults if true, adds wolfi repo, and keyring to config (default true)
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange convert apkbuild](/docs/md/melange_convert_apkbuild.md) - Converts an APKBUILD package into a melange.yaml
* [melange convert gem](/docs/md/melange_convert_gem.md) - Converts an gem into a melange.yaml
* [melange convert python](/docs/md/melange_convert_python.md) - Converts a python package into a melange.yaml
* [melange](/open-source/melange/reference/melange/) -
* [melange convert apkbuild](/open-source/melange/reference/melange_convert_apkbuild/) - Converts an APKBUILD package into a melange.yaml
* [melange convert gem](/open-source/melange/reference/melange_convert_gem/) - Converts an gem into a melange.yaml
* [melange convert python](/open-source/melange/reference/melange_convert_python/) - Converts a python package into a melange.yaml

5 changes: 3 additions & 2 deletions docs/md/melange_convert_apkbuild.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange convert apkbuild"
slug: melange_convert_apkbuild
url: /docs/md/melange_convert_apkbuild.md
url: /open-source/melange/reference/melange_convert_apkbuild/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -38,6 +38,7 @@ melange convert apkbuild [flags]
```
--additional-keyrings stringArray additional repositories to be added to convert environment config
--additional-repositories stringArray additional repositories to be added to convert environment config
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
-o, --out-dir string directory where convert config will be output (default ".")
--use-github **experimental** if true, tries to use github to figure out the release commit details (python only for now). To prevent rate limiting, you can set the GITHUB_TOKEN env variable to a github token. (default true)
--use-relmon **experimental** if true, tries to use release-monitoring to fetch release monitoring data.
Expand All @@ -46,5 +47,5 @@ melange convert apkbuild [flags]

### SEE ALSO

* [melange convert](/docs/md/melange_convert.md) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files
* [melange convert](/open-source/melange/reference/melange_convert/) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files

5 changes: 3 additions & 2 deletions docs/md/melange_convert_gem.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange convert gem"
slug: melange_convert_gem
url: /docs/md/melange_convert_gem.md
url: /open-source/melange/reference/melange_convert_gem/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -40,6 +40,7 @@ convert gem fluentd
```
--additional-keyrings stringArray additional repositories to be added to convert environment config
--additional-repositories stringArray additional repositories to be added to convert environment config
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
-o, --out-dir string directory where convert config will be output (default ".")
--use-github **experimental** if true, tries to use github to figure out the release commit details (python only for now). To prevent rate limiting, you can set the GITHUB_TOKEN env variable to a github token. (default true)
--use-relmon **experimental** if true, tries to use release-monitoring to fetch release monitoring data.
Expand All @@ -48,5 +49,5 @@ convert gem fluentd

### SEE ALSO

* [melange convert](/docs/md/melange_convert.md) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files
* [melange convert](/open-source/melange/reference/melange_convert/) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files

5 changes: 3 additions & 2 deletions docs/md/melange_convert_python.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange convert python"
slug: melange_convert_python
url: /docs/md/melange_convert_python.md
url: /open-source/melange/reference/melange_convert_python/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -41,6 +41,7 @@ convert python botocore
```
--additional-keyrings stringArray additional repositories to be added to convert environment config
--additional-repositories stringArray additional repositories to be added to convert environment config
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
-o, --out-dir string directory where convert config will be output (default ".")
--use-github **experimental** if true, tries to use github to figure out the release commit details (python only for now). To prevent rate limiting, you can set the GITHUB_TOKEN env variable to a github token. (default true)
--use-relmon **experimental** if true, tries to use release-monitoring to fetch release monitoring data.
Expand All @@ -49,5 +50,5 @@ convert python botocore

### SEE ALSO

* [melange convert](/docs/md/melange_convert.md) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files
* [melange convert](/open-source/melange/reference/melange_convert/) - EXPERIMENTAL COMMAND - Attempts to convert packages/gems/apkbuild files into melange configuration files

10 changes: 8 additions & 2 deletions docs/md/melange_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange index"
slug: melange_index
url: /docs/md/melange_index.md
url: /open-source/melange/reference/melange_index/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -36,7 +36,13 @@ melange index [flags]
-s, --source string Source FILE to use for pre-existing index entries (default "APKINDEX.tar.gz")
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_keygen.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange keygen"
slug: melange_keygen
url: /docs/md/melange_keygen.md
url: /open-source/melange/reference/melange_keygen/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -32,7 +32,13 @@ melange keygen [flags]
--key-size int the size of the prime to calculate (in bits) (default 4096)
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_lint.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange lint"
slug: melange_lint
url: /docs/md/melange_lint.md
url: /open-source/melange/reference/melange_lint/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -33,7 +33,13 @@ melange lint [flags]
-h, --help help for lint
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_package-version.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange package-version"
slug: melange_package-version
url: /docs/md/melange_package-version.md
url: /open-source/melange/reference/melange_package-version/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -35,7 +35,13 @@ melange package-version [flags]
-h, --help help for package-version
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_query.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange query"
slug: melange_query
url: /docs/md/melange_query.md
url: /open-source/melange/reference/melange_query/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -32,7 +32,13 @@ melange query [flags]
-h, --help help for query
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_sign-index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange sign-index"
slug: melange_sign-index
url: /docs/md/melange_sign-index.md
url: /open-source/melange/reference/melange_sign-index/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -39,7 +39,13 @@ melange sign-index [flags]
--signing-key string the signing key to use (default "melange.rsa")
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

10 changes: 8 additions & 2 deletions docs/md/melange_sign.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "melange sign"
slug: melange_sign
url: /docs/md/melange_sign.md
url: /open-source/melange/reference/melange_sign/
draft: false
images: []
type: "article"
Expand Down Expand Up @@ -36,7 +36,13 @@ melange sign [flags]
-k, --signing-key string The signing key to use. (default "local-melange.rsa")
```

### Options inherited from parent commands

```
--log-policy strings log policy (e.g. builtin:stderr, /tmp/log/foo) (default [builtin:stderr])
```

### SEE ALSO

* [melange](/docs/md/melange.md) -
* [melange](/open-source/melange/reference/melange/) -

Loading

0 comments on commit 7b3a4be

Please sign in to comment.