Skip to content

Commit

Permalink
Gh-24: Integrate any documentation into the Gaffer-Doc project (#324)
Browse files Browse the repository at this point in the history
* update READMEs and remove transferred files
  • Loading branch information
cn337131 committed Sep 13, 2023
1 parent f13bb50 commit 53dfcbf
Show file tree
Hide file tree
Showing 20 changed files with 16 additions and 1,024 deletions.
33 changes: 0 additions & 33 deletions CONTRIBUTING.md

This file was deleted.

28 changes: 16 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,26 +1,28 @@
Gaffer Docker
================
# Gaffer Docker

This repo contains the code needed to run Gaffer using Docker or Kubernetes.
This repo contains the code needed to run Gaffer using Docker or Kubernetes.
There are two main sub-folders, 'docker' and 'kubernetes' which contain the project files you need for starting Gaffer using those services.

# Running Gaffer Using Docker
For information on how to run Gaffer using Docker containers, please see the README in the docker directory: [Gaffer Docker README](docker/README.md)

For information on how to run Gaffer using Docker containers, please see the documentation: [Gaffer Docker Docs](https://gchq.github.io/gaffer-doc/latest/dev/docker/)

# Running Gaffer Using Kubernetes
For information on how to run Gaffer using Kubernetes, please see the README in the kubernetes directory: [Kubernetes README](kubernetes/README.md)

For information on how to run Gaffer using Kubernetes, please see the documentation: [Gaffer Kubernetes Docs](https://gchq.github.io/gaffer-doc/latest/dev/kubernetes-guide/kubernetes/)

# Versioning

Each of our images which is released will be tagged with the version of the software they represent. Every release,
we update the `latest` tag for each image and add a new release which has the corresponding version tag.

If we release Gaffer version 2.1.2, the following images would be uploaded:

* gchq/gaffer:latest
* gchq/gaffer:2
* gchq/gaffer:2.1
* gchq/gaffer:2.1.2
* gchq/gaffer:2.1.2-accumulo-2.0.1
- gchq/gaffer:latest
- gchq/gaffer:2
- gchq/gaffer:2.1
- gchq/gaffer:2.1.2
- gchq/gaffer:2.1.2-accumulo-2.0.1

We maintain mutable versions of latest, as well as the major, minor and bugfix versions of Gaffer. For reproducibility
make sure to use the full version in your build metadata. For `gaffer`/`gaffer-rest` images, we also create a tag including the
Expand All @@ -30,7 +32,9 @@ are not published but can be build locally if required.
The release process is automated by GitHub actions.

# Known Compatible Docker Versions
* 20.10.23

- 20.10.23

# Contributing
If you would like to make a Contribution, we have all the details for doing that [here](CONTRIBUTING.md)

We welcome contributions to this project. Detailed information on our ways of working can be found in our [developer docs](https://gchq.github.io/gaffer-doc/latest/dev/ways-of-working/).
21 changes: 0 additions & 21 deletions docker/README.md

This file was deleted.

28 changes: 0 additions & 28 deletions kubernetes/README.md

This file was deleted.

48 changes: 0 additions & 48 deletions kubernetes/accumulo/docs/kind-deployment.md

This file was deleted.

63 changes: 0 additions & 63 deletions kubernetes/docs/add-libraries.md

This file was deleted.

Loading

0 comments on commit 53dfcbf

Please sign in to comment.