Skip to content

Commit

Permalink
GitBook: [#11] minor changes, updated pics, rearranged get started se…
Browse files Browse the repository at this point in the history
…ction
  • Loading branch information
gergely.mate authored and Levente Orban committed Aug 23, 2022
1 parent 9df104e commit a87165d
Show file tree
Hide file tree
Showing 7 changed files with 17 additions and 13 deletions.
Binary file modified docs/.gitbook/assets/product types_dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@

## Get started

* [dyrector.io within your workflows](../get-started/dyrector.io-within-your-workflows/README.md)
* [Use cases](../get-started/dyrector.io-within-your-workflows/use-cases.md)
* [Components](../get-started/dyrector.io-within-your-workflows/components.md)
* [Roles in dyrector.io’s workflow](../get-started/dyrector.io-within-your-workflows/roles-in-dyrector.ios-workflow.md)
* [Overview](get-started/overview.md)
* [Use cases](get-started/use-cases.md)
* [Components](get-started/components.md)
* [dyrector.io's functionality](get-started/dyrector.ios-functionality.md)

## Features

Expand Down
4 changes: 2 additions & 2 deletions docs/basics/where-to-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,12 @@
**If you want to cut to the chase, go to** [**Tutorials**](broken-reference) **to see how you can execute deployments with dyrector.io.**
{% endhint %}

Check out the [**Components**](../../get-started/dyrector.io-within-your-workflows/components.md) section for a basic description of entities and components of dyrector.io’s workflow. To better understand how your teammates will interact with dyrector.io, take a look at the [**Roles in dyrector.io’s workflow**](../../get-started/dyrector.io-within-your-workflows/roles-in-dyrector.ios-workflow.md) part.
Check out the [**Components**](../get-started/components.md) section for a basic description of entities and components of dyrector.io’s workflow. To better understand how your teammates will interact with dyrector.io, take a look at the [**Roles in dyrector.io’s workflow**](../get-started/overview.md) part.

Find out how you can use dyrector.io under the [**Tutorials**](broken-reference) section where you can see through how you can use each function step-by-step.

Read the [**Features**](broken-reference) section to find out about use cases and best practices of dyrector.io’s features. If you're curious about upcoming features and integrations, check [**Roadmap**](../learn-more-about-dyrector.io/roadmap/).

{% hint style="success" %}
If you have any questions about dyrector.io, check the **FAQ** section. Join our community at the channels included in the **Community** section.
If you have any questions about dyrector.io, check the [**FAQ**](../learn-more-about-dyrector.io/faq.md) section. Join our community at the channels included in the [**Community**](../learn-more-about-dyrector.io/community.md) section.
{% endhint %}
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# dyrector.io within your workflows
# dyrector.io's functionality

This section's goal is to introduce dyrector.io's capabilities and how organizations can make the most out of using it. **If you're reading the docs to find out how to execute deployments on the platform, head to the** [**Tutorials**](broken-reference)**.**

The purpose of using dyrector.io is to reduce time and budget spent on release management. To achieve this, dyrector.io helps you with the following features.

### Features
### [Features](broken-reference)

* **Multi-instance deployment –** Trigger deployments of the same application to multiple environments from one place using the same or various configurations.
* **Instant test environments –** Seamless testing whenever your team wants to test the application, without waiting for a SysAdmin to set up an environment.
Expand All @@ -13,7 +13,7 @@ The purpose of using dyrector.io is to reduce time and budget spent on release m
* **Monitoring –** Get notified if a deployment is successful or any failure occurred. Gain better understanding on how your infrastructure and applications perform.
* **Audit log –** We’re creating activity logs so you can follow up on what actions were executed by your team. This can be useful when teams hold retrospective meetings.

#### Features in progress
#### [Features in progress](../learn-more-about-dyrector.io/roadmap/features-in-progress.md)

* **Changelogs –** You're able to create changelogs at ease based on commit messages with the help of Conventional Commits, so your team understands the purpose of new versions. This simplifies communication between departments who work on the product and outsiders, for example decision-makers. The generated changelogs can be sent out via e-mail or any chatbot integration.
* **Secret management –** Store and manage sensitive data with our Vault integration powered by Hashi Corp.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,25 @@ description: >-
stakeholder in your SDLC interacts with the platform.
---

# Roles in dyrector.io’s workflow
# Overview

{% hint style="info" %}
If you want to learn how you can deploy applications with dyrector.io, check the [**Tutorials**](broken-reference) section. However, it's important to go through the Get Started section for successful adoption of dyrector.io.
{% endhint %}

There are four roles involved in dyrector.io’s workflow. These are Developers, Release Managers, SysAdmins / DevOps Engineers and Stakeholders. Based on their responsibilities, they interact differently with dyrector.io.

{% hint style="info" %}
### General use case of dyrector.io

In the flowchart below you can see how dyrector.io fits into Software Development Lifecycle (SDLC).

* Your Developer teammate commits to a Registry, which your Release Manager teammate gets notified about.
* The Release Manager or any stakeholder can set up a testing environment self-service to validate the new version’s functionality.
* After successful testing, the Release Manager or any stakeholder can trigger the deployment of the new version.

In case of an emergency, specialist or non-specialist stakeholders can intervene on an abstract level via dyrector.io to avoid downtime for a temporary fix.
{% endhint %}

![Flowchart of how each stakeholder and component in the SDLC interacts with dyrector.io.](../../docs/.gitbook/assets/dyrector-io-workflow-roles-dark.png)
![Flowchart of how each stakeholder and component in the SDLC interacts with dyrector.io.](../.gitbook/assets/dyrector-io-workflow-roles-dark.png)

### Developers / Engineers

Expand Down
File renamed without changes.

0 comments on commit a87165d

Please sign in to comment.