Jump to content

Template:Service

From Wikitech


Template documentation

Usage

Copy and paste the following code into your page:

{{Service
| name = 
| logo = 
| type = 
| status = 
| team = 
| contact = 
| language = 
| framework = 
| dependencies = 
| service_url = 
| repo = 
| helm_chart = 
| helmfile_path = 
| service_port = 
| kubernetes_cluster = 
| phabricator = 
| dashboards = 
| runbook = 
| documentation = 
| license = 
}}

Examples

MediaWiki Service Example

{{Service
| name = WikiKot
| type = MediaWiki service
| status = Production
| team = WikiKot Team
| contact = wikikot-team@wikimedia.org
| language = PHP
| dependencies = mw-api-int
| service_url = https://wikikot.discovery.wmnet:45152/_info
| repo = [[gerrit:plugins/gitiles/mediawiki/extensions/WikiKot]]
| helm_chart = mediawiki
| helmfile_path = helmfile.d/services/wikikot
| service_port = 3078
| kubernetes_cluster = eqiad, codfw
| phabricator =  wikikot
| dashboards = [https://grafana.wikimedia.org/d/wikikot Grafana Dashboard]
| runbook = https://wikitech.wikimedia.org/wiki/WikiKot#Runbook
| documentation = https://www.mediawiki.org/wiki/Extension:WikiKot
| license = GPL-2.0-or-later
}}


MediaWiki Library Example

{{Service
| name = Parsoid
| type = MediaWiki Library
| logo = Parsoid word logo.svg
| status = Production
| team = Parsing Team
| description = A bidirectional runtime wikitext parser. Converts back and forth between wikitext and HTML/XML DOM with RDFa.
| contact = parsing-team@wikimedia.org
| language = PHP
| dependencies = MediaWiki
| repo = [[gerrit:plugins/gitiles/mediawiki/services/parsoid/]]
| phabricator =  parsoid
| documentation = https://www.mediawiki.org/wiki/Parsoid
| license = GPL-2.0-or-later
}}

Parameters

All parameters are optional. Fields left blank will not be displayed in the infobox.

  • name: Display name (defaults to page title if not specified)
  • logo: Optional logo or icon (defaults to Mediawiki_logo_-_proposed.svg)
  • type: Type of application - "MediaWiki service", "MediaWiki library", or "Service"
  • status: Lifecycle status - "Production", "Testing", "Deprecated", "Archived", or "Development"
  • team: Owning or responsible team
  • contact: Contact email, mailing list, or person
  • language: Primary programming language(s) used
  • framework: Framework(s) used
  • dependencies: Key services or components this depends on
  • service_url: Public or internal service address
  • repo: Link to the code repository
  • helm_chart: Chart name or path in deployment-charts
  • helmfile_path: Path under helmfile.d for this deployment
  • service_port: Port exposed by the service
  • kubernetes_cluster: Cluster where the service runs
  • phabricator: Phabricator project or task link
  • dashboards: Monitoring dashboards (e.g., Grafana links)
  • runbook: Link to the operational runbook
  • documentation: Link to additional documentation
  • license: Software license

A lightweight infobox for applications and services on Wikitech.

Template parameters[Edit template data]

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Namename

Display name (defaults to page title)

Default
Stringoptional
Logologo

Optional logo or icon image (defaults to Mediawiki_logo_-_proposed.svg)

Fileoptional
Typetype

Type of application or service

Suggested values
MediaWiki service MediaWiki library Service
Stringsuggested
Statusstatus

Lifecycle status of the service or application

Suggested values
Production Testing Deprecated Archived Development
Stringsuggested
Teamteam

Owning or responsible team

Stringsuggested
Contactcontact

Contact email, list, or person

Stringsuggested
Languagelanguage

Primary programming language(s) used

Example
Python, JavaScript
Stringoptional
Frameworkframework

Framework(s) used (e.g., Flask, Vue.js, React)

Stringoptional
Dependenciesdependencies

Key services or components this depends on

Stringoptional
Service URLservice_url

Public or internal service address

URLoptional
Repositoryrepo

Link to the code repository (e.g., Gerrit, GitLab, GitHub)

URLsuggested
Helm charthelm_chart

Chart name or path in deployment-charts

Stringoptional
Helmfile pathhelmfile_path

Path under helmfile.d for this deployment

Stringoptional
Service Portservice_port

Port exposed by the service

Numberoptional
Kubernetes Clusterkubernetes_cluster

Cluster where the service runs

Example
wikikube
Stringoptional
Phabricatorphabricator

Phabricator project or task link

URLoptional
Dashboardsdashboards

Monitoring dashboards (e.g., Grafana links)

Stringoptional
Runbookrunbook

Link to the operational runbook or troubleshooting guide

URLsuggested
Documentationdocumentation

Link to additional documentation

URLoptional
Licenselicense

Software license

Example
GPL-2.0-or-later, Apache-2.0
Stringoptional