Merge branch 'opea-project:main' into chun_rfc

.github/CODEOWNERS

@@ -0,0 +1 @@
+* [email protected] [email protected] [email protected] [email protected] [email protected] [email protected] [email protected]

.gitignore

@@ -1 +1,2 @@
 _build
+.vscode

.known-issues/sphinx.conf

@@ -13,8 +13,14 @@
 #
 ^.*WARNING: toctree contains reference to document .*that doesn't have a title: no link will be generated$
 # ignore intradoc targets
-#^.*WARNING: 'myst' cross-reference target not found: '[-a-zA-Z0-9]*' \[myst.xref_missing\]$
 # let's ignore all missing targets for now
 ^.*WARNING: 'myst' cross-reference target not found: '[^\']*' \[myst.xref_missing\]$
-# need to ignore .md files not is a toc tree for now too
+#
+^.*WARNING: local id not found in doc .* \[myst.xref_missing\]$
+# ignore .md files not is a toc tree (used this temporarily)
 #^.*md: WARNING: document isn't included in any toctree$
+#
+# Mermaid config options
+^.*WARNING: 'mermaid': Unknown option keys: .*\[myst.directive_option\]$
+# Ignore unknown pygments lexer names
+^.*WARNING: Pygments lexer name .* is not known$

README.md

@@ -2,7 +2,7 @@
 
 **Mission**: Create an open platform project that enables the creation of open, multi-provider, robust, and composable GenAI solutions that harness the best innovation across the ecosystem.
 
-OPEA sites within the Linux Foundation AI & Data Organization:
+Here are useful OPEA sites within the Linux Foundation AI & Data Organization:
 
 * Website: [https://opea.dev](https://opea.dev)
 * X/Twitter: [https://twitter.com/opeadev](https://twitter.com/opeadev)
@@ -12,11 +12,15 @@ OPEA sites within the Linux Foundation AI & Data Organization:
 
 The OPEA platform includes:
 
-- Detailed framework of composable building blocks for state-of-the-art generative AI systems including LLMs, data stores, and prompt engines
-- Architectural blueprints of retrieval-augmented generative AI component stack structure, and end-to-end workflows
-- A four-step assessment for grading generative AI systems around performance, features, trustworthiness, and enterprise-grade readiness
+- Composable building blocks for state-of-the-art generative AI systems
+  including LLMs, data stores, and prompt engines
+- Architectural blueprints of retrieval-augmented generative AI end-to-end workflows
+- A four-step assessment for grading generative AI systems around performance,
+  features, trustworthiness, and enterprise-grade readiness
 
-Check out the [LF AI & Data Press Release](https://lfaidata.foundation/blog/2024/04/16/lf-ai-data-foundation-launches-open-platform-for-enterprise-ai-opea-for-groundbreaking-enterprise-ai-collaboration/) and [Intel's blog post](https://www.intel.com/content/www/us/en/developer/articles/news/introducing-the-open-platform-for-enterprise-ai.html).
+Check out the
+[LF AI & Data Press Release](https://lfaidata.foundation/blog/2024/04/16/lf-ai-data-foundation-launches-open-platform-for-enterprise-ai-opea-for-groundbreaking-enterprise-ai-collaboration/) and
+[Intel's blog post](https://www.intel.com/content/www/us/en/developer/articles/news/introducing-the-open-platform-for-enterprise-ai.html).
 
 ## Technical Steering Committee
 

community/CONTRIBUTING.md

@@ -3,27 +3,6 @@
 Thanks for considering contributing to OPEA project. The contribution process is similar with other open source projects on Github, involving an amount of open discussion in issues and feature requests between the maintainers, contributors and users.
 
 
-## Table of Contents
-
-<!-- toc -->
-
-- [All The Ways to Contribute](#all-the-ways-to-contribute)
-  - [Community Discussions](#community-discussions)
-  - [Documentations](#documentations)
-  - [Reporting Issues](#reporting-issues)
-  - [Proposing New Features](#proposing-new-features)
-  - [Submitting Pull Requests](#submitting-pull-requests)
-    - [Create Pull Request](#create-pull-request)
-    - [Pull Request Checklist](#pull-request-checklist)
-    - [Pull Request Template](#pull-request-template)
-    - [Pull Request Acceptance Criteria](#pull-request-acceptance-criteria)
-    - [Pull Request Status Checks Overview](#pull-request-status-checks-overview)
-    - [Pull Request Review](#pull-request-review)
-- [Support](#support)
-- [Contributor Covenant Code of Conduct](#contributor-covenant-code-of-conduct)
-
-<!-- tocstop -->
-
 ## All The Ways To Contribute
 
 ### Community Discussions
@@ -57,7 +36,11 @@ It is not necessary for changes like:
 
 #### Step-by-Step guidelines
 
-- Follow the [RFC Template](./rfc_template.md) to propose your idea.
+- Follow this RFC Template to propose your idea (found in the docs repo community/rfcs/rfc_template.txt):
+
+  ```{literalinclude} rfcs/rfc_template.txt
+  ```
+
 - Submit the proposal to the `Issues` page of the corresponding OPEA github repository.
 - Reach out to your RFC's assignee if you need any help with the RFC process.
 - Amend your proposal in response to reviewer's feedback.
@@ -80,7 +63,11 @@ If you are new to GitHub, view the pull request [How To](https://help.github.com
 
 #### Pull Request Template
 
-See [PR template](./pull_request_template.md)
+When you submit a PR, you'll be presented with a PR template that looks
+something like this:
+
+```{literalinclude} pull_request_template.txt
+```
 
 #### Pull Request Acceptance Criteria
 

community/TSC.rst

@@ -0,0 +1,51 @@
+Technical Steering Committee (TSC)
+##################################
+
+As defined in the :doc:`OPEA Charter <charter>`, the Technical Steering
+Committee is responsible for all technical oversight of the OPEA project
+including:
+
+* coordinating the technical direction of the OPEA project;
+* approving project or system proposals
+* creating committees or working groups (for example, an executive or
+  architectural committee or end-user advisory committee) to support the
+  OPEA project;
+* appointing representatives to work with other open source or open standards
+  communities;
+* establishing community norms, workflows, issuing releases, and security issue
+  reporting policies;
+* approving and implementing policies and processes for contributing
+* discussions, seeking consensus, and where necessary, voting on technical
+  matters relating to the code base that affect multiple sub-projects;
+* coordinating any marketing, events, or communications regarding the OPEA project.
+
+Refer to the :doc:`OPEA Charter <charter>` for more details.
+
+Technical Steering Committee Members
+************************************
+
+.. list-table:: TSC Members (as of September 6, 2024)
+   :header-rows: 1
+
+   * - TSC Member Name
+     - Member's Title and Company
+   * - `Malini Bhandaru <https://www.linkedin.com/in/malinibhandaru/>`_ (Chair)
+     - Senior Principal Engineer, Intel
+   * - `Amr Abdelhalem <https://www.linkedin.com/in/amrhalem/>`_
+     - SVP, Head of Cloud Platforms, Fidelity
+   * - `Nathan Cartwright <https://www.linkedin.com/in/nathan-cartwright-2008228/>`_
+     - Chief Architect - AI, CDW
+   * - `Justin Cormack <https://www.linkedin.com/in/justincormack/>`_
+     - CTO, Docker
+   * - `Ke Ding <https://www.linkedin.com/in/dingke/>`_
+     - Senior Prinicipal AI Engineer, Intel
+   * - Steve Grubb
+     - Senior Principal Engineer, Red Hat
+   * - `Robert Hafner <https://www.linkedin.com/in/roberthafner/>`_
+     - Senior Principal Architect, Comcast
+   * - `Melissa Mckay <https://www.linkedin.com/in/melissajmckay/>`_
+     - Head of Developer Relations, JFrog
+   * - `Logan Markewich <https://www.linkedin.com/in/logan-markewich/>`_
+     - Founding Software Developer, LlamaIndex
+   * - `Nick Ni <https://www.linkedin.com/in/nick-ni-5a204b20/>`_ (Interim)
+     - Senior Director Ai Product Management, AMD

community/codeowner.md

@@ -0,0 +1,28 @@
+# OPEA Project Code Owners
+
+These tables list the GitHub code owners, as found in the CODEOWNERS file in the
+corresponding OPEA repository. Code owners are responsible for code and
+documentation in a repository. They are automatically requested for
+review when someone opens a pull request (PR) that modifies code or
+documentation that they own.
+
+Select or contact the corresponding area owner for a PR review or questions
+about content within a repository.
+
+<!-- codeowners.txt is generated at docbuild time from the CODEOWNERS files from each repo -->
+```{include} codeowners.txt
+```
+
+-----
+
+## GenAIInfra
+
+* mkbhanda, irisdingbj, jfding, ftian1, yongfengdu
+
+## Continuous Integration (CICD) owners
+
+CI/CD processing is defined and managed by these owners:
+
+* chensuyue, daisy-ycguo, ashahba, preethivenkatesh
+
+

community/index.rst

@@ -30,7 +30,7 @@ support systems:
 * **Source Code in GitHub**: OPEA Project source code is maintained on a
   public GitHub repository at https://github.com/opea-project.
   You'll find information about getting access to the repository and how to
-  contribute to the project in this `Contribution Guide`_ document.
+  contribute to the project in this :doc:`Contribution Guide <CONTRIBUTING>`.
 
 * **Documentation**: Project technical documentation is developed
   along with the project's code, and can be found at
@@ -43,9 +43,6 @@ support systems:
 * **Mailing List**: TBD
 
 
-.. _Contribution Guide: https://opea-project.github.io/latest/community/CONTRIBUTING.html
-
-
 Contributing Guides
 *******************
 
@@ -54,11 +51,11 @@ Contributing Guides
 
    ../README
    CONTRIBUTING
-   ../codeowner
+   codeowner
    SECURITY
    ../developer-guides/doc_guidelines
-   ../developer-guides/graphviz
    ../developer-guides/docbuild
+   ../developer-guides/graphviz
 
 Roadmaps
 ********
@@ -77,18 +74,10 @@ Project Governance
    :maxdepth: 1
 
    charter
+   TSC
    CODE_OF_CONDUCT
    SECURITY
 
-Technical Steering Committee
-****************************
-
-.. toctree::
-   :maxdepth: 1
-
-   TSC_Gives_and_gets
-
-
 RFC Proposals
 *************
 

community/pull_request_template.txt

@@ -1,10 +1,9 @@
-# OPEA Pull Request Template
-
 ## Description
 
 The summary of the proposed changes as long as the relevant motivation and context.
 
 ## Issues
+
 List the issue or RFC link this PR is working on. If there is no such link, please mark it as `n/a`.
 
 ## Type of change
@@ -14,12 +13,12 @@ List the type of change like below. Please delete options that are not relevant.
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds new functionality)
 - [ ] Breaking change (fix or feature that would break existing design and interface)
+- [ ] Others (enhancement, documentation, validation, etc.)
 
 ## Dependencies
 
 List the newly introduced 3rd party dependency if exists.
 
 ## Tests
 
-Describe the tests that you ran to verify your changes. Please list the relevant details for your test configuration and step-by-step reproduce instructioins.
-
+Describe the tests that you ran to verify your changes.