| know-how | ||
| resources | ||
| .gitignore | ||
| .order | ||
| agile-working.md | ||
| branching-code-review-process.md | ||
| CHANGELOG.md | ||
| documentation-guidelines.md | ||
| faq.md | ||
| getting-started.md | ||
| network.md | ||
| programming-language-recommendations.md | ||
| README.md | ||
| requirements-engineering-process.md | ||
| requirements-gathering-interview.md | ||
| sbom.md | ||
| service-catalogue.md | ||
| stages.md | ||
| traceability-concept.md | ||
| versioning.md | ||
| vms-and-lxcs.md | ||
| welcome.md | ||
Engineering Portal
This space is for the engineering team to share knowledge, resources, and best practices.
Conventions
Naming conventions
As we are heavily using Microsoft Azure and Azure DevOps, we are following the naming conventions provided by Microsoft:
Furthermore, we are using the AzureNamingTool:
Sructure of the repository
We are trying to keep the repositories small and structured. The following overview shows the general structure and the most important repositories.
Documentation repositories
The documentation repositories should help to find best know how, practices and guidelines. No matter if you are new to the team or if you have been working in an different area in the past, you should be able to find the information you need.
- docs-onboarding: the current repository you are reading. It should contain all information needed to get started.
Infrastructure repositories
The infrastructure repositories should contain all information about the infrastructure we are using and it's configuration.
-
infra-ansible-adoconfiguration: Centralised Ansible roles to configure Azure DevOps Organiztations.
-
infra-ansible-developersetup: Centralised Ansible roles to configure developer machines and setup the required tools.
-
infra-ansible-serverconfiguration: Centralised Ansible roles to configure servers.
-
infra-terraform-modulelibrary: We are maintaining Terraform modules which should ensure constant quality and improvement.
Application repositories
The application repositories should contain all information about the applications we are providing.
- app-docker-compose: We are maintaining Docker Compose files which contain the configuration for the applications we are providing.
CI/CD repositories
The CI/CD repositories should contain all information about the CI/CD pipelines we are using.
- cicd-pipeline-library: We are maintaining Azure DevOps Pipeline templates which should ensure constant quality and improvement.
