Creating database documentation during the Continuous Integration workflow

In this video, we will show you in detail how dbForge Documenter can directly take part in the Development and CI processes.
In the CI process, you can use dbForge Documenter in two modes and generate database documentation either on the fly based on the connection to the database or using the project file * .ddoc.
Now, let’s consider how to create a documentation project.

1) First, click New Documentation and select a connection.
2) Next, in the Database Explorer, select the necessary database.
3) Then, click Generate and select the documentation generation format and specify the file path.
4) Finally, save the ddoc project.

You can then use this project in the PowerShell cmdlet New-DevartDatabaseDocumentation.
dbForge Documenter plays an important role in the DevOps process and allows you to keep the database documentation up to date.

Find more information about how dbForge Documenter is involved in the DevOps process here:
https://www.devart.com/dbforge/sql/database-devops/documenter.html
Download dbForge SQL Tools for SQL Server (includes DevOps Automation)
https://www.devart.com/dbforge/sql/database-devops/download.html

#SQLDocumenter #SQLDocumentationTool #DevOpsAutomation #DevOpsTools #SQLTools #dbForge #Devart

---

Closed Caption:

Want to boost database development with the
DevOps practices?
This video series will cover how to set up
each and every step of the DevOps workflow
and how the dbForge product can help with
it.
The process can be visualized like this:
[pict]
In this video, we will show you in detail
how dbForge Documenter can directly take part
in the Development and CI processes.
dbForge Documenter automatically generates
database documentation as HTML, Markdown,
or pdf files.
The generated documentation contains information
about database objects, a database creation
script and object dependencies.
After the documentation has been generated,
it can be included in the NuGet package along
with database scripts.
In the CI process, you can use dbForge Documenter
in two modes and generate database documentation
either on the fly based on the connection
to the database or using the project file
* .ddoc.
Now, let’s consider how to create a documentation
project.
First, click New Documentation and select
a connection.
Next, in the Database Explorer, select the
necessary database.
Then, click Generate and select the documentation
generation format and specify the file path.
Finally, save the ddoc project.
You can then use this project in the PowerShell
cmdlet New-DevartDatabaseDocumentation.
Let's see how to use the New-DevartDatabaseDocumentation
cmdlet to generate documentation on the fly.
[script]
And that’s how you can create documentation
for a database based on a .ddoc project:
[script]
As you can see, in both cases, documentation
has been successfully generated.
dbForge Documenter plays an important role
in the DevOps process and allows you to keep
the database documentation up to date.
Just download dbForge DevOps Automation solution
and organize safe and stable DevOps process
in a seamless way.