Skip to content

Commit

Permalink
update docs links
Browse files Browse the repository at this point in the history
  • Loading branch information
t83714 committed Mar 11, 2022
1 parent 2cff691 commit 51cbd7a
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 1 deletion.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,8 @@ Magda is built around a collection of microservices that are distributed as dock

![Magda Architecture Diagram](docs/assets/marketecture.svg)

If you are interested in the architecture details of Magda, you might want to have a look at [this doc](./docs/docs/architecture/Guide%20to%20Magda%20Internals.md).

### Registry

Magda revolves around the _Registry_ - an unopinionated datastore built on top of Postgres. The Registry stores _records_ as a set of JSON documents called _aspects_. For instance, a dataset is represented as a record with a number of aspects - a basic one that records the name, description and so on as well as more esoteric ones that might not be present for every dataset, like temporal coverage or determined data quality. Likewise, distributions (the actual data files, or URLs linking to them) are also modelled as records, with their own sets of aspects covering both basic metadata once again, as well as more specific aspects like whether the URL to the file worked when last tested.
Expand Down Expand Up @@ -95,3 +97,5 @@ Great! Take a look at https://github.com/magda-io/magda/blob/master/.github/CONT
- [Magda Helm Chart Reference](docs/docs/helm-charts-docs-index.md)
- [Migration & Upgrade Documents](docs/docs/migration)
- [Other documentations](docs/docs/index.md)

More documents can be found from the folder [docs/docs/](./docs/docs/).
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -178,7 +178,7 @@ We welcome new contributors too! please check out our [Contributor's Guide](http
- [Our Github](https://github.com/magda-io/magda)
- [Magda API Reference](https://dev.magda.io/api/v0/apidocs/index.html)
- [Magda Helm Chart Reference](/docs/helm-charts-docs-index)
- [Other documentations](/docs)
- [Other documentations](https://github.com/magda-io/magda/tree/master/docs/docs)
- [Ask Questions on Our Github Discussions forum](https://github.com/magda-io/magda/discussions)

The project was started by CSIRO's [Data61](https://data61.csiro.au/) and Australia's [Department of Prime Minister and Cabinet](https://www.pmc.gov.au/). It's progressing thanks to Data61, the [Digital Transformation Agency](https://www.dta.gov.au/), the [Department of Agriculture](http://www.agriculture.gov.au/), the [Department of the Environment and Energy](https://www.environment.gov.au/) and [CSIRO Land and Water](https://www.csiro.au/en/Research/LWF).

0 comments on commit 51cbd7a

Please sign in to comment.