Merged PR 264: add further suggestions for content
add further suggestions for content
This commit is contained in:
commit
958fc5245d
9 changed files with 61 additions and 18 deletions
5
.order
5
.order
|
|
@ -1 +1,6 @@
|
||||||
README
|
README
|
||||||
|
welcome.md
|
||||||
|
getting-started.md
|
||||||
|
documentation-guidelines.md
|
||||||
|
code-review-process.md
|
||||||
|
faq.md
|
||||||
|
|
|
||||||
16
README.md
16
README.md
|
|
@ -8,10 +8,24 @@ We are trying to keep the repositories small and structured. The following overv
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
## 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.
|
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-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.
|
- [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.
|
||||||
|
|
|
||||||
3
code-review-process.md
Normal file
3
code-review-process.md
Normal file
|
|
@ -0,0 +1,3 @@
|
||||||
|
# Code Review Process
|
||||||
|
|
||||||
|
Guidelines and expectations for code review.
|
||||||
11
documentation-guidelines.md
Normal file
11
documentation-guidelines.md
Normal file
|
|
@ -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 <file>.puml
|
||||||
|
```
|
||||||
3
faq.md
Normal file
3
faq.md
Normal file
|
|
@ -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`.
|
||||||
5
getting-started.md
Normal file
5
getting-started.md
Normal file
|
|
@ -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.
|
||||||
Binary file not shown.
|
Before Width: | Height: | Size: 42 KiB After Width: | Height: | Size: 42 KiB |
|
|
@ -1,4 +1,5 @@
|
||||||
@startuml engineer-portal-structure
|
@startuml engineer-portal-structure
|
||||||
|
|
||||||
skinparam rectangle {
|
skinparam rectangle {
|
||||||
BackgroundColor<<Documentation>> Wheat
|
BackgroundColor<<Documentation>> Wheat
|
||||||
BackgroundColor<<Infrastructure>> LightBlue
|
BackgroundColor<<Infrastructure>> LightBlue
|
||||||
|
|
@ -10,24 +11,16 @@ skinparam roundcorner 20
|
||||||
skinparam shadowing false
|
skinparam shadowing false
|
||||||
|
|
||||||
rectangle "Engineer Portal Structure" as Structure {
|
rectangle "Engineer Portal Structure" as Structure {
|
||||||
rectangle "Documentation Repos" <<Documentation>> {
|
rectangle "Documentation repositories" <<Documentation>> {
|
||||||
rectangle "docs-onboarding\n- Welcome\n- Team Structures\n- Dev Environment" as Onboarding
|
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- Planning of work\n- Colaboration" as AgileDocs
|
rectangle "docs-agile-working\n- Communication\n- Documentation\n- The PI and sprints\n- Task management kanban setup" as AgileDocs
|
||||||
rectangle "docs-security-policies\n- Compliance\n- Data Policies" as SecurityDocs
|
|
||||||
}
|
}
|
||||||
rectangle "Infrastructure Repos" <<Infrastructure>> {
|
rectangle "Infrastructure repositories" <<Infrastructure>> {
|
||||||
rectangle "infra-terraform\n- Azure Modules\n- IaC consumer examples" as Terraform
|
rectangle "infra-terraform-modulelibrary\n- Azure Modules\n- IaC consumer examples" as Terraform
|
||||||
rectangle "infra-ansible\n- Config Management\n- Server Roles" as Ansible
|
rectangle "infra-ansible-adoconfiguration\n- Config Management\n- Server Roles" as Ansible
|
||||||
}
|
}
|
||||||
rectangle "Application Repos" <<Applications>> {
|
rectangle "CI/CD repositories" <<CICD>> {
|
||||||
rectangle "app-python-services\n- Service APIs\n- Data Apps" as PythonApps
|
rectangle "cicd-pipeline-library\n- YAML Definitions\n- Build Configs" as CICD
|
||||||
rectangle "app-dotnet-apis\n- RESTful APIs\n- Backend Services" as DotnetApps
|
|
||||||
}
|
|
||||||
rectangle "Tools & Utilities Repos" <<Tools>> {
|
|
||||||
rectangle "tools-scripts\n- Utility Scripts\n- Diagnostic Tools" as Scripts
|
|
||||||
}
|
|
||||||
rectangle "CI/CD Repos" <<CICD>> {
|
|
||||||
rectangle "ci-cd-pipelines\n- YAML Definitions\n- Build Configs" as CICD
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
|
||||||
9
welcome.md
Normal file
9
welcome.md
Normal file
|
|
@ -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.
|
||||||
Loading…
Add table
Add a link
Reference in a new issue