Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Feature/documentation #471

Merged
merged 5 commits into from
Nov 8, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 13 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,25 @@
# ![TRAC Data & Analytics Platform](doc/_images/tracdap_horizontal_400.png)

*A next-generation data and analytics platform for use in highly regulated environments*
*The modern model platform for complex, critical models and calculations.*

[![FINOS - Incubating](https://cdn.jsdelivr.net/gh/finos/contrib-toolbox@master/images/badge-incubating.svg)](https://finosfoundation.atlassian.net/wiki/display/FINOS/Incubating)

TRAC D.A.P. brings a step change in performance, insight, flexibility and control
compared to conventional analytics platforms. By redrawing the boundary
between business and technology, modellers and business users are given easy
access to modern, open source tools that can execute at scale, while technology
integrations and operational concerns are cleanly separated and consolidated
across use cases.
TRAC is a universal model orchestration solution which is designed for the most complex, critical
and highly-governed use cases. It combines your existing data and compute infrastructure,
model development environments and the repository of versioned code, to create a single ecosystem
in which to build and deploy models, orchestrate complex workflows and run analytics.

At the core of a platform, a flexible metadata model allows data and models to
be catalogued, plugged together and shared across the business. Using the
principal of immutability, TRAC allows new data structures and model pipelines
to be created, updated and executed at any time without change risk to production
workflows, guaranteeing total repeatability, audit and control (TRAC).
TRAC is designed to break the trade-off that has traditionally been required, between flexible
(but uncontrolled) analytics solutions and highly controlled (but inflexible) production model
platforms. It offers best of both worlds, power, control and analytical flexibility.

The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
`finTRAC Limited <https://www.fintrac.co.uk>`_ in association with the `finos Foundation <https://www.finos.org>`_
under the `Apache Software License version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

## Documentation and Packages

Documentation for the TRAC platform is available on our website at
[tracdap.finos.org](https://tracdap.finos.org).
Documentation for the TRAC D.A.P platform is available on our website at [tracdap.finos.org](https://tracdap.finos.org).

The following packages are available:

Expand All @@ -31,6 +29,7 @@ The following packages are available:
| [Web API package](https://www.npmjs.com/package/@finos/tracdap-web-api) | Build client apps in JavaScript or TypeScript using the TRAC platform APIs |
| [Platform releases](https://github.com/finos/tracdap/releases) | Packages for the platform services and a standalone sandbox are published with each release on GitHub |

Commercially supported deployments of TRAC are separately available from `finTRAC Limited <https://www.fintrac.co.uk>`_.

## Development Status

Expand Down
Binary file added doc/_images/icon_audit.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_corrupt.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_data.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_flow.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_job.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_model.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_persist.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_repeat.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_self_doc.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added doc/_images/icon_sufficient.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion doc/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ def setup(app):
"sphinx_wagtail_theme"

]

exclusions = ['unused']

# Auto API configuration

Expand Down
30 changes: 17 additions & 13 deletions doc/index.rst
Original file line number Diff line number Diff line change
@@ -1,18 +1,22 @@

##############################
TRAC Data & Analytics Platform
TRAC: The Modern Model Platform
##############################

.. centered::
*A next-generation data and analytics platform for use in highly regulated environments*

TRAC is a universal model orchestration solution designed for the most complex, critical and highly-governed
use cases.

.. note::
We are building the documentation for TRAC in parallel with the open source version of the
platform, both are in active deveopment. This documentaiton is presented in the hope that
it will be useful before it is complete!
The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
`finTRAC Limited <https://www.fintrac.co.uk>`_ in association with the `finos Foundation <https://www.finos.org>`_
under the `Apache Software License version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.

This documentation site focuses on how to deploy the TRAC D.A.P. services and build both models and
applications which leverage those services. Commercially supported deployments of TRAC are separately
available from `finTRAC Limited <https://www.fintrac.co.uk>`_.

You can see the current development status and roadmap for the platform on the

.. note::
You can see the current development status of TRAC D.A.P. and a roadmap for the platform on the
`roadmap page <https://github.com/finos/tracdap/wiki/Development-Roadmap>`_.
If you have particular questions or issues, please raise a ticket on our
`issue tracker <https://github.com/finos/tracdap/issues>`_.
Expand All @@ -26,7 +30,7 @@ TRAC Data & Analytics Platform
**Learn about TRAC**
^^^^^^^^^^^^^^^^^^^^

Learn about the TRAC platform, starting with the metadata model.
Learn about the TRAC, the metadata model, virtual deployment framework and the TRAC Guarantee.

+++
.. button-ref:: overview/introduction
Expand All @@ -42,7 +46,7 @@ TRAC Data & Analytics Platform
**Build and run models**
^^^^^^^^^^^^^^^^^^^^^^^^

Use the TRAC runtime APIs to build portable, self-documenting models.
Use the TRAC runtime APIs to build portable, self-describing models.

+++
.. button-ref:: modelling/index
Expand Down Expand Up @@ -74,10 +78,10 @@ TRAC Data & Analytics Platform
:class-footer: sd-border-0


**Deploy and manage the platform**
**Deploy and manage TRAC D.A.P.**
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

Everything to do with deployment, configuration and technology integration,
Explore deployment, configuration and integration,
for dev-ops engineers and systems administrators.

+++
Expand Down
1 change: 0 additions & 1 deletion doc/overview/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,3 @@ Platform Overview
.. toctree::

./introduction
./metadata_model
Loading