diff --git a/README.md b/README.md index 244aeb715..a1be04d74 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,7 @@ This is one of the core repositories of Flyte. It contains the Specification of the Flyte Language using protobuf messages, the Backend API specification in gRPC, and Swagger REST. The repo contains the generated clients and protocol message structures in multiple languages. Along with the generated code, the repository also contains the Golang clients for Flyte's backend APIs (the services grouped under FlyteAdmin). + [![Slack](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack&style=social)](https://slack.flyte.org) * [flyte.org](https://flyte.org) @@ -33,7 +34,7 @@ This is one of the core repositories of Flyte. It contains the Specification of ## Docs structure -The index.rst files for protos are arranged in a parallel under the ``docs`` folder. +The index.rst files for protos are arranged in parallel under the ``docs`` folder. All the proto definitions are within ``protos/flyteidl`` and their corresponding docs are in ``protos/docs``. ``` diff --git a/protos/docs/core/index.rst b/protos/docs/core/index.rst index 2671eb37d..7d2ce0661 100644 --- a/protos/docs/core/index.rst +++ b/protos/docs/core/index.rst @@ -1,8 +1,8 @@ Core Flyte language specification ================================= -Protocol buffers provide details about certain core data -structures like :ref:`workflows `, :ref:`tasks `, :ref:`nodes `, Literals. These are the specifications +Protocol buffers provide details about core data +structures like :ref:`workflows `, :ref:`tasks `, :ref:`nodes `, and Literals. They are the specifications of the various entities in Flyte and the type system. `Core raw protos `__ diff --git a/protos/docs/datacatalog/index.rst b/protos/docs/datacatalog/index.rst index 652f2ecc0..d64c2ddd9 100644 --- a/protos/docs/datacatalog/index.rst +++ b/protos/docs/datacatalog/index.rst @@ -1,10 +1,10 @@ Flyte Data Catalog Service ============================ -Protos provides the interface definition for the Data Catalog Service. Data Catalog is a service for -indexing parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem -to catalog artifacts generated by the task executions. Output generated by a task can be stored as artifact -data and tagged by the user so that they can be retrieved later by that tag. +Protos provides the interface definition for the Data Catalog Service. Data Catalog is a service to +index parameterized, strongly-typed data artifacts across revisions. It is used in the Flyte ecosystem +to catalog artifacts generated by the task executions. The output generated by a task can be stored as artifact +data and tagged by the user so as to be retrieved later by that tag. `Datacatalog raw proto `__