-
Notifications
You must be signed in to change notification settings - Fork 92
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Publishing the AlwaysOn design methodology content to a new public repo for open source contributions.
- Loading branch information
Showing
41 changed files
with
4,201 additions
and
395 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Owners of repository | ||
/.github/CODEOWNERS @calcof | ||
/README.md @calcof | ||
|
||
# Owners of docs | ||
/docs/ @calcof @hjscherer @sebader @msimecek @heoelri @nielsams |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,350 +1,2 @@ | ||
## Ignore Visual Studio temporary files, build results, and | ||
## files generated by popular Visual Studio add-ons. | ||
## | ||
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore | ||
|
||
# User-specific files | ||
*.rsuser | ||
*.suo | ||
*.user | ||
*.userosscache | ||
*.sln.docstates | ||
|
||
# User-specific files (MonoDevelop/Xamarin Studio) | ||
*.userprefs | ||
|
||
# Mono auto generated files | ||
mono_crash.* | ||
|
||
# Build results | ||
[Dd]ebug/ | ||
[Dd]ebugPublic/ | ||
[Rr]elease/ | ||
[Rr]eleases/ | ||
x64/ | ||
x86/ | ||
[Aa][Rr][Mm]/ | ||
[Aa][Rr][Mm]64/ | ||
bld/ | ||
[Bb]in/ | ||
[Oo]bj/ | ||
[Ll]og/ | ||
[Ll]ogs/ | ||
|
||
# Visual Studio 2015/2017 cache/options directory | ||
.vs/ | ||
# Uncomment if you have tasks that create the project's static files in wwwroot | ||
#wwwroot/ | ||
|
||
# Visual Studio 2017 auto generated files | ||
Generated\ Files/ | ||
|
||
# MSTest test Results | ||
[Tt]est[Rr]esult*/ | ||
[Bb]uild[Ll]og.* | ||
|
||
# NUnit | ||
*.VisualState.xml | ||
TestResult.xml | ||
nunit-*.xml | ||
|
||
# Build Results of an ATL Project | ||
[Dd]ebugPS/ | ||
[Rr]eleasePS/ | ||
dlldata.c | ||
|
||
# Benchmark Results | ||
BenchmarkDotNet.Artifacts/ | ||
|
||
# .NET Core | ||
project.lock.json | ||
project.fragment.lock.json | ||
artifacts/ | ||
|
||
# StyleCop | ||
StyleCopReport.xml | ||
|
||
# Files built by Visual Studio | ||
*_i.c | ||
*_p.c | ||
*_h.h | ||
*.ilk | ||
*.meta | ||
*.obj | ||
*.iobj | ||
*.pch | ||
*.pdb | ||
*.ipdb | ||
*.pgc | ||
*.pgd | ||
*.rsp | ||
*.sbr | ||
*.tlb | ||
*.tli | ||
*.tlh | ||
*.tmp | ||
*.tmp_proj | ||
*_wpftmp.csproj | ||
*.log | ||
*.vspscc | ||
*.vssscc | ||
.builds | ||
*.pidb | ||
*.svclog | ||
*.scc | ||
|
||
# Chutzpah Test files | ||
_Chutzpah* | ||
|
||
# Visual C++ cache files | ||
ipch/ | ||
*.aps | ||
*.ncb | ||
*.opendb | ||
*.opensdf | ||
*.sdf | ||
*.cachefile | ||
*.VC.db | ||
*.VC.VC.opendb | ||
|
||
# Visual Studio profiler | ||
*.psess | ||
*.vsp | ||
*.vspx | ||
*.sap | ||
|
||
# Visual Studio Trace Files | ||
*.e2e | ||
|
||
# TFS 2012 Local Workspace | ||
$tf/ | ||
|
||
# Guidance Automation Toolkit | ||
*.gpState | ||
|
||
# ReSharper is a .NET coding add-in | ||
_ReSharper*/ | ||
*.[Rr]e[Ss]harper | ||
*.DotSettings.user | ||
|
||
# TeamCity is a build add-in | ||
_TeamCity* | ||
|
||
# DotCover is a Code Coverage Tool | ||
*.dotCover | ||
|
||
# AxoCover is a Code Coverage Tool | ||
.axoCover/* | ||
!.axoCover/settings.json | ||
|
||
# Visual Studio code coverage results | ||
*.coverage | ||
*.coveragexml | ||
|
||
# NCrunch | ||
_NCrunch_* | ||
.*crunch*.local.xml | ||
nCrunchTemp_* | ||
|
||
# MightyMoose | ||
*.mm.* | ||
AutoTest.Net/ | ||
|
||
# Web workbench (sass) | ||
.sass-cache/ | ||
|
||
# Installshield output folder | ||
[Ee]xpress/ | ||
|
||
# DocProject is a documentation generator add-in | ||
DocProject/buildhelp/ | ||
DocProject/Help/*.HxT | ||
DocProject/Help/*.HxC | ||
DocProject/Help/*.hhc | ||
DocProject/Help/*.hhk | ||
DocProject/Help/*.hhp | ||
DocProject/Help/Html2 | ||
DocProject/Help/html | ||
|
||
# Click-Once directory | ||
publish/ | ||
|
||
# Publish Web Output | ||
*.[Pp]ublish.xml | ||
*.azurePubxml | ||
# Note: Comment the next line if you want to checkin your web deploy settings, | ||
# but database connection strings (with potential passwords) will be unencrypted | ||
*.pubxml | ||
*.publishproj | ||
|
||
# Microsoft Azure Web App publish settings. Comment the next line if you want to | ||
# checkin your Azure Web App publish settings, but sensitive information contained | ||
# in these scripts will be unencrypted | ||
PublishScripts/ | ||
|
||
# NuGet Packages | ||
*.nupkg | ||
# NuGet Symbol Packages | ||
*.snupkg | ||
# The packages folder can be ignored because of Package Restore | ||
**/[Pp]ackages/* | ||
# except build/, which is used as an MSBuild target. | ||
!**/[Pp]ackages/build/ | ||
# Uncomment if necessary however generally it will be regenerated when needed | ||
#!**/[Pp]ackages/repositories.config | ||
# NuGet v3's project.json files produces more ignorable files | ||
*.nuget.props | ||
*.nuget.targets | ||
|
||
# Microsoft Azure Build Output | ||
csx/ | ||
*.build.csdef | ||
|
||
# Microsoft Azure Emulator | ||
ecf/ | ||
rcf/ | ||
|
||
# Windows Store app package directories and files | ||
AppPackages/ | ||
BundleArtifacts/ | ||
Package.StoreAssociation.xml | ||
_pkginfo.txt | ||
*.appx | ||
*.appxbundle | ||
*.appxupload | ||
|
||
# Visual Studio cache files | ||
# files ending in .cache can be ignored | ||
*.[Cc]ache | ||
# but keep track of directories ending in .cache | ||
!?*.[Cc]ache/ | ||
|
||
# Others | ||
ClientBin/ | ||
~$* | ||
*~ | ||
*.dbmdl | ||
*.dbproj.schemaview | ||
*.jfm | ||
*.pfx | ||
*.publishsettings | ||
orleans.codegen.cs | ||
|
||
# Including strong name files can present a security risk | ||
# (https://github.com/github/gitignore/pull/2483#issue-259490424) | ||
#*.snk | ||
|
||
# Since there are multiple workflows, uncomment next line to ignore bower_components | ||
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) | ||
#bower_components/ | ||
|
||
# RIA/Silverlight projects | ||
Generated_Code/ | ||
|
||
# Backup & report files from converting an old project file | ||
# to a newer Visual Studio version. Backup files are not needed, | ||
# because we have git ;-) | ||
_UpgradeReport_Files/ | ||
Backup*/ | ||
UpgradeLog*.XML | ||
UpgradeLog*.htm | ||
ServiceFabricBackup/ | ||
*.rptproj.bak | ||
|
||
# SQL Server files | ||
*.mdf | ||
*.ldf | ||
*.ndf | ||
|
||
# Business Intelligence projects | ||
*.rdl.data | ||
*.bim.layout | ||
*.bim_*.settings | ||
*.rptproj.rsuser | ||
*- [Bb]ackup.rdl | ||
*- [Bb]ackup ([0-9]).rdl | ||
*- [Bb]ackup ([0-9][0-9]).rdl | ||
|
||
# Microsoft Fakes | ||
FakesAssemblies/ | ||
|
||
# GhostDoc plugin setting file | ||
*.GhostDoc.xml | ||
|
||
# Node.js Tools for Visual Studio | ||
.ntvs_analysis.dat | ||
node_modules/ | ||
|
||
# Visual Studio 6 build log | ||
*.plg | ||
|
||
# Visual Studio 6 workspace options file | ||
*.opt | ||
|
||
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.) | ||
*.vbw | ||
|
||
# Visual Studio LightSwitch build output | ||
**/*.HTMLClient/GeneratedArtifacts | ||
**/*.DesktopClient/GeneratedArtifacts | ||
**/*.DesktopClient/ModelManifest.xml | ||
**/*.Server/GeneratedArtifacts | ||
**/*.Server/ModelManifest.xml | ||
_Pvt_Extensions | ||
|
||
# Paket dependency manager | ||
.paket/paket.exe | ||
paket-files/ | ||
|
||
# FAKE - F# Make | ||
.fake/ | ||
|
||
# CodeRush personal settings | ||
.cr/personal | ||
|
||
# Python Tools for Visual Studio (PTVS) | ||
__pycache__/ | ||
*.pyc | ||
|
||
# Cake - Uncomment if you are using it | ||
# tools/** | ||
# !tools/packages.config | ||
|
||
# Tabs Studio | ||
*.tss | ||
|
||
# Telerik's JustMock configuration file | ||
*.jmconfig | ||
|
||
# BizTalk build output | ||
*.btp.cs | ||
*.btm.cs | ||
*.odx.cs | ||
*.xsd.cs | ||
|
||
# OpenCover UI analysis results | ||
OpenCover/ | ||
|
||
# Azure Stream Analytics local run output | ||
ASALocalRun/ | ||
|
||
# MSBuild Binary and Structured Log | ||
*.binlog | ||
|
||
# NVidia Nsight GPU debugger configuration file | ||
*.nvuser | ||
|
||
# MFractors (Xamarin productivity tool) working folder | ||
.mfractor/ | ||
|
||
# Local History for Visual Studio | ||
.localhistory/ | ||
|
||
# BeatPulse healthcheck temp database | ||
healthchecksdb | ||
|
||
# Backup folder for Package Reference Convert tool in Visual Studio 2017 | ||
MigrationBackup/ | ||
|
||
# Ionide (cross platform F# VS Code tools) working folder | ||
.ionide/ | ||
## Folders | ||
.vscode |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,32 @@ | ||
# How to Contribute to AlwaysOn | ||
|
||
## Content Changes and Pull Requests | ||
|
||
To add or edit content within the AlwaysOn repositories, please take a fork of a repository to iterate on changes before subsequently opening a Pull Request (PR) to get your forked branch merged into the main branch for that AlwaysOn repository. Your PR will be reviewed by core engineers working on the AlwaysOn project, and once approved, your content accessible to everybody. | ||
|
||
> **Important!** Please make sure that your PR is focused on a specific area of AlwaysOn to facilitate a targeted review, as this will speed up the process to get your changes merged into our repository. | ||
## Content Structure | ||
|
||
[![AlwaysOn Repo Structure](/docs/media/alwayson-repo-structure.png "AlwaysOn Repo Structure")](./CONTRIBUTE.md) | ||
|
||
The AlwaysOn project is separated into **3** different repositories: | ||
|
||
- [AlwaysOn](/docs/README.md): contains the AlwaysOn design methodology, covering the design pattern ad approach to guide readers to defining a target AlwaysOn architecture. | ||
- Overarching topics are documented as separate markdown documents within the `/docs/` directory. | ||
|
||
- [AlwaysOn-Foundational-Online](http://github.com/azure/alwayson-foundational-online): contains the AlwaysOn foundational reference implementation intended for online scenarios that are public-facing and do not require private network connectivity to a surrounding organizational technical estate. | ||
- [`/docs/`](https://github.com/Azure/alwayson-foundational-online/tree/main/docs) contains the majority of documentation, covering the design approach and detailed documentation to accompany the reference implementation. | ||
- [`/src/`](https://github.com/Azure/alwayson-foundational-online/tree/main/src) contains all source code and technical artifacts for the reference implementation along with low level implementation documentation. | ||
- [`/.ado/pipelines`](https://github.com/Azure/alwayson-foundational-online/tree/main/.ado/pipelines) contains the Azure DevOps pipelines to build and deploy the reference implementation. | ||
|
||
- [AlwaysOn-Foundational-Connected](http://github.com/azure/alwayson-foundational-connected): contains the AlwaysOn foundational reference implementation intended for private scenarios that require integration with an organizational technical estate for either public-facing or internal-facing workloads. | ||
- [`/docs/`](http://github.com/azure/alwayson-foundational-connected/tree/main/docs) contains the majority of documentation, covering the design approach and detailed documentation to accompany the reference implementation. | ||
- [`/src/`](http://github.com/azure/alwayson-foundational-connected/tree/main/src) contains all source code and technical artifacts for the reference implementation along with low level implementation documentation. | ||
- [`/.ado/pipelines`](http://github.com/azure/alwayson-foundational-connected/tree/main/.ado/pipelines) contains the Azure DevOps pipelines to build and deploy the reference implementation. | ||
|
||
## Documentation Conventions | ||
|
||
Each source code component within the reference implementation repositories has it's own `README.md` file which explains how that particular component works, how it is supposed to be used, and how it may interact with other aspects of the AlwaysOn solution. | ||
|
||
Within the `main` branch, each `README.md` file must accurately represent the state of the associated component which will serve as a core aspect of PR reviews. Any modifications to source components must therefore be reflected in the documentation as well. |
Oops, something went wrong.