alexdemure/service-documentation

Template how service documentation in Readme.md

🧁 Service [Name]

[add shields.io]

📝 Table of Contents

• About
• Architecture
• Getting Started
  • Settings docker, docker-compose
  • Virtual environment
  • Environment files
  • Launch
• Testing
• Formatting
• Stands
• Tools
• Owner
• TODO

🤔 About

[Small description of the service]

🍔 Architecture

[Optional block, you can insert a statement from the analytics]

🚀 Getting Started

Settings docker, docker-compose

Set up docker, docker-compose to execute commands

Virtual environment

# What virtual environment is needed

# How to install dependencies

Environment files

# What files need to be created

Launch

# How to launch the application

🤖 Testing

# How to test the application

↩️ Formatting

# How to run scripts to format code

🔑 Stands

Type	Address	SSH
Production	[url]/docs	ssh user@{{ip}}
Develop	[url]/docs	ssh user@{{ip}}

⚒️ Tools

Fill in the format [Link] else -

Название	Production	Develop	Comment
Sentry	-	-
Jaeger	-	-	Services: [service_name]
Graylog	-	-	[how searching logs]
Grafana	-	-
Airbyte	-	-
kowl	[-	-	[List topics]

✍️ Owner

©[Owner name]

TODO

• [-] [Dev] ...