Skip to content

Commit

Permalink
Add docs for theia (#40)
Browse files Browse the repository at this point in the history
Signed-off-by: Yun-Tang Hsu <hsuy@vmware.com>
  • Loading branch information
yuntanghsu authored Jun 13, 2022
1 parent 51b6ae8 commit 27afadc
Show file tree
Hide file tree
Showing 6 changed files with 57 additions and 0 deletions.
3 changes: 3 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Community Code of Conduct

Project Theia follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md).
23 changes: 23 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1 +1,24 @@
# Developer Guide

Thank you for taking the time out to contribute to project Theia! Project Theia follows the [Antrea Developer Guide].
Also check out [Theia documents](docs) for more information about Theia.

## Notice

The following sections have different content from [Antrea Developer Guide]. Please read them carefully when referring
to [Antrea Developer Guide].

### GitHub Workflow

When following [Github Workflow in Antrea](https://github.com/antrea-io/antrea/blob/main/CONTRIBUTING.md#github-workflow),
please make sure to change the name of repository from `antrea` to `theia`.

### Getting your PR verified by CI

In Theia, we have only one trigger phrase for individual checks:

* `/theia-test-e2e`: Theia e2e tests

For more information about the tests we run as part of CI, please refer to [ci/README.md](ci/README.md).

[Antrea Developer Guide]: https://github.com/antrea-io/antrea/blob/main/CONTRIBUTING.md
10 changes: 10 additions & 0 deletions GOVERNANCE.md
Original file line number Diff line number Diff line change
@@ -1 +1,11 @@
# Theia Governance

Project Theia follows the [Antrea governance](https://github.com/antrea-io/antrea/blob/main/GOVERNANCE.md).

## Contributors

Anyone can contribute to the project (e.g. open a PR) as long as they follow the guidelines in [CONTRIBUTING.md](CONTRIBUTING.md).

## Maintainers

The list of current Theia maintainers can be found in [MAINTAINERS.md](MAINTAINERS.md).
11 changes: 11 additions & 0 deletions MAINTAINERS.md
Original file line number Diff line number Diff line change
@@ -1 +1,12 @@
# Theia Maintainers

This is the current list of maintainers for the Theia project. The maintainer
role is described in [GOVERNANCE.md](GOVERNANCE.md).

| Maintainer | GitHub ID | Affiliation |
|-------------------|--------------|-------------|
| Antonin Bas | antoninbas | VMware |
| Jianjun Shen | jianjuns | VMware |
| Quan Tian | tnqn | VMware |
| Salvatore Orlando | salv-orlando | VMware |
| Ziyou Wang | ziyouw | VMware |
2 changes: 2 additions & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
@@ -1 +1,3 @@
# Security Procedures

Project Theia follows the [Antrea security procedures](https://github.com/antrea-io/antrea/blob/main/SECURITY.md).
8 changes: 8 additions & 0 deletions ci/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Theia CI

Project Theia follows [Antrea CI](https://github.com/antrea-io/antrea/blob/main/ci/README.md).

## Notice

1. At the moment, we don't support integration tests in Theia.
2. For information about our Jenkins CI jobs, please see [here](jenkins/README.md).

0 comments on commit 27afadc

Please sign in to comment.