website/adopters
Shubham Jain adbdd9fc75 Add HybridK8s to adopters
Signed-off-by: Shubham Jain <shubhamkjain@outlook.com>
2021-06-04 11:20:55 +05:30
..
logos Add HybridK8s to adopters 2021-06-04 11:20:55 +05:30
1-flux-v2.yaml Add HybridK8s to adopters 2021-06-04 11:20:55 +05:30
2-flagger.yaml Add HybridK8s to adopters 2021-06-04 11:20:55 +05:30
3-flux-v1.yaml Add NetHunt logo to adopters. 2021-06-01 10:41:31 +03:00
README.md expand adopters instructions a little, make markdownlint happy 2021-05-11 17:27:16 +02:00

README.md

Flux Adopters

So you and your organisation are using Flux? That's great. We would love to hear from you! 💖

Adding yourself

Each YAML file in this directory lists the organisations who adopted the specific project in production. So if you use

  • Flux v2 or the GitOps Toolkit controllers, you are looking for 1-flux-v2.yaml
  • Flagger, it's 2-flagger.yaml
  • Flux v1 or Helm Operator, take a look at 3-flux-v1.yaml

You just need to add an entry for your company and upon merging it will automatically be added to our website.

To add your organisation follow these steps:

  1. Fork the fluxcd/website repository.

  2. Clone it locally with git clone https://github.com/<YOUR-GH-USERNAME>/website.git.

  3. (Optional) Add the logo of your organisation to adopters/logos. Good practice is for the logo to be called e.g. <company>.png.

  4. Find the right adopters/<project>.yaml file as indicated above.

  5. Add an entry to the YAML file with the name of your organisation, url that links to its website, and the path to the logo. Example:

        - name: Xenit
          url: https://xenit.se/
          logo: logos/xenit.png
    

    You can just add to the end of the file, we already sort alphabetically by name of organisation.

  6. Save the file, then do git add -A and commit using git commit -s -m "Add MY-ORG to adopters" (commit signoff is required, see DCO).

  7. Push the commit with git push origin main.

  8. Open a Pull Request to fluxcd/website and a preview build will turn up.

Thanks a lot for being part of our community - we very much appreciate it!

Addendum

/adopters/logo/logo-generic.png is a slightly modified Flux logo, it is used when no organisation logo is provided.