Skip to content

Commit

Permalink
Updated MAINTAINERS_GUIDE.md
Browse files Browse the repository at this point in the history
Authored-by: Jhonathan Aristizabal <[email protected]>
  • Loading branch information
Jhonathan Aristizabal authored and jaristiz committed Dec 13, 2021
1 parent b42a941 commit 4663120
Show file tree
Hide file tree
Showing 3 changed files with 27 additions and 30 deletions.
22 changes: 22 additions & 0 deletions MAINTAINERS_GUIDE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Maintainer/Contributor Guidelines for this repository

This guide is intended for maintaners,

## CI

- The pipelines run on an internal deployment of Concourse.

- The script to update the pipelines is called `ci/scripts/update-ci.sh` and its called using a preconfigured concourse target.

## PRs

- We recommend that any feature requests / bug fixes be submitted as PRs. We recommend that when individuals
submit PRs, they have read the [Decisions](README.md#decisions) section of the readme in order to determine whether or not
the functionality they are requesting is generic and minimal enough to be added. If not, it is recommended
that this functionality live in a separate repository.

## Cutting a release

- Update the [CHANGELOG.md](CHANGELOG.md) file.
- Create a new tag with the version number and pointing to the commit with the latest change introduced.
- Create a release.
23 changes: 0 additions & 23 deletions MAINTENANCE.md

This file was deleted.

12 changes: 5 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Paving

This repository contains Terraform templates for paving the necessary
infrastructure to deploy Pivotal Platform (PKS and PAS) to a single foundation.
infrastructure to deploy Tanzu application Platform (PKS and TAS) to a single foundation.
The templates support AWS, vSphere, Azure, and GCP.


Expand Down Expand Up @@ -36,17 +36,15 @@ Every foundation requires an Ops Manager.

## Decisions

- These templates support deploying Pivotal Application Service (PAS)
- These templates support deploying Tanzu Application Service (TAS)
and Pivotal Container Service (PKS) to the same foundation.

- The templates **do not** create an Ops Manager VM but **do**
create the necessary infrastructure for the VM (security groups, keys, etc).

- These templates demonstrate a modest production deployment in three (3) AZs on
each IaaS.
- These templates demonstrate a modest production deployment in three (3) AZs on each IaaS.

- These templates contain extremely minimal interdependence or cleverness,
to facilitate incorporating these templates into your own automation easily.
- These templates contain extremely minimal interdependence or cleverness, to facilitate incorporating these templates into your own automation easily.

## Versioning

Expand All @@ -55,7 +53,7 @@ of `terraform output stable_config_(opsmanager|pas|pks)`. `stable_config` should
the minimum necessary to install Pivotal Platform. Any other output may be
added or removed without a change in version. However, MAJOR.MINOR.PATCH should
change according to the following:
- If an output is removed, the MAJOR version should be incremented
- If an output is removed or a major breaking change is introduced, the MAJOR version should be incremented
- If an output is added, the MINOR version should be incremented
- Otherwise, the patch version should be incremented

Expand Down

0 comments on commit 4663120

Please sign in to comment.