": r"",
@@ -626,8 +656,7 @@
"name": "flyteidl",
"source": "../flyteidl",
"docs_path": "protos",
- "dest": "protos", # to stay compatible with flyteidl docs path naming
- "cmd": ["cp", "../flyteidl/README.md", "protos/README.md"],
+ "dest": "api/flyteidl",
"local": True,
}
]
diff --git a/docs/index.md b/docs/index.md
index a80517ce20..d5fcfbbb8b 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,54 +1,55 @@
# Welcome to Flyte!
-```{eval-rst}
-.. raw:: html
+````{card} The highly scalable and flexible workflow orchestrator that unifies data, ML and analytics.
+:class-card: subtitle-and-badges
-
- The highly scalable and flexible workflow orchestrator that unifies data, ML and analytics.
-
-
-.. image:: https://img.shields.io/badge/Graduate%20Project-Linux%20Foundation-purple?style=for-the-badge
- :target: https://lfaidata.foundation/projects/flyte/
- :alt: Linux Foundation
-
-.. image:: https://img.shields.io/github/stars/flyteorg/flyte?label=github&logo=github&style=for-the-badge
- :target: https://github.com/flyteorg/flyte
- :alt: GitHub Repo stars
+```{image} https://img.shields.io/badge/Graduate%20Project-Linux%20Foundation-purple?style=for-the-badge
+:target: https://lfaidata.foundation/projects/flyte/
+:alt: Linux Foundation
+```
-.. image:: https://img.shields.io/github/release/flyteorg/flyte.svg?style=for-the-badge&color=blue
- :target: https://github.com/flyteorg/flyte/releases/latest
- :alt: Flyte Release
+```{image} https://img.shields.io/github/stars/flyteorg/flyte?label=github&logo=github&style=for-the-badge
+:target: https://github.com/flyteorg/flyte
+:alt: GitHub Repo stars
+```
-.. image:: https://img.shields.io/github/actions/workflow/status/flyteorg/flyte/tests.yml?label=tests&style=for-the-badge
- :target: https://github.com/flyteorg/flyte/actions/workflows/tests.yml
- :alt: GitHub Test Status
+```{image} https://img.shields.io/github/release/flyteorg/flyte.svg?style=for-the-badge&color=blue
+:target: https://github.com/flyteorg/flyte/releases/latest
+:alt: Flyte Release
+```
-.. image:: https://img.shields.io/github/actions/workflow/status/flyteorg/flyte/sandbox.yml?label=Sandbox%20docker%20image&style=for-the-badge
- :target: https://github.com/flyteorg/flyte/actions/workflows/sandbox.yml
- :alt: GitHub Sandbox Status
+```{image} https://img.shields.io/github/actions/workflow/status/flyteorg/flyte/tests.yml?label=tests&style=for-the-badge
+:target: https://github.com/flyteorg/flyte/actions/workflows/tests.yml
+:alt: GitHub Test Status
+```
-.. image:: https://img.shields.io/github/milestones/closed/flyteorg/flyte?style=for-the-badge
- :target: https://github.com/flyteorg/flyte/milestones?state=closed
- :alt: Completed Milestones
+```{image} https://img.shields.io/github/actions/workflow/status/flyteorg/flyte/sandbox.yml?label=Sandbox%20docker%20image&style=for-the-badge
+:target: https://github.com/flyteorg/flyte/actions/workflows/sandbox.yml
+:alt: GitHub Sandbox Status
+```
-.. image:: https://img.shields.io/pypi/dm/flytekit?color=blue&label=flytekit%20downloads&style=for-the-badge&logo=pypi&logoColor=white
- :target: https://github.com/flyteorg/flytekit
- :alt: Flytekit Downloads
+```{image} https://img.shields.io/github/milestones/closed/flyteorg/flyte?style=for-the-badge
+:target: https://github.com/flyteorg/flyte/milestones?state=closed
+:alt: Completed Milestones
+```
-.. image:: https://img.shields.io/badge/Slack-Chat-pink?style=for-the-badge&logo=slack
- :target: https://slack.flyte.org
- :alt: Flyte Slack
+```{image} https://img.shields.io/pypi/dm/flytekit?color=blue&label=flytekit%20downloads&style=for-the-badge&logo=pypi&logoColor=white
+:target: https://github.com/flyteorg/flytekit
+:alt: Flytekit Downloads
+```
-.. image:: https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg?style=for-the-badge
- :target: http://www.apache.org/licenses/LICENSE-2.0.html
- :alt: License
+```{image} https://img.shields.io/badge/Slack-Chat-pink?style=for-the-badge&logo=slack
+:target: https://slack.flyte.org
+:alt: Flyte Slack
+```
-.. |br| raw:: html
+```{image} https://img.shields.io/badge/LICENSE-Apache2.0-ff69b4.svg?style=for-the-badge
+:target: http://www.apache.org/licenses/LICENSE-2.0.html
+:alt: License
+```
-
-
+````
-```
[Flyte](https://github.com/flyteorg/flyte) is an open-source, Kubernetes-native
workflow orchestrator implemented in [Go](https://go.dev/). It enables highly
@@ -102,7 +103,7 @@ Below are the API reference to the different components of Flyte:
- Flyte's official Python SDK.
* - {doc}`FlyteCTL `
- Flyte's command-line interface for interacting with a Flyte cluster.
-* - {doc}`FlyteIDL `
+* - {doc}`FlyteIDL `
- Flyte's core specification language.
```
@@ -135,6 +136,5 @@ flytesnacks/tutorials/index
flytesnacks/integrations/index
deployment/index
api/index
-reference_flyteidl
community/index
```
diff --git a/docs/reference_flyteidl.md b/docs/reference_flyteidl.md
deleted file mode 100644
index bfe9924c9e..0000000000
--- a/docs/reference_flyteidl.md
+++ /dev/null
@@ -1,18 +0,0 @@
-# FlyteIDL API reference
-
-The protocol buffers defined here provide a high level specification of various
-entities in Flyte control plane and data plane. It provides detailed definitions
-and documentation of all these entities.
-
-```{toctree}
-:maxdepth: 2
-:name: flyteidltoc
-
-Flyte Core Language Specification
-FlyteAdmin Service
-FlyteAdmin REST and gRPC Interface
-Data Catalog Service
-Internal and External Eventing Interface
-Flyte Task Plugin Specification
-Contributing Guide
-```
diff --git a/docs/user_guide/index.md b/docs/user_guide/index.md
index 44c975f6ae..ae439c8760 100644
--- a/docs/user_guide/index.md
+++ b/docs/user_guide/index.md
@@ -94,7 +94,6 @@ concepts/component_architecture/index
:hidden:
flytekit-java
-unionml
pterodactyl
latch sdk
```
diff --git a/flyteidl/README.md b/flyteidl/README.md
index 67685f45b7..25a5badebc 100644
--- a/flyteidl/README.md
+++ b/flyteidl/README.md
@@ -1,6 +1,6 @@
# Flyteidl
-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).
+This is one of the core components 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).
[](https://slack.flyte.org)
@@ -11,69 +11,4 @@ This is one of the core repositories of Flyte. It contains the Specification of
## Contributing to Flyteidl
-## Tooling for Flyteidl
-
-1. Run ``make download_tooling`` to install generator dependencies.
-
-```bash
- make download_tooling
-```
-
-2. Ensure Docker is installed locally.
-3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
-
-```bash
- make generate
-```
-
-4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
-
-```bash
- make doc-requirements.txt
-```
-
-## Docs structure
-
-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``.
-
-```
-docs
-├── admin
-│ ├── admin.rst
-│ └── index.rst
-├── core
-│ ├── core.rst
-│ └── index.rst
-├── datacatalog
-│ ├── datacatalog.rst
-│ └── index.rst
-├── event
-│ ├── event.rst
-│ └── index.rst
-├── plugins
-│ ├── index.rst
-│ └── plugins.rst
-├── service
-│ ├── index.rst
-│ └── service.rst
-```
-
-Each module in protos has a module in docs with the same name.
-For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
-
-
-## Generating Documentation
-
-* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
-```
- core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
- # Remove any currently generated file
- ls -d protos/docs/core/* | grep -v index.rst | xargs rm
- protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
-```
-
-* ``make generate`` generates the modified rst files.
-
-* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
-
+See the [contributing docs](protocs/contributing.md) for more information.
diff --git a/flyteidl/protos/docs/contributing.md b/flyteidl/protos/docs/contributing.md
new file mode 100644
index 0000000000..825ad7eeb6
--- /dev/null
+++ b/flyteidl/protos/docs/contributing.md
@@ -0,0 +1,68 @@
+## Contributing to FlyteIDL
+
+## Install Tooling
+
+1. Run ``make download_tooling`` to install generator dependencies.
+
+```bash
+ make download_tooling
+```
+
+2. Ensure Docker is installed locally.
+3. Run ``make generate`` to generate all the code, mock client, and docs for FlyteAdmin Service.
+
+```bash
+ make generate
+```
+
+4. To add new dependencies for documentation generation, modify ``doc-requirements.in`` and run
+
+```bash
+ make doc-requirements.txt
+```
+
+## Docs structure
+
+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``.
+
+```
+docs
+├── admin
+│ ├── admin.rst
+│ └── index.rst
+├── core
+│ ├── core.rst
+│ └── index.rst
+├── datacatalog
+│ ├── datacatalog.rst
+│ └── index.rst
+├── event
+│ ├── event.rst
+│ └── index.rst
+├── plugins
+│ ├── index.rst
+│ └── plugins.rst
+├── service
+│ ├── index.rst
+│ └── service.rst
+```
+
+Each module in protos has a module in docs with the same name.
+For example: ``protos/flyteidl/core`` has a module ``protos/docs/core`` under the ``docs`` folder which has the corresponding index and documentation files.
+
+
+## Generating Documentation
+
+* If a new module is to be introduced, follow the structure for core files in `generate_protos.sh` file which helps generate the core documentation from its proto files.
+```
+ core_proto_files=`ls protos/flyteidl/core/*.proto |xargs`
+ # Remove any currently generated file
+ ls -d protos/docs/core/* | grep -v index.rst | xargs rm
+ protoc --doc_out=protos/docs/core --doc_opt=restructuredtext,core.rst -I=protos `echo $core_proto_files`
+```
+
+* ``make generate`` generates the modified rst files.
+
+* ``make html`` generates the Sphinx documentation from the docs folder that uses the modified rst files.
+
diff --git a/flyteidl/protos/index.rst b/flyteidl/protos/docs_index.rst
similarity index 96%
rename from flyteidl/protos/index.rst
rename to flyteidl/protos/docs_index.rst
index 39544bcc2e..27383673de 100644
--- a/flyteidl/protos/index.rst
+++ b/flyteidl/protos/docs_index.rst
@@ -16,3 +16,4 @@ and documentation of all these entities.
docs/event/index
docs/plugins/index
docs/service/index
+ docs/contributing