Skip to content
This repository has been archived by the owner on Oct 23, 2023. It is now read-only.

Commit

Permalink
Updated index.rst files
Browse files Browse the repository at this point in the history
Signed-off-by: SmritiSatyanV <[email protected]>
  • Loading branch information
SmritiSatyanV committed Mar 23, 2022
1 parent 85caf71 commit d6c79ca
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 7 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down Expand Up @@ -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``.

```
Expand Down
4 changes: 2 additions & 2 deletions protos/docs/core/index.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
Core Flyte language specification
=================================

Protocol buffers provide details about certain core data
structures like :ref:`workflows <divedeep-workflows>`, :ref:`tasks <divedeep-tasks>`, :ref:`nodes <divedeep-nodes>`, Literals. These are the specifications
Protocol buffers provide details about core data
structures like :ref:`workflows <divedeep-workflows>`, :ref:`tasks <divedeep-tasks>`, :ref:`nodes <divedeep-nodes>`, and Literals. They are the specifications
of the various entities in Flyte and the type system.

`Core raw protos <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/core>`__
Expand Down
8 changes: 4 additions & 4 deletions protos/docs/datacatalog/index.rst
Original file line number Diff line number Diff line change
@@ -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 <https://github.com/flyteorg/flyteidl/blob/master/protos/flyteidl/datacatalog/datacatalog.proto>`__

Expand Down

0 comments on commit d6c79ca

Please sign in to comment.