diff --git a/.order b/.order index 35527d3..c046b5f 100644 --- a/.order +++ b/.order @@ -1 +1,6 @@ README +welcome.md +getting-started.md +documentation-guidelines.md +code-review-process.md +faq.md diff --git a/README.md b/README.md index fd1efa0..d054103 100644 --- a/README.md +++ b/README.md @@ -8,10 +8,24 @@ We are trying to keep the repositories small and structured. The following overv ![Engineering Portal Structure](resources/diagrams/engineer-portal-structure.png) -## Documentation 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](https://dev.azure.com/ypsag/ITSandbox/_git/docs-cloudstream-onboarding): the current repository you are reading. It should contain all information needed to get started. - [docs-agile-working](https://dev.azure.com/ypsag/ITSandbox/_git/docs-agile-working): information about how we work with Azure Borads in the team and how we use the agile methodology. + +### Infrastructure repositories + +The infrastructure repositories should contain all information about the infrastructure we are using and it's configuration. + +- [infra-terraform-modulelibrary](https://dev.azure.com/ypsag/ITSandbox/_git/infra-terraform-modulelibrary): We are maintaining Terraform modules which should ensure constant quality and improvement. + +- [infra-ansible-adoconfiguration](https://dev.azure.com/ypsag/ITSandbox/_git/infra-ansible-adoconfiguration): We are maintaining Ansible playbooks to configure our Azure DevOps environments. + +### CI/CD repositories + +The CI/CD repositories should contain all information about the CI/CD pipelines we are using. + +- [cicd-pipeline-library](https://dev.azure.com/ypsag/ITSandbox/_git/cicd-pipeline-library): We are maintaining Azure DevOps Pipeline templates which should ensure constant quality and improvement. diff --git a/code-review-process.md b/code-review-process.md new file mode 100644 index 0000000..a113296 --- /dev/null +++ b/code-review-process.md @@ -0,0 +1,3 @@ +# Code Review Process + +Guidelines and expectations for code review. diff --git a/documentation-guidelines.md b/documentation-guidelines.md new file mode 100644 index 0000000..b120461 --- /dev/null +++ b/documentation-guidelines.md @@ -0,0 +1,11 @@ +# Documentation Guidelines + +Best practices and guidelines for writing code documentation. + +## PlantUML + +Create png images from PlantUML files using the following command: + +```bash +plantuml -tpng .puml +``` diff --git a/faq.md b/faq.md new file mode 100644 index 0000000..6e128db --- /dev/null +++ b/faq.md @@ -0,0 +1,3 @@ +# Frequently Asked Questions + +Suggestion JJ: Frequently asked questions by new developers. Here we display a link to a shared query displaying all work items of type task tagged with `FAQ`. diff --git a/getting-started.md b/getting-started.md new file mode 100644 index 0000000..086d8e3 --- /dev/null +++ b/getting-started.md @@ -0,0 +1,5 @@ +# Getting started + +Initial setup instructions for development environments. +List and explanation of development tools used in our team. +We should automate this as much as possible e.g. by providing an ansible playbook. diff --git a/resources/diagrams/engineer-portal-structure.png b/resources/diagrams/engineer-portal-structure.png index bb9ff35..49a70ac 100644 Binary files a/resources/diagrams/engineer-portal-structure.png and b/resources/diagrams/engineer-portal-structure.png differ diff --git a/resources/diagrams/engineer-portal-structure.puml b/resources/diagrams/engineer-portal-structure.puml index 232c0b1..9a7ef34 100644 --- a/resources/diagrams/engineer-portal-structure.puml +++ b/resources/diagrams/engineer-portal-structure.puml @@ -1,4 +1,5 @@ @startuml engineer-portal-structure + skinparam rectangle { BackgroundColor<> Wheat BackgroundColor<> LightBlue @@ -10,25 +11,17 @@ skinparam roundcorner 20 skinparam shadowing false rectangle "Engineer Portal Structure" as Structure { - rectangle "Documentation Repos" <> { - rectangle "docs-onboarding\n- Welcome\n- Team Structures\n- Dev Environment" as Onboarding - rectangle "docs-agile-working\n- Planning of work\n- Colaboration" as AgileDocs - rectangle "docs-security-policies\n- Compliance\n- Data Policies" as SecurityDocs + rectangle "Documentation repositories" <> { + rectangle "docs-cloudstream-onboarding\n- Welcome\n- Getting Started\n- Documentation Guidelines\n- Code Review Process\n- FAQ" as Onboarding + rectangle "docs-agile-working\n- Communication\n- Documentation\n- The PI and sprints\n- Task management kanban setup" as AgileDocs } - rectangle "Infrastructure Repos" <> { - rectangle "infra-terraform\n- Azure Modules\n- IaC consumer examples" as Terraform - rectangle "infra-ansible\n- Config Management\n- Server Roles" as Ansible + rectangle "Infrastructure repositories" <> { + rectangle "infra-terraform-modulelibrary\n- Azure Modules\n- IaC consumer examples" as Terraform + rectangle "infra-ansible-adoconfiguration\n- Config Management\n- Server Roles" as Ansible } - rectangle "Application Repos" <> { - rectangle "app-python-services\n- Service APIs\n- Data Apps" as PythonApps - rectangle "app-dotnet-apis\n- RESTful APIs\n- Backend Services" as DotnetApps - } - rectangle "Tools & Utilities Repos" <> { - rectangle "tools-scripts\n- Utility Scripts\n- Diagnostic Tools" as Scripts - } - rectangle "CI/CD Repos" <> { - rectangle "ci-cd-pipelines\n- YAML Definitions\n- Build Configs" as CICD + rectangle "CI/CD repositories" <> { + rectangle "cicd-pipeline-library\n- YAML Definitions\n- Build Configs" as CICD } } -@enduml \ No newline at end of file +@enduml diff --git a/welcome.md b/welcome.md new file mode 100644 index 0000000..e4259fe --- /dev/null +++ b/welcome.md @@ -0,0 +1,9 @@ +# Welcome to the team + +Welcome message and introduction to the wiki. + +## Cloud Stream Team Structure + +Breakdown of the team's structure and roles. + +Link to orgmanager.