Big Bang requires some additional documentation for supported packages to help user's understand how it interacts with other components. The following are documents that should be created or updated for integration into Big Bang:
- Package Architecture: See [Big Bang's Architecture instructions](../../understanding-bigbang/package-architecture/ref-package.md). Examples are included in [understanding-bigbang/package-architecture](../../understanding-bigbang/package-architecture).
- Package Architecture: See [Big Bang's Architecture instructions](../../understanding-bigbang/package-architecture/ref-package.md). Examples are included in [the packagearchitecture](../../understanding-bigbang/package-architecture/README.md).
> Throughout this document, we will be setting up an application called `podinfo` as a demonstration.
...
...
@@ -146,11 +146,11 @@ To minimize maintenance, it is preferable to reuse existing Helm charts availabl
There is a standard Big Bang template used for all packages. This can be created by following the [templating instructions](https://repo1.dso.mil/big-bang/apps/library-charts/gluon/-/blob/master/docs/bb-package-readme.md)
> This process produces a `README.md`, `README.md.gotpl`, and `.helmdocsignore`. The `gotpl` file is used as values to update the `README.md`.
> To avoid having the `flux` helm chart also added to the `README.md`, run `echo 'flux/*' >> .helmdocsignore`
Example:
<!-- markdownlint-disable -->
```markdown
# podinfo
...
...
@@ -162,8 +162,8 @@ To minimize maintenance, it is preferable to reuse existing Helm charts availabl
* <https://github.com/stefanprodan/podinfo>
## Learn More
* [Application Overview\](docs/overview.md)
* [Other Documentation\](docs/)
* [Application Overview](docs/overview.md)
* [Other Documentation](docs/)
## Pre-Requisites
...
...
@@ -195,8 +195,9 @@ To minimize maintenance, it is preferable to reuse existing Helm charts availabl
## Contributing
Please see the [contributing guide\](./CONTRIBUTING.md) if you are interested in contributing.
Please see the [contributing guide](./CONTRIBUTING.md) if you are interested in contributing.