Skip to content
Beta

Contributor Profile Registration Guide

In 1 trail

Last updated on

Work in the STACKIT Cloud Framework is attributed to a contributor, and a contributor is a profile page. These profiles control the dynamic rendering inside the interactive SCFContributorExplorer component and establish an explicit link between technical asset containers and the contributing organizations.

That does not mean everyone needs a page of their own. There are two ways in, and the right one depends on whether a company stands behind the work:

  • An organization contributes. Register it here. It earns its own page, a portfolio that collects every asset and trail it brings, and, once Framework Core has recorded the brand consent, its logo on every card. This guide is about that case.
  • A person contributes in their own name. Use the shared open-contributors entry instead of inventing an organization. Nothing else changes: assets and trails are filed under assetcontainer/open-contributors/ exactly as they would be anywhere else, and the same review applies. Because the entry is shared it carries no company mark, and the maintainers block on each page is what credits the individual — name yourself there with user: your.username.

Switching later is only a matter of moving the files: register the organization when it appears, and the pages move into its container.


The registration of a new contributor profile requires strict compliance with the STACKIT Cloud Framework repository conventions to protect responsive layouts on mobile screen sizes.

  • Profile Location: Create the contributor profile as an MDX file under the following exact repository path:
apps/docs/src/content/docs/contributors/[partner-slug].mdx
  • Asset Directory: Store all profile-specific media assets within a matching subfolder:
apps/docs/src/content/docs/contributors/[partner-slug]/

Each theme carries its own file, and a theme without one shows a placeholder mark instead of borrowing the other. A logo drawn for white paper disappears on our dark surfaces, so we no longer stretch one file across both.

  • Dark mode logo: logo.png or logo.svg in the partner-specific subdirectory, 1:1 square aspect ratio. This is the file shown on the dark theme.
  • Light mode logo: light-logo.png or light-logo.svg, same folder and format rules. If your mark works on both grounds, supply the same artwork under both names.
  • What happens if one is missing: the theme without a file shows a neutral placeholder with your initials, never another company’s logo. Send the missing variant and it replaces the placeholder on the next build.

Technical Authoring & RAG Optimization Rules

Section titled “Technical Authoring & RAG Optimization Rules”

To guarantee flawless compilation and high semantic visibility for automated Enterprise RAG indexers, follow these strict content design tokens:

  • SEO Recommendation: Write a real, concise summary into the frontmatter description field and aim for 120 to 160 characters: enough to say what the page offers. The card shows all of it. The window is rewarded with a ranking bonus rather than enforced: missing it costs the bonus and nothing else, and the pipeline only warns below 120 or above 180 characters. A missing description, a stub, or a placeholder fails the pipeline.
  • Lead-Term Pattern: All listings regarding competencies or core tech stacks must utilize the - **Lead term**: Explanation sentence. pattern to enforce HTML definition list rendering.
  • Context Splitting Prevention: Avoid using vague pronouns such as “it”, “they”, or “the platform”. Always explicitly state the partner name or the specific STACKIT service to keep vector database chunks completely self-contained.

Production Blueprint Example: Mockup Company

Section titled “Production Blueprint Example: Mockup Company”

The following block represents a fully compliant reference implementation for a contributor profile. The layout utilizes the centralized <ScfContributorHeader /> component to automatically render brand marks and badges matching design system standards, replacing manual inline styling blocks.

---
title: "Mockup Company Inc."
description: "Official partner profile of Mockup Company Inc. – Specializing in sovereign cloud consulting, STACKIT infrastructure, and fully automated DevOps pipelines."
sidebar:
hidden: true
---
<ScfContributorHeader title="Mockup Company Inc." badge="Consulting Partner" />
## Company Profile
Mockup Company Inc. guides organizations through the migration, modernization, and operation of workloads in sovereign cloud environments. As a core contributor to the STACKIT Cloud Framework, Mockup Company Inc. focuses on production-ready enterprise architectures, cloud automation, and compliance-driven cloud-native solutions.
## Consultant Profile
### Key Facts
- **Consultant Role**: Senior Cloud Consultant specializing in enterprise architecture.
- **Cloud Experience**: More than 4 years of dedicated project engineering experience.
- **Schwarz Gruppe History**: 8 years of total group experience including 2 years within the STACKIT ecosystem.
- **Academic Education**: Master of Science (M.Sc.) in Media Informatics.
### Technical Core Competencies
#### Cloud Platforms & Managed Services
- **STACKIT SKE**: Design, provisioning, and orchestration of production-ready managed Kubernetes clusters.
- **STACKIT Cloud Foundry**: Deployment, scaling, and lifecycle management of cloud-native applications.
- **Sovereign Cloud Compliance**: Architectural consulting aligned with Schwarz Gruppe governance and security directives.
#### Infrastructure as Code (IaC) & Automation
- **Terraform Automation**: Declarative provisioning and versioning of STACKIT resources including projects, networks, compute, and SKE.
- **Bash Scripting**: Automation of system processes, OS template preparation, and CI utility scripts.
#### DevOps, CI/CD & Tooling
- **Pipelining Engines**: Conception and implementation of robust CI/CD tracks for automated quality assurance and continuous deployment.
- **Docker Runtimes**: Construction of standardized container images and configuration of secure container runtimes.
- **Git Versioning**: Structured version control utilizing Git-Flow and Trunk-Based Development within distributed engineering teams.

Live Component Playground (local dev server)

Section titled “Live Component Playground (local dev server)”

Run the docs locally (VS Code task 🥾 Hike — Start Dev Docs, or the hike command in the container terminal, served on http://localhost:4321) and open the interactive playgrounds below. Each renders the component live and documents its configuration options:

  • Contributor Loader — every prop (showSearch, contributorIds) with default and pre-filtered examples: http://localhost:4321/demo/components/demo-scf-contributor-loader
  • Logo resolution — how folder-based logo.png / light-logo.svg brand marks resolve per theme, and what the placeholder looks like when one is missing: http://localhost:4321/demo/components/demo-scf-logos

Asset historyActive 10 of the last 12 weeksTMUpdatedNo updates · 1 bar = 1 week i
Maintainers
TMTobias M.Head of STACKIT Cloud Framework · STACKITOwnerActive 12 of the last 12 weeks · 168 updatesSTACKITwww.linkedin.com/in/tobias-müller-011304172??Name not publicThe Cloud Framework team knows who this is. The name is not shown on the site.Contributed in STACKIT
Show full history (12 more)