Przejdลบ do treล›ci

๐Ÿ—‚๏ธ Repository Structure

Guidelines for organizing repositories in DevOps and documentation projects.


๐Ÿงฉ Monoโ€‘Repo vs Multiโ€‘Repo

Monoโ€‘Repo

  • All components in one repository
  • Easier crossโ€‘project refactoring
  • Ideal for documentation

Multiโ€‘Repo

  • Each service has its own repo
  • Better isolation
  • Ideal for microservices

1
2
3
4
5
6
7
8
9
knowledge-base/
โ”‚
โ”œโ”€โ”€ docs/
โ”‚   โ”œโ”€โ”€ devops/
โ”‚   โ”œโ”€โ”€ docker/
โ”‚   โ”œโ”€โ”€ wordpress/
โ”‚   โ””โ”€โ”€ ...
โ”œโ”€โ”€ mkdocs.yml
โ””โ”€โ”€ README.md

๐Ÿง  Naming Conventions

  • lowercase
  • hyphens instead of spaces
  • meaningful folder names