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
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

blank_issues_enabled: true
contact_links:
- name: Ask on Discord
url: https://discord.gg/apache-iggy
about: Questions about using Iggy, or about what belongs on the Powered By page.
- name: Dev mailing list
url: https://lists.apache.org/list.html?dev@iggy.apache.org
about: Project discussion, proposals and release coordination.
- name: Report a bug in Iggy itself
url: https://github.com/apache/iggy/issues
about: This repository only tracks the website. Server, SDK and CLI issues go here.
133 changes: 133 additions & 0 deletions .github/ISSUE_TEMPLATE/organization-submission.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,133 @@
# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.

name: "Powered By Iggy submission"
description: "Add your organization or project to iggy.apache.org/powered-by"
title: "[Powered By] <organization or project name>"
labels: ["powered-by"]
body:
- type: markdown
attributes:
value: |
Thanks for telling the community what you are building on Apache Iggy.

Only the first three fields are required. Everything else is optional,
and an entry that is just a name and a link is perfectly normal.

**This issue is public.** Only put things here you are happy to see on
a public website.

- type: input
id: name
attributes:
label: Organization or project name
description: Exactly as it should be printed.
placeholder: Acme Inc
validations:
required: true

- type: input
id: website
attributes:
label: Website
placeholder: https://example.com
validations:
required: true

- type: dropdown
id: deployment_stage
attributes:
label: Deployment stage
description: >-
Recorded for the project's own understanding of adoption. The Powered
By page does not sort or label organizations by this.
options:
- Production
- Pilot / POC
- Evaluating
- Integration / community project
validations:
required: true

- type: input
id: use_case
attributes:
label: What are you using Apache Iggy for?
description: >-
A short phrase. Becomes the category shown above your description.
placeholder: Change data capture

- type: textarea
id: description
attributes:
label: Short description
description: >-
One to three sentences, in the third person. This is published as
written, so phrase it the way you want to be quoted. Leave it blank and
your entry appears in the logo wall without a write-up.
placeholder: >-
Acme Inc uses Apache Iggy as the transport behind its real-time
pricing engine, fanning market data out to pricing workers across three
regions.

- type: input
id: technologies
attributes:
label: Relevant technologies and integrations
description: Optional. Comma separated; rendered as tags.
placeholder: Rust SDK, PostgreSQL CDC, Apache Iceberg

- type: textarea
id: logo
attributes:
label: Logo
description: >-
Optional. Attach or link an SVG (preferred) or a transparent PNG at
least 400px wide. The site has a light and a dark theme, so two
variants are ideal. Supply one and the other theme shows your name as
text, which looks fine. We highly encourage your to submit the logo.

- type: input
id: case_study
attributes:
label: Public case study or blog post
description: Optional. A link we can point readers at.
placeholder: https://example.com/blog/why-we-chose-iggy

- type: input
id: contact
attributes:
label: Contact for follow-up
description: >-
Optional, and never published on the website. Note that this issue
itself is public, so if you would rather not post an address, leave
this blank -- a committer will reply in the thread, or you can email
dev@iggy.apache.org.

- type: checkboxes
id: confirmations
attributes:
label: Confirmations
options:
- label: >-
The information above is accurate and cleared for publication on a
public website.
required: true
- label: >-
I am authorized to grant the Apache Software Foundation permission
to display the logo above, and I grant it. (Only needed if you want
a logo shown -- entries without it are published as text.)
132 changes: 132 additions & 0 deletions content/organizations/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->

# Adding your organization to Powered By Iggy

[iggy.apache.org/powered-by](https://iggy.apache.org/powered-by) lists the
organizations, projects and teams building with Apache Iggy. It is maintained
by the community: every entry arrives as an issue or a pull request from the
people who run the system.

Production deployments, pilots, integrations and open source side projects are
all welcome. A team benchmarking Iggy against other streaming engines is as useful a data point
for the next reader as a fleet running it at scale.

## Two ways to submit

**Open an issue.** Use the
[Powered By Iggy submission form](https://github.com/apache/iggy-website/issues/new?template=organization-submission.yml).
Three required fields; a committer opens the pull request for you.

**Send the pull request yourself.**

1. Copy [`TEMPLATE.mdx`](TEMPLATE.mdx) to `content/organizations/<your-slug>.mdx`.
Use a lowercase hyphenated slug: `acme.mdx`.
2. Fill in the frontmatter. Delete every field you do not use.
3. Commit any logo files to `public/img/organizations/`.
4. Leave `draft: true`. A committer flips it to `false` once verified, and
that is what publishes the entry.
5. Open the PR. Conventional commit style, e.g.
`content(site): add Acme Inc to Powered By`.

Run `npm install && npm run dev`, then open <http://localhost:3000/powered-by>
to preview. Setting `draft: false` locally shows your entry; set it back to `draft: true`
before committing.

## How the page decides what to show

There are two levels, and the difference is whether you wrote a description.

| You supply | Where it appears |
| --- | --- |
| Name only | Logo wall, unlinked |
| Name + website | Logo wall, linked to your site |
| Name + logo | Logo wall, showing your logo |
| ...plus a `description` | Also gets a card in **How Iggy is being used**, and the wall tile links to it |

There is deliberately no way to get a use-case card without writing a real
description. Generated filler such as "Acme runs Apache Iggy in production" is
not published: it tells a reader nothing, and a page of it reads as marketing.
If all you can share is that you use Iggy, the logo wall is the right home and a
complete answer.

## Field reference

| Field | Required | Notes |
| --- | --- | --- |
| `name` | yes | Printed exactly as written. |
| `website` | yes | Omit rather than guess; the tile renders unlinked. |
| `deploymentStatus` | yes | `production`, `pilot`, `evaluating` or `integration`. Not shown on the page. |
| `useCaseCategory` | no | Short phrase, e.g. `Observability, AI Infrastructure`. |
| `description` | no | One to three sentences, third person. Promotes the entry into the use-case section. |
| `technologies` | no | List of short strings, rendered as tags. |
| `caseStudyUrl` | no | Public write-up to link. |
| `quote` / `quoteAuthor` | no | Attributed pull quote. |
| `logo` | no | Artwork legible on a **light** background. |
| `logoDark` | no | Artwork legible on a **dark** background. |
| `permissionConfirmed` | no | Defaults to `false`. **No logo renders until this is `true`.** |
| `draft` | no | Defaults to `true`. Committers publish by setting `false`. |
| `submittedBy` | no | GitHub handle, so committers know who to follow up with. |

Anything below the frontmatter is maintainer notes. It is not rendered, but it
is still MDX: a bare `<` starts a JSX tag and fails the build. Write links as
`[text](url)` rather than `<https://example.com>`, and wrap placeholders like
`<name>` in backticks.

### Logos and the two themes

A single logo usually works in only one theme. Supply artwork for whichever
backgrounds you have; the other theme falls back to your name as text, and
plenty of entries are text-only by choice.

SVG is preferred; a transparent PNG at least 400px wide is fine. Tiles cap
logos at roughly 144x36px, so wordmarks read better than tall lockups.

The build checks that the file named in the frontmatter actually exists in
`public/`. A missing file falls back to text rather than shipping a broken
image, so a PR can safely land the frontmatter and the artwork separately.

### Logo permission

`permissionConfirmed` is not a formality. Setting it to `true` is your
statement that you are authorized to grant the ASF permission to display your
mark on iggy.apache.org. Reviewers will ask who confirmed it.

Adding an organization you do not work for? Leave it `false` and say so in the
PR. Someone from that organization can grant permission in a follow-up.

## What committers check before publishing

- The submission comes from the organization, or the PR says who confirmed it.
- Any `description` describes real usage and reads as a record, not an advert.
- `permissionConfirmed` is `true` only where permission was actually granted.
- Logo files are committed to the repo, not hotlinked.
- No field was filled in by guessing. An empty field is always better.

Entries go stale. If something listed here is no longer accurate, open an
issue or a PR: removing an entry needs no more justification than adding one.

## Trademark note

Company names, product names and logos are the property of their respective
owners. Inclusion on the Powered By page does not imply that the ASF endorses
any listed organization, or that any listed organization endorses Apache Iggy
beyond the description it submitted. See the
[ASF trademark policy](https://www.apache.org/foundation/marks/) for how
Apache marks themselves may be used.
Loading
Loading