Skip to content

Commit 6d7b38a

Browse files
adchiaadchia
authored
docs: Include docs updates for release process. Clean up old docs (#2957)
* docs: Include docs updates for release process. Clean up old references in docs Signed-off-by: Danny Chiao <[email protected]> * clean up third integrations page Signed-off-by: Danny Chiao <[email protected]> * clean up lint Signed-off-by: Danny Chiao <[email protected]> * add clarification on credentials Signed-off-by: Danny Chiao <[email protected]>
1 parent d0d27a3 commit 6d7b38a

14 files changed

Lines changed: 63 additions & 191 deletions

‎README.md‎

Lines changed: 5 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -139,7 +139,7 @@ The list below contains the functionality that contributors are planning to deve
139139

140140
* Items below that are in development (or planned for development) will be indicated in parentheses.
141141
* We welcome contribution to all items in the roadmap!
142-
* Want to speak to a Feast contributor? We are more than happy to jump on a call. Please schedule a time using [Calendly](https://calendly.com/d/x2ry-g5bb/meet-with-feast-team).
142+
* Have questions about the roadmap? Go to the Slack channel to ask on #feast-development
143143

144144
* **Data Sources**
145145
* [x] [Snowflake source](https://docs.feast.dev/reference/data-sources/snowflake)
@@ -151,7 +151,6 @@ The list below contains the functionality that contributors are planning to deve
151151
* [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/data-sources/postgres)
152152
* [x] [Spark (contrib plugin)](https://docs.feast.dev/reference/data-sources/spark)
153153
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push))
154-
* [ ] HTTP source
155154
* **Offline Stores**
156155
* [x] [Snowflake](https://docs.feast.dev/reference/offline-stores/snowflake)
157156
* [x] [Redshift](https://docs.feast.dev/reference/offline-stores/redshift)
@@ -184,30 +183,20 @@ The list below contains the functionality that contributors are planning to deve
184183
* **Deployments**
185184
* [x] AWS Lambda (Alpha release. See [RFC](https://docs.google.com/document/d/1eZWKWzfBif66LDN32IajpaG-j82LSHCCOzY6R7Ax7MI/edit))
186185
* [x] Kubernetes (See [guide](https://docs.feast.dev/how-to-guides/running-feast-in-production#4.3.-java-based-feature-server-deployed-on-kubernetes))
187-
* [ ] Cloud Run
188-
* [ ] KNative
189186
* **Feature Serving**
190187
* [x] Python Client
191-
* [x] REST Feature Server (Python) (Alpha release. See [RFC](https://docs.google.com/document/d/1iXvFhAsJ5jgAhPOpTdB3j-Wj1S9x3Ev\_Wr6ZpnLzER4/edit))
192-
* [x] gRPC Feature Server (Java) (See [#1497](https://github.com/feast-dev/feast/issues/1497))
193-
* [x] Push API
194-
* [ ] Java Client
195-
* [ ] Go Client
196-
* [ ] Delete API
197-
* [ ] Feature Logging (for training)
188+
* [x] REST Feature Server (Python) (See [RFC](https://docs.google.com/document/d/1iXvFhAsJ5jgAhPOpTdB3j-Wj1S9x3Ev\_Wr6ZpnLzER4/edit))
189+
* [x] REST / gRPC Feature Server (Go) (Alpha release. See [docs](https://docs.feast.dev/reference/feature-servers/go-feature-retrieval)
190+
* [x] gRPC Feature Server (Java) (Alpha release. See [#1497](https://github.com/feast-dev/feast/issues/1497))
198191
* **Data Quality Management (See [RFC](https://docs.google.com/document/d/110F72d4NTv80p35wDSONxhhPBqWRwbZXG4f9mNEMd98/edit))**
199192
* [x] Data profiling and validation (Great Expectations)
200-
* [ ] Training-serving skew detection (in progress)
201-
* [ ] Metric production
202-
* [ ] Drift detection
203193
* **Feature Discovery and Governance**
204194
* [x] Python SDK for browsing feature registry
205195
* [x] CLI for browsing feature registry
206196
* [x] Model-centric feature tracking (feature services)
207197
* [x] Amundsen integration (see [Feast extractor](https://github.com/amundsen-io/amundsen/blob/main/databuilder/databuilder/extractor/feast_extractor.py))
198+
* [x] DataHub integration (see [DataHub Feast docs](https://datahubproject.io/docs/generated/ingestion/sources/feast/))
208199
* [x] Feast Web UI (Alpha release. See [documentation](https://docs.feast.dev/reference/alpha-web-ui))
209-
* [ ] REST API for browsing feature registry
210-
211200

212201
## 🎓 Important Resources
213202

‎docs/community.md‎

Lines changed: 1 addition & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,11 @@
11
# Community
22

3-
{% hint style="success" %}
4-
**Speak to us:** Have a question, feature request, idea, or just looking to speak to a real person? Set up a meeting with a Feast maintainer over [here](https://calendly.com/d/x2ry-g5bb/meet-with-feast-team)!
5-
{% endhint %}
6-
73
## Links & Resources
84

95
* [Slack](https://slack.feast.dev): Feel free to ask questions or say hello!
106
* [Mailing list](https://groups.google.com/d/forum/feast-dev): We have both a user and developer mailing list.
117
* Feast users should join [[email protected]](mailto:[email protected]) group by clicking [here](https://groups.google.com/g/feast-discuss).
128
* Feast developers should join [[email protected]](mailto:[email protected]) group by clicking [here](https://groups.google.com/d/forum/feast-dev).
13-
* People interested in the Feast community newsletter should join feast-announce by clicking [here](https://groups.google.com/d/forum/feast-announce).
149
* [Community Calendar](https://calendar.google.com/calendar/u/0?cid=ZTFsZHVhdGM3MDU3YTJucTBwMzNqNW5rajBAZ3JvdXAuY2FsZW5kYXIuZ29vZ2xlLmNvbQ): Includes community calls and design meetings.
1510
* [Google Folder](https://drive.google.com/drive/u/0/folders/1jgMHOPDT2DvBlJeO9LCM79DP4lm4eOrR): This folder is used as a central repository for all Feast resources. For example:
1611
* Design proposals in the form of Request for Comments (RFC).
@@ -27,7 +22,7 @@
2722

2823
## Community Calls
2924

30-
We have a user and contributor community call every two weeks (Asia & US friendly).
25+
We have a user and contributor community call every two weeks (US & EU friendly).
3126

3227
{% hint style="info" %}
3328
Please join the above Feast user groups in order to see calendar invites to the community calls

‎docs/getting-started/feast-workshop.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -30,13 +30,15 @@ _See also:_ [_Feast quickstart_](https://docs.feast.dev/getting-started/quicksta
3030

3131
These are meant mostly to be done in order, with examples building on previous concepts.
3232

33-
| Time (min) | Description | Module |
34-
| :--------: | ----------------------------------------------------------------------- | --------------------------------------------------------------------------- |
35-
| 30-45 | Setting up Feast projects & CI/CD + powering batch predictions | [Module 0](https://github.com/feast-dev/feast-workshop/tree/main/module\_0) |
36-
| 15-20 | Streaming ingestion & online feature retrieval with Kafka, Spark, Redis | [Module 1](https://github.com/feast-dev/feast-workshop/tree/main/module\_1) |
37-
| 10-15 | Real-time feature engineering with on demand transformations | [Module 2](https://github.com/feast-dev/feast-workshop/tree/main/module\_2) |
38-
| TBD | Feature server deployment (embed, as a service, AWS Lambda) | TBD |
39-
| TBD | Versioning features / models in Feast | TBD |
40-
| TBD | Data quality monitoring in Feast | TBD |
41-
| TBD | Batch transformations | TBD |
42-
| TBD | Stream transformations | TBD |
33+
See https://github.com/feast-dev/feast-workshop
34+
35+
| Time (min) | Description | Module |
36+
| :--------: | ----------------------------------------------------------------------- |-----------|
37+
| 30-45 | Setting up Feast projects & CI/CD + powering batch predictions | Module 0 |
38+
| 15-20 | Streaming ingestion & online feature retrieval with Kafka, Spark, Redis | Module 1 |
39+
| 10-15 | Real-time feature engineering with on demand transformations | Module 2 |
40+
| TBD | Feature server deployment (embed, as a service, AWS Lambda) | TBD |
41+
| TBD | Versioning features / models in Feast | TBD |
42+
| TBD | Data quality monitoring in Feast | TBD |
43+
| TBD | Batch transformations | TBD |
44+
| TBD | Stream transformations | TBD |

‎docs/getting-started/third-party-integrations.md‎

Lines changed: 2 additions & 46 deletions
Original file line numberDiff line numberDiff line change
@@ -11,55 +11,11 @@ Don't see your offline store or online store of choice here? Check out our guide
1111

1212
## Integrations
1313

14-
### **Data Sources**
15-
16-
* [x] [Snowflake source](https://docs.feast.dev/reference/data-sources/snowflake)
17-
* [x] [Redshift source](https://docs.feast.dev/reference/data-sources/redshift)
18-
* [x] [BigQuery source](https://docs.feast.dev/reference/data-sources/bigquery)
19-
* [x] [Parquet file source](https://docs.feast.dev/reference/data-sources/file)
20-
* [x] [Synapse source (community plugin)](https://github.com/Azure/feast-azure)
21-
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
22-
* [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/data-sources/postgres)
23-
* [x] [Spark (contrib plugin)](https://docs.feast.dev/reference/data-sources/spark)
24-
* [x] Kafka / Kinesis sources (via [push support into the online store](https://docs.feast.dev/reference/data-sources/push))
25-
* [ ] HTTP source
26-
27-
### Offline Stores
28-
29-
* [x] [Snowflake](https://docs.feast.dev/reference/offline-stores/snowflake)
30-
* [x] [Redshift](https://docs.feast.dev/reference/offline-stores/redshift)
31-
* [x] [BigQuery](https://docs.feast.dev/reference/offline-stores/bigquery)
32-
* [x] [Synapse (community plugin)](https://github.com/Azure/feast-azure)
33-
* [x] [Hive (community plugin)](https://github.com/baineng/feast-hive)
34-
* [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/offline-stores/postgres)
35-
* [x] [Trino (contrib plugin)](https://github.com/Shopify/feast-trino)
36-
* [x] [Spark (contrib plugin)](https://docs.feast.dev/reference/offline-stores/spark)
37-
* [x] [In-memory / Pandas](https://docs.feast.dev/reference/offline-stores/file)
38-
* [x] [Custom offline store support](https://docs.feast.dev/how-to-guides/adding-a-new-offline-store)
39-
40-
### Online Stores
41-
42-
* [x] [DynamoDB](https://docs.feast.dev/reference/online-stores/dynamodb)
43-
* [x] [Redis](https://docs.feast.dev/reference/online-stores/redis)
44-
* [x] [Datastore](https://docs.feast.dev/reference/online-stores/datastore)
45-
* [x] [SQLite](https://docs.feast.dev/reference/online-stores/sqlite)
46-
* [x] [Azure Cache for Redis (community plugin)](https://github.com/Azure/feast-azure)
47-
* [x] [Postgres (contrib plugin)](https://docs.feast.dev/reference/online-stores/postgres)
48-
* [x] [Custom online store support](https://docs.feast.dev/how-to-guides/adding-support-for-a-new-online-store)
49-
* [x] [Cassandra / AstraDB](https://github.com/datastaxdevs/feast-cassandra-online-store)
50-
* [ ] Bigtable (in progress)
51-
52-
### **Deployments**
53-
54-
* [x] AWS Lambda (Alpha release. See [guide](../reference/alpha-aws-lambda-feature-server.md) and [RFC](https://docs.google.com/document/d/1eZWKWzfBif66LDN32IajpaG-j82LSHCCOzY6R7Ax7MI/edit))
55-
* [x] Kubernetes (See [guide](https://docs.feast.dev/how-to-guides/running-feast-in-production#4.3.-java-based-feature-server-deployed-on-kubernetes))
56-
* [ ] Cloud Run
57-
* [ ] KNative
58-
14+
See [Functionality and Roadmap](../../README.md#-functionality-and-roadmap)
5915

6016
## Standards
6117

62-
In order for a plugin integration to be highlighted on this page, it must meet the following requirements:
18+
In order for a plugin integration to be highlighted, it must meet the following requirements:
6319

6420
1. The plugin must have tests. Ideally it would use the Feast universal tests (see this [guide](../how-to-guides/adding-or-reusing-tests.md) for an example), but custom tests are fine.
6521
2. The plugin must have some basic documentation on how it should be used.

‎docs/project/development-guide.md‎

Lines changed: 0 additions & 81 deletions
Original file line numberDiff line numberDiff line change
@@ -11,85 +11,6 @@ This guide is targeted at developers looking to contribute to Feast:
1111

1212
> Learn How the Feast [Contributing Process](contributing.md) works.
1313
14-
## Project Structure
15-
16-
Feast is composed of [multiple components](../getting-started/architecture-and-components/) distributed into multiple repositories:
17-
18-
<table>
19-
<thead>
20-
<tr>
21-
<th style="text-align:left">Repository</th>
22-
<th style="text-align:left">Description</th>
23-
<th style="text-align:left">Component(s)</th>
24-
</tr>
25-
</thead>
26-
<tbody>
27-
<tr>
28-
<td style="text-align:left"><a href="https://github.com/feast-dev/feast">Main Feast Repository</a>
29-
</td>
30-
<td style="text-align:left">Hosts all required code to run Feast. This includes the Feast Python SDK
31-
and Protobuf definitions. For legacy reasons this repository still contains
32-
Terraform config and a Go Client for Feast.</td>
33-
<td style="text-align:left">
34-
<ul>
35-
<li><b>Python SDK / CLI</b>
36-
</li>
37-
<li><b>Protobuf APIs</b>
38-
</li>
39-
<li><b>Documentation</b>
40-
</li>
41-
<li><b>Go Client</b>
42-
</li>
43-
<li><b>Terraform</b>
44-
</li>
45-
</ul>
46-
</td>
47-
</tr>
48-
<tr>
49-
<td style="text-align:left"><a href="https://github.com/feast-dev/feast-java">Feast Java</a>
50-
</td>
51-
<td style="text-align:left">Java-specific Feast components. Includes the Feast Core Registry, Feast
52-
Serving for serving online feature values, and the Feast Java Client for
53-
retrieving feature values.</td>
54-
<td style="text-align:left">
55-
<ul>
56-
<li><b>Core</b>
57-
</li>
58-
<li><b>Serving</b>
59-
</li>
60-
<li><b>Java Client</b>
61-
</li>
62-
</ul>
63-
</td>
64-
</tr>
65-
<tr>
66-
<td style="text-align:left"><a href="https://github.com/feast-dev/feast-spark">Feast Spark</a>
67-
</td>
68-
<td style="text-align:left">Feast Spark SDK &amp; Feast Job Service for launching ingestion jobs and
69-
for building training datasets with Spark</td>
70-
<td style="text-align:left">
71-
<ul>
72-
<li><b>Spark SDK</b>
73-
</li>
74-
<li><b>Job Service</b>
75-
</li>
76-
</ul>
77-
</td>
78-
</tr>
79-
<tr>
80-
<td style="text-align:left"><a href="https://github.com/feast-dev/feast-helm-charts/">Feast Helm Chart</a>
81-
</td>
82-
<td style="text-align:left">Helm Chart for deploying Feast on Kubernetes &amp; Spark.</td>
83-
<td style="text-align:left">
84-
<ul>
85-
<li><b>Helm Chart</b>
86-
</li>
87-
</ul>
88-
</td>
89-
</tr>
90-
</tbody>
91-
</table>
92-
9314
## Making a Pull Request
9415

9516
{% hint style="info" %}
@@ -148,5 +69,3 @@ The language specific bindings have to be regenerated when changes are made to t
14869
| :--- | :--- | :--- |
14970
| [Main Feast Repository](https://github.com/feast-dev/feast) | Python | Run `make compile-protos-python` to generate bindings |
15071
| [Main Feast Repository](https://github.com/feast-dev/feast) | Golang | Run `make compile-protos-go` to generate bindings |
151-
| [Feast Java](https://github.com/feast-dev/feast-java) | Java | No action required: bindings are generated automatically during compilation. |
152-

‎docs/project/new_branch_part_1.png‎

38.5 KB
Loading

‎docs/project/new_branch_part_2.png‎

141 KB
Loading

‎docs/project/new_branch_part_3.png‎

118 KB
Loading

‎docs/project/new_branch_part_4.png‎

108 KB
Loading

‎docs/project/new_branch_part_5.png‎

71.4 KB
Loading

0 commit comments

Comments
 (0)