Skip to content

Commit 7d100d1

Browse files
Refactor documentation structure and style guides
- Deleted Markdown and PowerShell style guide documents as they are now canonical in MSXOrg/docs. - Updated index.md to reflect the new location of style guides and added migration pointers. - Removed links.md as it is no longer needed. - Introduced abbreviation-preview.js for enhanced abbreviation linking in documentation. - Adjusted zensical.toml to include new abbreviation preview script and reorganized navigation structure for modules.
1 parent d745125 commit 7d100d1

76 files changed

Lines changed: 692 additions & 3412 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

src/docs/Dictionary/api.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: 'Application Programming Interface'
3+
abbreviations:
4+
- 'API'
5+
---
6+
7+
# Application Programming Interface
8+
9+
Application Programming Interface (API) - A set of protocols, routines, and tools for building software applications. APIs specify how software components should interact and are used when programming graphical user interface (GUI) components.
10+
11+
**Example**: The [GitHub](github.md) API allows developers to interact with GitHub repositories, issues, and pull requests programmatically.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'Azure DevOps'
3+
abbreviations: []
4+
---
5+
6+
# Azure DevOps
7+
8+
A set of development tools and services from Microsoft for software development teams, including version control, build automation, and project management.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'Azure Functions'
3+
abbreviations: []
4+
---
5+
6+
# Azure Functions
7+
8+
A serverless compute service that lets you run event-triggered code without having to explicitly provision or manage infrastructure.

src/docs/Dictionary/azure.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 'Azure'
3+
abbreviations: []
4+
---
5+
6+
# Azure
7+
8+
Microsoft's cloud computing platform that provides a wide range of cloud services, including compute, analytics, storage, and networking.
9+
10+
**Related**: [Azure Functions](azure-functions.md), [Azure DevOps](azure-devops.md)

src/docs/Dictionary/branch.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 'Branch'
3+
abbreviations: []
4+
---
5+
6+
# Branch
7+
8+
In version control systems like [Git](git.md), a branch is a parallel version of a [repository](repository.md) that diverges from the main working project.
9+
10+
**Example**: Feature branches are used to develop new features in isolation before merging back to the main branch.
Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'Build Pipeline'
3+
abbreviations: []
4+
---
5+
6+
# Build Pipeline
7+
8+
An automated process that compiles, tests, and packages source code into deployable artifacts.

src/docs/Dictionary/ci-cd.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
---
2+
title: 'Continuous Integration and Continuous Deployment'
3+
abbreviations:
4+
- 'CI/CD'
5+
- 'CI'
6+
- 'CD'
7+
---
8+
9+
# Continuous Integration and Continuous Deployment
10+
11+
Continuous Integration/Continuous Deployment (CI/CD) - A software development practice where developers regularly merge their code changes into a central repository, after which automated builds and tests are run.

src/docs/Dictionary/cmdlet.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
title: 'Cmdlet'
3+
abbreviations: []
4+
---
5+
6+
# Cmdlet
7+
8+
A lightweight [PowerShell](powershell.md) command that follows the verb-noun naming convention and is designed to perform a specific function.
9+
10+
**Example**: `Get-Process`, `Set-Location`, `New-Item`

src/docs/Dictionary/container.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'Container'
3+
abbreviations: []
4+
---
5+
6+
# Container
7+
8+
A lightweight, standalone, executable package that includes everything needed to run an application: code, runtime, system tools, libraries, and settings.

src/docs/Dictionary/devops.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
---
2+
title: 'DevOps'
3+
abbreviations: []
4+
---
5+
6+
# DevOps
7+
8+
A set of practices that combines software development (Dev) and IT operations (Ops) to shorten the systems development lifecycle and provide continuous delivery.

0 commit comments

Comments
 (0)