Skip to content

Commit e00d930

Browse files
authored
Merge pull request #44 from metno/43-improve-docs
update docs
2 parents 18c9613 + d7ed25d commit e00d930

2 files changed

Lines changed: 3 additions & 26 deletions

File tree

README.md

Lines changed: 3 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -6,41 +6,18 @@ Forti is a REST webservice that delivers weather and ocean forecast timeseries d
66

77
The data sources to the service are irregular grids of data, produced by batch jobs. These batch jobs use a wide range of input datasets, and run a set of post-processing algorithms to both improve the forecast quality and to add additional forecast parameters.
88

9-
The application is built with Go, although with some small parts in C++.
9+
The application is built with Go, although with some small parts in C++. It is meant to be run as containers — each component has an associated Dockerfile.
1010

1111
The code for the batch jobs that produce the datasets are not included in this repository.
1212

13-
## Usage
13+
## Getting started
1414

15-
The application is meant to be run as containers. Each component has an associated Dockerfile.
15+
[Getting started guide](docs/getting-started.md)
1616

1717
## Development
1818

1919
### Test
2020

21-
### Build
22-
23-
For all components, except fortiup, a docker image is built and pushed on every commit.
24-
They will all get the same tag, corresponding to the GitHub Actions `run_id`, which identifies a single workflow run.
25-
26-
For example, you may end up with the following images in the registry.
27-
28-
- fortiregistry.azurecr.io/xmlfrontend:337359
29-
- fortiregistry.azurecr.io/moxfrontend:337359
30-
- fortiregistry.azurecr.io/rawdataforecaster:337359
31-
- fortiregistry.azurecr.io/jsonfrontend:337359
32-
- fortiregistry.azurecr.io/correctedforecaster:337359
33-
- fortiregistry.azurecr.io/healthz:337359
34-
35-
In this case the docker tag, 337359, corresponds to the GitHub Actions run ID when building the project.
36-
The run ID may be found by looking at the correct build on the [Actions](https://github.com/metno/forti/actions) page.
37-
38-
For `fortiup`, a binary artifact is built and uploaded (rather than a docker image) when a tag matching `fortiup/*` is pushed.
39-
40-
## Getting started
41-
42-
[Getting started guide](GETTING_STARTED.md)
43-
4421
## Architecture
4522

4623
The application is made up of several binaries working together.
File renamed without changes.

0 commit comments

Comments
 (0)