Skip to content

Commit

Permalink
chore: add pages to sidebars plus some tweaks
Browse files Browse the repository at this point in the history
  • Loading branch information
YOU54F committed Apr 12, 2023
1 parent 123341d commit 5466802
Show file tree
Hide file tree
Showing 5 changed files with 77 additions and 12 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ The markdown files in the following directories are synced from their respective
* `docs/implementation_guides/net`
* `docs/pact_broker/client_cli`
* `docs/pact_broker/docker_images/`
* `docs/pact_broker/pact_broker_on_kubernetes/`
* `docs/pact_broker/kubernetes/`

Each of the above Pact repositories has a Github workflow that triggers the [sync-docs](.github/workflows/sync-docs.yml) workflow when any markdown files are edited on `master`.

Expand Down
2 changes: 1 addition & 1 deletion scripts/sync/pact_broker_helm_chart.rb
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
IGNORE = []
CUSTOM_ACTIONS = [
[:all, ->(md_file_contents) { md_file_contents.extract_title } ],
["README.md", ->(md_file_contents) { md_file_contents.fields[:title] = "Deploy with Helm" } ]
["README.md", ->(md_file_contents) { md_file_contents.fields[:title] = "Deploy with Helm"; md_file_contents.fields[:slug] = "./readme" } ]
]

FileUtils.mkdir_p DESTINATION_DIR
Expand Down
File renamed without changes.
61 changes: 61 additions & 0 deletions website/docs/pact_broker/kubernetes/readme.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
---
title: Deploy with Helm
custom_edit_url: https://github.com/pact-foundation/pact-broker-chart/edit/master/README.md
slug: ./readme
---
<!-- This file has been synced from the pact-foundation/pact-broker-chart repository. Please do not edit it directly. The URL of the source file can be found in the custom_edit_url value above -->

[![License](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT) ![Release Charts](https://github.com/pact-foundation/pact-broker-chart/workflows/Release%20Charts/badge.svg?branch=master)

This repository will house the Pact Broker Helm Chart. It is important to note that this is a community maintained Helm Chart that has been brought under the Pact Foundation GitHub for ease of reference. The current maintainers are:

- [Chris Burns](https://github.com/ChrisJBurns)

We are always looking for maintainers, please let us know if you'd be interested. :)

## TL;DR

```console
helm repo add bitnami https://charts.bitnami.com/bitnami
helm repo add pact-broker https://pact-foundation.github.io/pact-broker-chart/

helm install pact-broker pact-broker/pact-broker
```

## Usage

The Pact Broker Chart is available in the following formats:
- [Chart Repository](https://helm.sh/docs/topics/chart_repository/)
- [OCI Artifacts](https://helm.sh/docs/topics/registries/)

### Installing from Chart Repository

The following command can be used to add the chart repository:

```console
helm repo add pact-broker https://pact-foundation.github.io/pact-broker-chart/
```

Once the chart has been added, install one of the available charts:

```console
helm install pact-broker pact-broker/pact-broker
```

### Installing from an OCI Registry

Charts are also available in OCI format. The list of available charts can be found [here](https://github.com/pact-foundation/pact-broker-chart/).

Install one of the available charts:

```shell
helm upgrade -i <release_name> oci://ghcr.io/pact-foundation/pact-broker-chart/pact-broker --version=<version>
```

## Contributing

The source code of all [Pact Broker](https://docs.pact.io/pact_broker/overview) [Helm](https://helm.sh) charts can be found on Github: <https://github.com/pact-foundation/pact-broker-chart/tree/master/charts/pact-broker/>

## License

[MIT License](https://github.com/pact-foundation/pact-broker-chart/blob/master/LICENSE).
24 changes: 14 additions & 10 deletions website/sidebars.json
Original file line number Diff line number Diff line change
Expand Up @@ -321,16 +321,6 @@
]
},
"pact_broker": {
"Dockerized Pact Broker": [
"pact_broker/docker_images",
"pact_broker/docker_images/pactfoundation",
"pact_broker/docker_images/dius"
],
"Pact Broker Client CLI": [
"pact_broker/client_cli",
"pact_broker/client_cli/readme",
"pact_broker/client_cli/changelog"
],
"Pact Broker": [
"pact_broker",
"pact_broker/overview",
Expand Down Expand Up @@ -398,6 +388,20 @@
"items": ["pact_broker/api/webhooks", "pact_broker/api/pacticipants", "pact_broker/api/pagination"]
},
"pact_broker/changelog"
],
"Pact Broker Client CLI": [
"pact_broker/client_cli",
"pact_broker/client_cli/readme",
"pact_broker/client_cli/changelog"
],
"Pact Broker - Docker": [
"pact_broker/docker_images",
"pact_broker/docker_images/pactfoundation",
"pact_broker/docker_images/dius"
],
"Pact Broker - Kubernetes": [
"pact_broker/kubernetes",
"pact_broker/kubernetes/readme"
]
},
"resources": [
Expand Down

0 comments on commit 5466802

Please sign in to comment.