Skip to content

Commit

Permalink
Feature/8268 update documentation for repository structure (#559)
Browse files Browse the repository at this point in the history
* refactor: update the tree and the repo list

* refactor: update the repo configurations
  • Loading branch information
sharonrussell authored Oct 24, 2024
1 parent 0ce4874 commit 6ed0160
Showing 1 changed file with 22 additions and 33 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -15,40 +15,29 @@ keywords:
- structure
---


```text
├── build
│ ├── azDevOps: stores configuration, build steps and scripts used by azure dev ops only
│ ├── jenkins: stores configuration, build steps and scripts used by jenkins only
│ └── scripts: stores scripts used by build steps that can be reused by multiple
| tools without changes. ie: Docker script for Container Image creation
├── deploy
| ├── k8s: stores yaml files for k8s deployments. i.e: deployments, services,
| | | configMap and related dependencies for each service in an application
| | ├── ui: stores yaml for ui service
| | └── api: stores yaml for the api service and configuration files
│ │ ├── base: store raw yaml used by k8s
│ │ ├── kustomization: store kustomize files(for kubectl apply -k)
│ │ │ ├── dev: configuration files for dev environment
│ │ │ └── test: configuration files for test environment
│ │ └── helm-chart: store helm chart files(if helm used)
│ │ └── templates
| ├── serviceFabric: scripts used to deploy applications on serviceFabric
| ├── terraform: terraform scripts used to provision dependencies
| | only needed by this application
| └── scripts: deployment scripts shared by multiple tools. ie: Variable substitution
├── contracts: stores swagger specs, ui mocks and other documents describing
| the overall solution
└── src
├── services (i.e: apis, queue listener, scheduled jobs)
├── tests: stores tests not built in other services solutions (functional tests,
| performance, etc)
└── ui: stores the front end service and components
├── build: stores build configurations
│   ├── azDevOps: stores configuration, build steps and scripts used by Azure DevOps
│   ├── github: stores configuration, build steps and scripts used by GitHub Actions
│   ├── scripts: stores reusable scripts used by the build pipelines
│   └── taskctl: stores configuration, build steps and scripts used by TaskCtl
├── deploy: stores deployment configurations
│   ├── aws: stores deployment steps and scripts used by AWS
│   ├── azure: stores deployment steps and scripts used by Azure DevOps
│   ├── helm: stores Helm charts
│   └── scripts: stores reusable scripts used by the deployment pipelines
├── docs: stores documentation
├── scripts: stores scripts used for testing, development and other purposes
├── src: stores the source code
│   ├── background-worker: stores the background worker function template
│   ├── cqrs: stores the CQRS template
│   ├── func-aeh-listener: stores the Azure Event Hub listener function template
│   ├── func-asb-listener: stores the Azure Service Bus listener function template
│   ├── func-cosmosdb-worker: stores the CosmosDB worker function template
│   ├── shared: stores the shared code
│   └── simple-api: stores the simple API template
```

There is 1 repository available:

There are 3 repositories available:

[stacks-dotnet](https://github.com/Ensono/stacks-dotnet) for a simple web API <br/>
[stacks-dotnet-cqrs](https://github.com/Ensono/stacks-dotnet-cqrs) for a web API with CQRS <br/>
[stacks-dotnet-cqrs-events](https://github.com/Ensono/stacks-dotnet-cqrs-events) for a web API with CQRS and Event Listening (with function and worker service) <br/>
[stacks-dotnet](https://github.com/Ensono/stacks-dotnet) for all available dotnet templates

0 comments on commit 6ed0160

Please sign in to comment.