Thanks to visit codestin.com
Credit goes to gitlab.com

Commit 2724fc04 authored by Jacky Jiang's avatar Jacky Jiang
Browse files

update docs

parent 85ad0722
Loading
Loading
Loading
Loading
Loading
+1 −0
Original line number Diff line number Diff line
@@ -178,6 +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)
- [Useful common documentations](./docs/index.md)
- [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)

+17 −18
Original line number Diff line number Diff line
# Magda Documentation

- [How to build and run](/docs/building-and-running)
- [Migration & Upgrade Documents](/docs/migration)
- [How to build and run](./building-and-running.md)
- [Migration & Upgrade Documents](./migration.md)
- [Deploy Magda with helm charts release](https://github.com/magda-io/magda-config)
- [Magda Helm Chart Reference](./helm-charts-docs-index.md)
- [How to deploy Magda on Google Cloud GKE](/docs/deploying-for-production-on-gke)
- [How to deploy Magda on Amazon AWS EKS](/docs/deploy-to-aws)
- [How to deploy Magda on Microsoft Azure Cloud AKS](/docs/deploy-to-azure)
- [How to use APIs](/docs/using-api)
- [How to document APIs](/docs/api-documentation-howto)
- [How to create API key](/docs/how-to-create-api-key)
- [How to set/unset admin users](/docs/how-to-set-user-as-admin-user)
- [How to deploy Magda on Google Cloud GKE](./deploying-for-production-on-gke.md)
- [How to deploy Magda on Amazon AWS EKS](./deploy-to-aws.md)
- [How to deploy Magda on Microsoft Azure Cloud AKS](./deploy-to-azure.md)
- [How to use APIs](./using-api.md)
- [How to document APIs](./api-documentation-howto.md)
- [How to create API key](./how-to-create-api-key.md)
- [How to set/unset admin users](./how-to-set-user-as-admin-user.md)
- [How to manage users, roles & permissions](https://www.npmjs.com/package/@magda/acs-cmd)
- [How to manage organizational hierarchy](https://www.npmjs.com/package/@magda/org-tree)
- [How to create local users](/docs/how-to-create-local-users)
- [How to setup HTTPS access to Local Dev Cluster](/docs/how-to-setup-https-to-local-cluster)
- [How to Customise Magda UI](/docs/how-to-customise-ui)
- [How to create local users](./how-to-create-local-users.md)
- [How to setup HTTPS access to Local Dev Cluster](./how-to-setup-https-to-local-cluster.md)
- [How to Customise Magda UI](./how-to-customise-ui.md)
- [Plugin UI Component SDK Doc](https://github.com/magda-io/magda/tree/master/packages/external-ui-plugin-sdk/docs/modules.md)
- [How to build your own connectors / minions](/docs/how-to-build-your-own-connectors-minions)
- [Authentication Plugin Spec Document](/docs/authentication-plugin-spec)
- [How to recover with continuous archive backup](/docs/how-to-recover-with-continuous-archive-backup)
- [Ports used when running locally](/docs/local-ports)
- [Roadmap](/docs/roadmap)
- [Windows Setup Instructions](/docs/windows-instructions)
- [How to build your own connectors / minions](./how-to-build-your-own-connectors-minions.md)
- [Authentication Plugin Spec Document](./authentication-plugin-spec.md)
- [How to recover with continuous archive backup](./how-to-recover-with-continuous-archive-backup.md)
- [Ports used when running locally](./local-ports.md)
- [Windows Setup Instructions](./windows-instructions.md)

More documentation, please check [here](https://github.com/magda-io/magda/tree/master/docs/docs)
+8 −18
Original line number Diff line number Diff line
# Roadmap

<a href="/docs/past-achievements.png" rel="noopener noreferrer" target="_blank"><img src="/docs/past-achievements.png" alt="Past Achievements"></a>

<a href="/docs/future-roadmap.png" rel="noopener noreferrer" target="_blank"><img src="/docs/future-roadmap.png" alt="Future Roadmap"></a>

## Next Priorities

**Authorisation**: We're using Open Policy Agent to allow the restriction of Magda's resources by writing and assigning policies that can take into account the resource being restricted, the user's details, other information like time etc. This will allow for many different access-control strategies to suit the organisation using Magda - role-based, attribute-based etc, and also allows for Magda to replicate access control for datasets harvested from other sources.

**Cataloging**: We're developing a flow that allows for files to be dropped onto the UI and analyzed in order to automatically extract metadata, without the file necessarily ever being uploaded to a server. In addition, we're building a quick, easy to use AI to create and update metadata records for datasets.

**Duplication**: An unfortunate consequence of data sharing and modification is that often multiple duplicates of a dataset will exist in various parts of an organisation, with no clue as to which is the definitive version or even if there is one. Magda will have new features that allow for duplicate datasets to be detected and aggregated.

**Access Control**: Currently Magda has two roles: `isAdmin=true` and `isAdmin=false`. We want to build Role-Based Access Control into magda so that fine-grained policies can be set as to what users are allowed to change or see what within the system.

**Storage**: Magda currently operates purely on metadata, but doesn't store underlying data. While this isn't as restrictive as it sounds, it does prevent us from adding future features that could provide a great deal of value to users, like APIfication or secure data sharing.

## Longer-Term Ideas

**Administration**: Currently most administration is via config files -

**APIification**: The ability to turn well-formatted datasets into RESTful APIs - this is something that's already offered by CKAN and is depended upon by users of data.gov.au. This may mean replicating how CKAN does it - ingesting the data into a single database and running queries on it - or adopting an AWS Lambda-esque approach where we spin up containers on demand to server requests.

## Longer-Term Ideas

**Exposing Usage to Custodians**: Currently data custodians publish data but have very little idea of how much take-up there is. We want to make it extremely easy for them to see how much their data is being viewed/downloaded.

**Subjective Data Usefulness/Usability/Ease-of-Use/Interest**: On data.gov.au there are many datasets that rate well on the 5-star scale (say a CC-licensed CSV), but are subjectively not as useful as other datasets. Ideally in addition to applying _objective_ measures of quality like the 5-star scale, Magda would also measure datasets _subjectively_, taking into account how useful, usable and relevant to the average user a dataset is. When an internet user searches for a document on the web via Google, they don't just expect the most relevant results to come back, they also expect the highest quality results, which Google determines via a number of measures, some of which apply quite a subjective view of what a high-quality page is. We'd like to develop something similar for Magda: we want to make it so that a search for specific data always returns that data, but more general searches return the most useful and interesting datasets that fit the criteria. Some ideas we're considering: