counterweight/superhog-infra-repo
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

content

Browse source
This commit is contained in:
Pablo Martin 2024-02-06 13:53:05 +01:00
parent c8ca05b1b5
commit 1e9be5c3a8
3 changed files with 76 additions and 16 deletions
Download patch file Download diff file Expand all files Collapse all files

27
README.md
View file

@ -1,20 +1,15 @@
# Introduction
TODO: Give a short introduction of your project. Let this section explain the objectives or the motivation behind this project.
# Data Infra Script
# Getting Started
TODO: Guide users through getting your code up and running on their own system. In this section you can talk about:
1. Installation process
2. Software dependencies
3. Latest releases
4. API references
This repository contains our documentation and scripts on how to deploy the Data team's infrastructure stack.
# Build and Test
TODO: Describe and show how to build your code and run the tests.
Content is structured as follows:
# Contribute
TODO: Explain how other users and developers can contribute to make your code better.
- `human-script.md` is a deployment script for you to read and follow. It guides you through all actions you should take.
- `architecture-overview.md` is an overview of the final architecture that results of following the humna script. If you are not familiar with our architecture, it probably makes sense to read this first so you know what you are setting up.
- `./templates` contains a set of Azure templates to deploy the different services in a subscription. The `human-script.md` will guide you in when you should run what.
- `monitoring-and-administration.md` contains guidelines on how to keep the lights on on several of the components.
If you want to learn more about creating good readme files then refer the following [guidelines](https://docs.microsoft.com/en-us/azure/devops/repos/git/create-a-readme?view=azure-devops). You can also seek inspiration from the below readme files:
- [ASP.NET Core](https://github.com/aspnet/Home)
- [Visual Studio Code](https://github.com/Microsoft/vscode)
- [Chakra Core](https://github.com/Microsoft/ChakraCore)
The following contents are not covered in this repository:
- Application-level configuration for DWH, Airbyte, Power BI, dbt, etc.
- Instance types, disk sizes and other elements will come with defaults. But these are values that you should adapt to the deployment according to volumen and needs, and probably will also change with time. Treat the defaults with skepticism and make sure you adapt to your needs.