Skip to content

Commit 299e1b0

Browse files
committed
Initial contributor page
Add initial version of the page for new contributors Signed-off-by: Alex Ellis (VMware) <[email protected]>
1 parent 60173ac commit 299e1b0

File tree

2 files changed

+52
-0
lines changed

2 files changed

+52
-0
lines changed

docs/contributing/get-started.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
## Contribute to the project
2+
3+
There are many ways to contribute to the OpenFaaS project.
4+
5+
Before raising a PR or an issue request that you read our [Contributing guide](https://github.com/openfaas/faas) which applies to every OpenFaaS GitHub repository. We have a wide range of suggestions for contributing to the project and community and only some of those involve writing code.
6+
7+
### Five practical ideas for a first contribution
8+
9+
* Try the [workshop](https://github.com/openfaas/workshop)
10+
11+
* Read the [architecture diagrams](https://docs.openfaas.com/architecture/gateway/)
12+
13+
* Submit a function to the [Function Store](https://github.com/openfaas/store)
14+
15+
* Write a blog post and add it to our [community listing](https://docs.openfaas.com/community/#community-resources)
16+
17+
* Improve the [OpenFaaS CLI tooling](https://github.com/openfaas/faas-cli) with a PR or documentation
18+
19+
### Main Git repositories
20+
21+
Git is used for version control and all repositories are public available under two organisations.
22+
23+
#### OpenFaaS
24+
25+
OpenFaaS started as a single mono-repo called `faas` and has been broken out into separate repositories. For this reason you should always collate Issues, PRs, contributor counts, stars and similar statistics from the organisation as a whole. The data in the `faas` repo is not representive of the whole project.
26+
27+
| Repository | Headline |
28+
|------------------|---------------------------------|
29+
| faas | Main repository for project issues, suggestions, documentation and roadmap/backlog items. Also includes UI portal and API gateway |
30+
| 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 |
31+
| faas-swarm | Docker Swarm provider for OpenFaaS contains a stack file for deployment |
32+
| faas-netes | Kubernetes provider for OpenFaaS contains YAML and helm for deployment |
33+
| faas-cloud | An incubator project for a closed-loop CI/CD system between GitHub and OpenFaaS |
34+
| faas-cli | CLI for operating with OpenFaaS similar to `kubectl` or `docker` CLI |
35+
| templates | Official templates for OpenFaaS CLI used to scaffold a new function |
36+
| media | Press-kit and media for the project branding and swag |
37+
| docs | Official docs repository for this site - i.e. https://docs.openfaas.com |
38+
| workshop | Hands-on training lab for learning OpenFaaS |
39+
| nats-queue-worker | Asynchronous processing for deferred / queued work with OpenFaaS, based upon NATS Streaming |
40+
| www | Webpages for https://www.openfaas.com |
41+
42+
https://github.com/openfaas/
43+
44+
#### OpenFaaS-Incubator
45+
46+
The incubator organisation is for experiments, research and for getting quick feedback. Only some of the projects incubated here will make it into the main project.
47+
48+
https://github.com/openfaas-incubator/
49+

mkdocs.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -121,3 +121,6 @@ pages:
121121
- Gateway: ./architecture/gateway.md
122122
- Watchdog: ./architecture/watchdog.md
123123
- Autoscaling: ./architecture/autoscaling.md
124+
- Contributing:
125+
- Get Started: ./contributing/get-started.md
126+

0 commit comments

Comments
 (0)