Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@ jobs:
deploy:
needs: build
runs-on: ubuntu-latest
timeout-minutes: 30
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
Expand Down
32 changes: 19 additions & 13 deletions src/content/docs/guides/example.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,32 +6,38 @@ lang: 'en-uk'

# What Is Docs-as-code?

<div style='position: relative; padding-bottom: 56.25%; height: 0;'><iframe src='https://player.viloud.tv/embed/video/82cba7ea62883a559baee3e4f0eaa573?autoplay=0&volume=1&controls=1&title=1&share=1&open_playlist=0' style='position: absolute; top: 0; left: 0; width: 100%; height: 100%;' frameborder='0' allow='autoplay' allowfullscreen></iframe></div>

Docs-as-code is a technical writing environment where the technical writer uses the same tools as the software developers. When documenting softwares, this eases the reviewing process and increases the collaboration possibilities.
Docs-as-code is a documentation approach where technical writers and developers work in the same environment and use the same tools. By storing documentation in version control and writing in lightweight formats such as Markdown, teams gain a faster review process, clearer collaboration, and a workflow that aligns with modern software development.

<div style='position: relative; padding-bottom: 56.25%; height: 0;'><iframe src='https://player.viloud.tv/embed/video/82cba7ea62883a559baee3e4f0eaa573?autoplay=0&volume=1&controls=1&title=1&share=1&open_playlist=0' style='position: absolute; top: 0; left: 0; width: 100%; height: 100%;' frameborder='0' allow='autoplay' allowfullscreen></iframe></div>

## Benefits

When using Docs-as-code with Markdown compared with DITA, includes the following benefits:
Using a docs-as-code workflow with Markdown, compared to traditional DITA-based systems, provides several advantages:

* Smoother and faster reviewing process.
* Flexibility when working with information layout.
* Installing add-ons to make the documentation into a product.
* **Faster and more structured reviews** through pull requests and inline comments.
* **Flexible content layout** without rigid XML schemas.
* **Easy integration of add-ons** that transform documentation into a product.

### Add-ons To Integrate

The following add-ons are great extensions to the docs-as-code environment:
The following tools extend and enhance a docs-as-code environment:

* Litlyx
* Litlyx is a Traffic Analytics site from Italy, Europe. The installation process is quick and the product is GDPR compliant. See [Litlyx webpage](https://litlyx.com/) for more information.
* A lightweight, GDPR-compliant analytics tool that provides traffic insights for documentation portals. See [Litlyx webpage](https://litlyx.com/) for more information.
* Swagger
* Swagger is an API preview documentation tool. The tool provides example requests and example of a return object. See [Swagger webpage](https://swagger.io/) for more information.
* An interactive API documentation tool that displays example requests, response schemas, and live testing. See [Swagger webpage](https://swagger.io/) for more information.
* GitLens
* GitLens is a git viewing tool. This tool visualizes the git branches and provides insights to the git history.
* GitLens is especially helpful when new to git. See [GitLens wepage](https://www.gitkraken.com/gitlens) for more information.
* A Git visualization extension for VS Code that helps contributors understand commit history, branching, and collaboration patterns. See [GitLens wepage](https://www.gitkraken.com/gitlens) for more information.

## Docs-as-code VS DITA

Docs-as-code is often preferred over DITA in the following situations:

- **Software documentation**, where writers benefit from using the same tools as developers.
- **Cost efficiency**, avoiding licensing fees associated with DITA-based systems.
- **Flexibility**, allowing writers to structure content without strict XML constraints.
- **Integration**, enabling documentation to fit naturally into the IT ecosystem and CI/CD pipelines.

## Further reading

- Read [about how-to guides](https://diataxis.fr/how-to-guides/) in the Diátaxis framework
- Read [Docs-as-code](https://www.writethedocs.org/guide/docs-as-code/) from Write The Docs for more information.
34 changes: 34 additions & 0 deletions src/content/docs/tools/pipelines.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
---
title: Pipelines
config:
theme: base
themeVariables:
primaryColor: "#4f3535"
description: Description on pipelines and workflows within this project.
---

Pipelines are being triggered during 'git push' or deployment. These are being constructed to prevent issues to occur and to catch common mistakes.

```mermaid
flowchart TD
A[Git Push] --> B[Github]

subgraph GHA[Github Actions]
C[Forbidden Words Checker]
D[Merge Conflict Checker]
E[Versioning]
end

B --> C
B --> D
B --> E

C --> F[Deployment]
D --> F
E --> F
```


## Further reading

- Read [about reference](https://diataxis.fr/reference/) in the Diátaxis framework
Loading