Skip to content

Commit 106158c

Browse files
Feature / Documentation update for 07 (#473)
* Fix license headers on recently added files * Fix one link in the main README file * Update wording for main page of the docs * Update README top section with the same wording as the docs * Update development status in the main README. * Fix display of page contents for classes in API docs * Add maintainer info back into top sections in README and main docs page * Update logo for TRAC MMP
1 parent e58b5cd commit 106158c

File tree

12 files changed

+55
-47
lines changed

12 files changed

+55
-47
lines changed

README.md

+17-16
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,23 @@
1-
# ![TRAC Data & Analytics Platform](doc/_images/tracdap_horizontal_400.png)
1+
# ![TRAC: The modern model platform](doc/_images/tracmmp_horizontal_400.png)
22

33
*The modern model platform for complex, critical models and calculations.*
44

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

7-
TRAC is a universal model orchestration solution which is designed for the most complex, critical
8-
and highly-governed use cases. It combines your existing data and compute infrastructure,
7+
TRAC is a universal model orchestration solution for managing the most complex, critical
8+
and highly governed workflows. It combines your existing data and compute infrastructure,
99
model development environments and the repository of versioned code, to create a single ecosystem
1010
in which to build and deploy models, orchestrate complex workflows and run analytics.
1111

1212
TRAC is designed to break the trade-off that has traditionally been required, between flexible
1313
(but uncontrolled) analytics solutions and highly controlled (but inflexible) production model
1414
platforms. It offers best of both worlds, power, control and analytical flexibility.
1515

16-
The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
17-
[finTRAC Limited](https://www.fintrac.co.uk) in association with the [FINOS Foundation](https://www.finos.org)
18-
under the [Apache Software License version 2.0](https://www.apache.org/licenses/LICENSE-2.0).
16+
TRAC D.A.P. is the open-source data & analytics toolkit which provides the core capabilities of TRAC.
17+
It is maintained by [finTRAC Limited](https://fintrac.co.uk/)
18+
in association with [FINOS](https://www.finos.org/)
19+
and is available to download and use for free under the
20+
[Apache License, Version 2.0](https://www.apache.org/licenses/LICENSE-2.0>).
1921

2022
## Documentation and Packages
2123

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

32-
Commercially supported deployments of TRAC are separately available from `finTRAC Limited <https://www.fintrac.co.uk>`_.
34+
Commercially supported deployments of TRAC are separately available from [finTRAC Limited](https://www.fintrac.co.uk).
3335

3436
## Development Status
3537

@@ -45,16 +47,15 @@ https://github.com/finos/tracdap/actions/workflows/packaging.yml)
4547
https://tracdap.finos.org/en/stable/?badge=stable)
4648

4749

48-
The current release series (0.4.x) is intended for model development and prototyping.
49-
It provides an end-to-end workflow to build and run individual models in a local
50-
environment. It also provides the platform APIs needed to build client applications
51-
such as web tools or system client system integrations.
50+
The current release series (0.7) contains the core capabilities needed to build and run models,
51+
both for local development and in a hosted environment. It also contains the platform services
52+
and APIs needed to build client applications and system-to-system integrations.
5253

53-
The TRAC metadata structures and API calls are mostly complete. Metadata compatibility
54-
is ensured within a release series starting from version 0.4.0 - the 0.4.x series
55-
will be compatible with 0.4.0 but changes may be introduced in 0.5.0. The metadata
56-
model will continue to stabilise before eventually being frozen for version 1.0.0,
57-
after which it may be added to but no fields will be removed or changed.
54+
Metadata compatibility is guaranteed within each release series (e.g. 0.7.x). Minor changes may
55+
occur between release series, mostly for internal structures and removal of deprecated APIs.
56+
The metadata model will be frozen at version 1.0 after which it may be added to but no fields
57+
will be removed or change. Configuration formats are subject to change between versions and
58+
extension (plugin) APIs should be considered internal for the time being.
5859

5960
For more information see the
6061
[development roadmap](https://github.com/finos/tracdap/wiki/Development-Roadmap).

doc/_images/tracdap_horizontal.png

-67.5 KB
Binary file not shown.
-9.88 KB
Binary file not shown.
21.1 KB
Loading

doc/_templates/autoapi/python/class.rst

+8-5
Original file line numberDiff line numberDiff line change
@@ -26,17 +26,20 @@
2626

2727
{% set show_obj_args = False %}
2828

29-
.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.id }}{% else %}{{ obj.short_name }}{% endif %}{% if show_obj_args %}({{ obj.args }}){% endif %}
29+
{% if is_own_page %}
30+
.. py:currentmodule:: {{ obj.id.replace('.' + obj.name, '') }}
31+
32+
{% endif %}
33+
34+
.. py:{{ obj.type }}:: {% if is_own_page %}{{ obj.name }}{% else %}{{ obj.short_name }}{% endif %}{% if show_obj_args %}({{ obj.args }}){% endif %}
35+
36+
:canonical: {{ obj.id }}
3037

3138
{% for (args, return_annotation) in obj.overloads %}
3239
{{ " " * (obj.type | length) }} {{ obj.short_name }}{% if args %}({{ args }}){% endif %}
3340

3441
{% endfor %}
3542

36-
{% if is_own_page %}
37-
.. py:currentmodule:: {{ obj.id.replace('.' + obj.name, '') }}
38-
{% endif %}
39-
4043
{% if obj.bases %}
4144
{% if "show-inheritance" in autoapi_options %}
4245

doc/index.rst

+11-10
Original file line numberDiff line numberDiff line change
@@ -3,24 +3,25 @@
33
TRAC: The Modern Model Platform
44
###############################
55

6-
TRAC is a universal model orchestration solution designed for the most complex, critical and highly-governed
7-
use cases.
6+
TRAC is a universal model orchestration solution for managing the most complex, critical and highly governed workflows.
87

9-
The core platform services - i.e. TRAC Data & Analytics Platform (or TRAC D.A.P.) - are maintained by
10-
`finTRAC Limited <https://www.fintrac.co.uk>`_ in association with the `finos Foundation <https://www.finos.org>`_
11-
under the `Apache Software License version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
12-
13-
This documentation site focuses on how to deploy the TRAC D.A.P. services and build both models and
14-
applications which leverage those services. Commercially supported deployments of TRAC are separately
15-
available from `finTRAC Limited <https://www.fintrac.co.uk>`_.
8+
TRAC D.A.P. is the open-source data & analytics toolkit which provides the core capabilities of TRAC.
9+
It is maintained by `finTRAC Limited <https://fintrac.co.uk/>`_
10+
in association with `FINOS <https://www.finos.org/>`_
11+
and is available to download and use for free under the
12+
`Apache License, Version 2.0 <https://www.apache.org/licenses/LICENSE-2.0>`_.
1613

14+
This documentation describes how to build models and client applications using the TRAC D.A.P. toolkit.
15+
Commercially supported deployments of the TRAC platform are available separately from
16+
`finTRAC Limited <https://www.fintrac.co.uk>`_.
1717

1818
.. note::
19-
You can see the current development status of TRAC D.A.P. and a roadmap for the platform on the
19+
You can see the current development status of TRAC D.A.P. and a roadmap for the platform on the
2020
`roadmap page <https://github.com/finos/tracdap/wiki/Development-Roadmap>`_.
2121
If you have particular questions or issues, please raise a ticket on our
2222
`issue tracker <https://github.com/finos/tracdap/issues>`_.
2323

24+
2425
.. grid:: 1 2 2 2
2526
:gutter: 3
2627

tracdap-libs/tracdap-lib-auth/src/main/resources/builtin/content/login_ok.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
<body>
3232

3333
<div class="trac_logo">
34-
<img src="tracdap_horizontal_400.png" alt="TRAC Platform Logo">
34+
<img src="tracmmp_horizontal_400.png" alt="TRAC Platform Logo">
3535
</div>
3636

3737
</body>
Loading

tracdap-libs/tracdap-lib-validation/src/main/java/org/finos/tracdap/common/validation/version/FlowVersionValidator.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/*
2-
* Copyright 2024 finTRAC Limited
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License");
5-
* you may not use this file except in compliance with the License.
6-
* You may obtain a copy of the License at
2+
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
3+
* more contributor license agreements. See the NOTICE file distributed
4+
* with this work for additional information regarding copyright ownership.
5+
* FINOS licenses this file to you under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with the
7+
* License. You may obtain a copy of the License at
78
*
89
* http://www.apache.org/licenses/LICENSE-2.0
910
*

tracdap-libs/tracdap-lib-validation/src/main/java/org/finos/tracdap/common/validation/version/ModelVersionValidator.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/*
2-
* Copyright 2024 finTRAC Limited
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License");
5-
* you may not use this file except in compliance with the License.
6-
* You may obtain a copy of the License at
2+
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
3+
* more contributor license agreements. See the NOTICE file distributed
4+
* with this work for additional information regarding copyright ownership.
5+
* FINOS licenses this file to you under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with the
7+
* License. You may obtain a copy of the License at
78
*
89
* http://www.apache.org/licenses/LICENSE-2.0
910
*

tracdap-libs/tracdap-lib-validation/src/test/java/org/finos/tracdap/common/validation/version/ModelVersionValidationTest.java

+6-5
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
/*
2-
* Copyright 2024 finTRAC Limited
3-
*
4-
* Licensed under the Apache License, Version 2.0 (the "License");
5-
* you may not use this file except in compliance with the License.
6-
* You may obtain a copy of the License at
2+
* Licensed to the Fintech Open Source Foundation (FINOS) under one or
3+
* more contributor license agreements. See the NOTICE file distributed
4+
* with this work for additional information regarding copyright ownership.
5+
* FINOS licenses this file to you under the Apache License, Version 2.0
6+
* (the "License"); you may not use this file except in compliance with the
7+
* License. You may obtain a copy of the License at
78
*
89
* http://www.apache.org/licenses/LICENSE-2.0
910
*

0 commit comments

Comments
 (0)