Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 1 addition & 63 deletions docs/contributing/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,66 +50,4 @@ Let the project team know in the #contributors channel on Slack.

### Main source repositories

All source is organised under two repositories on GitHub: openfaas and openfaas-incubator. Some prototyping may take place under the personal accounts of The [Members Team](https://github.com/orgs/openfaas/people).

#### OpenFaaS org

OpenFaaS started as a single mono-repo called `faas` and has been broken out into separate repositories in the [openfaas](https://github.com/openfaas/) organisation.

For this reason you should always collate statistics from the `openfaas` organisation, rather than the repository of a single component, which would provide invalid data. So whether counting issues, PRs, contributors, stars, or any other metric, use the whole organisation.

| Repository | Headline |
|:------------------|:---------------------------------|
| [certifier](https://github.com/openfaas/certifier) | End-to-end tests written in Go for verifying OpenFaaS with Swarm or Kubernetes after a release, this also runs through CI for the `faas` repo |
| [docs](https://github.com/openfaas/docs) | Official docs repository for this site - i.e. https://docs.openfaas.com |
| [faas](https://github.com/openfaas/faas) | Main repository for project issues, suggestions, documentation and roadmap/backlog items. Also includes UI portal and API gateway |
| [faas-netes](https://github.com/openfaas/faas-netes) | Kubernetes provider for OpenFaaS contains YAML and helm for deployment |
| [faas-swarm](https://github.com/openfaas/faas-swarm) | Docker Swarm provider for OpenFaaS contains a stack file for deployment |
| [faas-cli](https://github.com/openfaas/faas-cli) | CLI for operating with OpenFaaS similar to `kubectl` or `docker` CLI |
| [templates](https://github.com/openfaas/templates) | Official templates for OpenFaaS CLI used to scaffold a new function |
| [nats-queue-worker](https://github.com/openfaas/nats-queue-worker) | Asynchronous processing for deferred / queued work with OpenFaaS, based upon NATS Streaming |
| [media](https://github.com/openfaas/media) | Press-kit and media for the project branding and swag |
| [openfaas.github.io](https://github.com/openfaas/openfaas.github.io) | Source for https://www.openfaas.com and blog |
| [openfaas-cloud](https://github.com/openfaas/openfaas-cloud) | OpenFaaS Cloud - portable, multi-user Serverless Functions powered by GitOps |
| [workshop](https://github.com/openfaas/workshop) | Practical training and hands-on labs for learning OpenFaaS |

#### OpenFaaS Incubator

The [openfaas-incubator organisation](https://github.com/openfaas-incubator/) contains projects which are under active development.

Some people wrongly assume that the "incubator" organisation means that these projects have a special status, or that they are unsuitable for production. Projects that are unsuitable for production usage will say so in their readme file.

| Repository | Headline |
|:------------------|:---------------------------------|
| [of-watchdog](https://github.com/openfaas-incubator/of-watchdog) | The OpenFaaS watchdog re-written with mode-abstractions for both STDIO & HTTP |
| [faas-idler](https://github.com/openfaas-incubator/faas-idler) | Scale OpenFaaS functions to zero replicas after specified period of inactivity |
| [openfaas-operator](https://github.com/openfaas-incubator/openfaas-operator) | The OpenFaaS CRD Operator for Kubernetes |
| [kafka-connector](https://github.com/openfaas-incubator/kafka-connector) | The Kafka connector connects OpenFaaS functions to Kafka topics |
| [ofc-bootstrap](https://github.com/openfaas-incubator/ofc-bootstrap) | "one-click" CLI to install OpenFaaS Cloud on Kubernetes |
| [ingress-operator](https://github.com/openfaas-incubator/ingress-operator/) | Provides `FunctionIngress` CRD for Custom Domains on Kubernetes |
| [connector-sdk](https://github.com/openfaas-incubator/connector-sdk) | Build your own event connectors for OpenFaaS |
| [vcenter-connector](https://github.com/openfaas-incubator/vcenter-connector) | Trigger OpenFaaS Functions from events in VMware vCenter |
| [faas-federation](https://github.com/openfaas-incubator/faas-federation) | Federate two OpenFaaS installations into one API |
| [faas-memory](https://github.com/openfaas-incubator/faas-memory) | An OpenFaaS Provider example using memory for state. |

##### Training & tutorials

| Repository | Headline |
|:------------------|:---------------------------------|
| [workshop-vscode](https://github.com/openfaas-incubator/workshop-vscode) | Run a Kubernetes workshop with VSCode in the browser |
| [openfaas-linkerd2](https://github.com/openfaas-incubator/openfaas-linkerd2) | Lightweight Serverless on Kubernetes with mTLS and traffic-splitting with Linkerd2 |
| [openfaas-function-auth](https://github.com/openfaas-incubator/openfaas-function-auth) | Examples of authentication in OpenFaaS Serverless functions. |

##### Templates

| Repository | Headline |
|:------------------|:---------------------------------|
| [node10-express-template](https://github.com/openfaas-incubator/node10-express-template) | Node.js 10 Express template providing additional context and control over the HTTP response from your function |
| [node10-express-service](https://github.com/openfaas-incubator/node10-express-service) | Template with Node.js and Express.js exposed fully |
| [node8-express-template](https://github.com/openfaas-incubator/node8-express-template) | Node.js 8 template for OpenFaaS with HTTP via Express.js |
| [golang-http-template](https://github.com/openfaas-incubator/golang-http-template) | Golang template providing additional control over the HTTP request and response.|
| [powershell-http](https://github.com/openfaas-incubator/powershell-http-template) | PowerShell HTTP template |
| [ruby-http](https://github.com/openfaas-incubator/ruby-http) | A Ruby HTTP template for OpenFaaS |
| [python-flask-template](https://github.com/openfaas-incubator/python-flask-template) | OpenFaaS templates for Python 2.7/3.6 with Flask |
| [python3-debian](https://github.com/openfaas-incubator/python3-debian) | Template for Python3 on Debian for data-science / compiled pip modules |
| [perl-template](https://github.com/openfaas-incubator/perl-template) | Perl template for OpenFaaS |
All source is organised under two repositories on GitHub: openfaas and openfaas-incubator. Some prototyping may take place under the personal accounts of the [Members Team](https://github.com/orgs/openfaas/people). Please refer to the [Main Repositories](./contributing/main-repositories.md/) page for full details.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is /main-repositories.md/ correct? I haven't seen that syntax

@rgee0 rgee0 Oct 8, 2019 •

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i think the dot is wrong. ill fix

65 changes: 65 additions & 0 deletions docs/contributing/main-repositories.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
## Project source repositories

All source is organised under two repositories on GitHub: openfaas and openfaas-incubator. Some prototyping may take place under the personal accounts of the [Members Team](https://github.com/orgs/openfaas/people).

### OpenFaaS org

OpenFaaS started as a single mono-repo called `faas` and has been broken out into separate repositories in the [openfaas](https://github.com/openfaas/) organisation.

For this reason you should always collate statistics from the `openfaas` organisation, rather than the repository of a single component, which would provide invalid data. So whether counting issues, PRs, contributors, stars, or any other metric, use the whole organisation.

| Repository | Headline |
|:------------------|:---------------------------------|
| [certifier](https://github.com/openfaas/certifier) | End-to-end tests written in Go for verifying OpenFaaS with Swarm or Kubernetes after a release, this also runs through CI for the `faas` repo |
| [docs](https://github.com/openfaas/docs) | Official docs repository for this site - i.e. https://docs.openfaas.com |
| [faas](https://github.com/openfaas/faas) | Main repository for project issues, suggestions, documentation and roadmap/backlog items. Also includes UI portal and API gateway |
| [faas-netes](https://github.com/openfaas/faas-netes) | Kubernetes provider for OpenFaaS contains YAML and helm for deployment |
| [faas-swarm](https://github.com/openfaas/faas-swarm) | Docker Swarm provider for OpenFaaS contains a stack file for deployment |
| [faas-cli](https://github.com/openfaas/faas-cli) | CLI for operating with OpenFaaS similar to `kubectl` or `docker` CLI |
| [templates](https://github.com/openfaas/templates) | Official templates for OpenFaaS CLI used to scaffold a new function |
| [nats-queue-worker](https://github.com/openfaas/nats-queue-worker) | Asynchronous processing for deferred / queued work with OpenFaaS, based upon NATS Streaming |
| [media](https://github.com/openfaas/media) | Press-kit and media for the project branding and swag |
| [openfaas.github.io](https://github.com/openfaas/openfaas.github.io) | Source for https://www.openfaas.com and blog |
| [openfaas-cloud](https://github.com/openfaas/openfaas-cloud) | OpenFaaS Cloud - portable, multi-user Serverless Functions powered by GitOps |
| [workshop](https://github.com/openfaas/workshop) | Practical training and hands-on labs for learning OpenFaaS |

### OpenFaaS Incubator

The [openfaas-incubator organisation](https://github.com/openfaas-incubator/) contains projects which are under active development.

Some people wrongly assume that the "incubator" organisation means that these projects have a special status, or that they are unsuitable for production. Projects that are unsuitable for production usage will say so in their readme file.

| Repository | Headline |
|:------------------|:---------------------------------|
| [of-watchdog](https://github.com/openfaas-incubator/of-watchdog) | The OpenFaaS watchdog re-written with mode-abstractions for both STDIO & HTTP |
| [faas-idler](https://github.com/openfaas-incubator/faas-idler) | Scale OpenFaaS functions to zero replicas after specified period of inactivity |
| [openfaas-operator](https://github.com/openfaas-incubator/openfaas-operator) | The OpenFaaS CRD Operator for Kubernetes |
| [kafka-connector](https://github.com/openfaas-incubator/kafka-connector) | The Kafka connector connects OpenFaaS functions to Kafka topics |
| [ofc-bootstrap](https://github.com/openfaas-incubator/ofc-bootstrap) | "one-click" CLI to install OpenFaaS Cloud on Kubernetes |
| [ingress-operator](https://github.com/openfaas-incubator/ingress-operator/) | Provides `FunctionIngress` CRD for Custom Domains on Kubernetes |
| [connector-sdk](https://github.com/openfaas-incubator/connector-sdk) | Build your own event connectors for OpenFaaS |
| [vcenter-connector](https://github.com/openfaas-incubator/vcenter-connector) | Trigger OpenFaaS Functions from events in VMware vCenter |
| [faas-federation](https://github.com/openfaas-incubator/faas-federation) | Federate two OpenFaaS installations into one API |
| [faas-memory](https://github.com/openfaas-incubator/faas-memory) | An OpenFaaS Provider example using memory for state. |

### Training & tutorials

| Repository | Headline |
|:------------------|:---------------------------------|
| [workshop-vscode](https://github.com/openfaas-incubator/workshop-vscode) | Run a Kubernetes workshop with VSCode in the browser |
| [openfaas-linkerd2](https://github.com/openfaas-incubator/openfaas-linkerd2) | Lightweight Serverless on Kubernetes with mTLS and traffic-splitting with Linkerd2 |
| [openfaas-function-auth](https://github.com/openfaas-incubator/openfaas-function-auth) | Examples of authentication in OpenFaaS Serverless functions. |

### Templates

| Repository | Headline |
|:------------------|:---------------------------------|
| [node10-express-template](https://github.com/openfaas-incubator/node10-express-template) | Node.js 10 Express template providing additional context and control over the HTTP response from your function |
| [node10-express-service](https://github.com/openfaas-incubator/node10-express-service) | Template with Node.js and Express.js exposed fully |
| [node8-express-template](https://github.com/openfaas-incubator/node8-express-template) | Node.js 8 template for OpenFaaS with HTTP via Express.js |
| [golang-http-template](https://github.com/openfaas-incubator/golang-http-template) | Golang template providing additional control over the HTTP request and response.|
| [powershell-http](https://github.com/openfaas-incubator/powershell-http-template) | PowerShell HTTP template |
| [ruby-http](https://github.com/openfaas-incubator/ruby-http) | A Ruby HTTP template for OpenFaaS |
| [python-flask-template](https://github.com/openfaas-incubator/python-flask-template) | OpenFaaS templates for Python 2.7/3.6 with Flask |
| [python3-debian](https://github.com/openfaas-incubator/python3-debian) | Template for Python3 on Debian for data-science / compiled pip modules |
| [perl-template](https://github.com/openfaas-incubator/perl-template) | Perl template for OpenFaaS |
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -161,3 +161,4 @@ nav:
- Featured: ./tutorials/featured.md
- Contributing:
- Get Started: ./contributing/get-started.md
- Main Repositories: ./contributing/main-repositories.md