FAQ
| This is a
LIVE
service |
Changelog
Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
D
DevOps Division Guidebook
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Iterations
Wiki
Requirements
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Locked files
Build
Pipelines
Jobs
Pipeline schedules
Test cases
Artifacts
Deploy
Releases
Package registry
Container Registry
Model registry
Operate
Environments
Terraform modules
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Code review analytics
Issue analytics
Insights
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Terms and privacy
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Information Services
DevOps
General Documentation
DevOps Division Guidebook
Commits
656d68c2
Commit
656d68c2
authored
4 years ago
by
Monty Dawson
Committed by
Richard Peach
4 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Initial service documentation template
parent
4f124816
No related branches found
Branches containing commit
No related tags found
Tags containing commit
1 merge request
!53
Initial service documentation template
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
docs/services/service-template.md
+93
-0
93 additions, 0 deletions
docs/services/service-template.md
with
93 additions
and
0 deletions
docs/services/service-template.md
0 → 100644
+
93
−
0
View file @
656d68c2
This page gives an overview of the
`<service_name>`
, describing its current status, where and
how it's developed and deployed, and who is responsible for maintaining it.
## Service Description
`<high level description of what the service does>`
## Service Status
The
`<service_name>`
is currently
`pre alpha|alpha|beta|live|decommissioning`
.
`<notes about status and links to roadmaps / timelines for future development or decommissioning>`
## Contact
Technical queries and support should be directed to
`<role email>`
and will be picked up
by a member of the team working on the service. To ensure that you receive a response, always
direct requests to
`<role email>`
rather than reaching out to team members directly.
Issues discovered in the service or new feature requests should be opened as GitLab issues
`[here](<link to gitlab issues page>)`
## Environments
The
`<service_name>`
is currently deployed to the following environments:
| Name | URL | Supporting VMs |
| ----------- | ------------------ | --------------- |
| Production |
`<production_url>`
|
`<list of vms>`
|
| Staging |
`<staging_url>`
|
`<list of vms>`
|
| Development |
`<dev_url>`
|
`<list of vms>`
|
`<notes about access to environments and anything special about how an environment is used>`
## Source code
The source code for the
`<service_name>`
is spread over the following repositories:
| Repository | Description
| ----------- | ------------------ |
|
[
Application Server
](
)
| The source code for the main application server |
|
[
Infratructure
](
)
| The Terraform infrastructure code for deploying the application server to GCP |
## Technologies used
The following gives an overview of the
`<service_name>`
is built on.
| Category | Language | Framework(s) |
| -------- | -------- | --------- |
| Server | {name and version} | {name and version} |
| Client | {name and version} | {name and version} |
| {other} | {name and version} | {name and version} |
## Operational documentation
The following gives an overview of how the
`<service_name>`
is deployed and maintained
### How and where the `<service_name>` is deployed
`<documentation or links to external docs describing how and where the application is deployed>`
### Deploying a new release
`<documentation or links to external docs about how a new release is made and deployed>`
### Monitoring
`<documentation or links to external docs about monitoring and how alerts should be responded to>`
### Debugging
`<documentation or links to external docs describing how to debug both a deployed instance and locally>`
### `<other operation issues>`
`<documentation or links to external docs about other operation issues>`
## Service Management and tech lead
The
**service owner**
for the
`<service_name>`
is
`<service owner name and Lookup link>`
.
The
**service manager**
for the
`<service_name>`
is
`<service manager name and Lookup link>`
.
The
**tech lead**
for the
`<service_name>`
is
`<tech lead name and Lookup link>`
.
The following engineers have operational experience with
`<service name>`
and are able to respond
to support requests or incidents:
*
`<engineer name and Lookup link>`
*
`<engineer name and Lookup link>`
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment