Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs builder migration #66

Open
wants to merge 65 commits into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
65 commits
Select commit Hold shift + click to select a range
1d96aff
Add docs-builder configuration file
plamenmitrev Jan 7, 2025
b3ba878
Delete unused articles
plamenmitrev Jan 7, 2025
8d97988
Fix headers, CTA banners and other
plamenmitrev Jan 7, 2025
dfe32e0
fix header markdown
plamenmitrev Jan 8, 2025
a9ce506
Content fixes
plamenmitrev Jan 8, 2025
8ddbb81
Added all redirects and redirects for deleted sections
plamenmitrev Jan 9, 2025
eb3b067
Start migration to Docs-Builder and fix known issues
plamenmitrev Jan 10, 2025
3fc82cf
Fix code block syntax
plamenmitrev Jan 13, 2025
88f0c3c
Create docs-builder.yml
plamenmitrev Jan 13, 2025
9f7be3e
Fix headings, code blocks, properties
plamenmitrev Jan 13, 2025
540128e
Unify code blocks and fix some mistakes
plamenmitrev Jan 13, 2025
6668f1c
Updated html tables in markdown
plamenmitrev Feb 26, 2025
16e9b70
Add docs-builder configuration file
plamenmitrev Jan 7, 2025
14bdf95
Delete unused articles
plamenmitrev Jan 7, 2025
7a8054e
Fix headers, CTA banners and other
plamenmitrev Jan 7, 2025
4072e23
fix header markdown
plamenmitrev Jan 8, 2025
08aa45d
Content fixes
plamenmitrev Jan 8, 2025
f78e490
Added all redirects and redirects for deleted sections
plamenmitrev Jan 9, 2025
098c9e7
Start migration to Docs-Builder and fix known issues
plamenmitrev Jan 10, 2025
c90e47e
Fix code block syntax
plamenmitrev Jan 13, 2025
5f24415
Create docs-builder.yml
plamenmitrev Jan 13, 2025
9774ce8
Fix headings, code blocks, properties
plamenmitrev Jan 13, 2025
3f7b68e
Unify code blocks and fix some mistakes
plamenmitrev Jan 13, 2025
c8c2a8b
Updated html tables in markdown
plamenmitrev Feb 26, 2025
3cf75dd
Merge branch 'docs-builder-migration' of https://github.com/telerik/t…
plamenmitrev Mar 10, 2025
f338481
Fix KB headings, missing image references and code blocks
plamenmitrev Apr 1, 2025
c2d9e80
Update MD annotations in tables that did not work
plamenmitrev Apr 1, 2025
88d69f6
fix path-prefix
a-d-atanasov Apr 3, 2025
d1e6b04
changed primary color
a-d-atanasov Apr 3, 2025
d0a9709
Removed HTML and use markdown instead
plamenmitrev Apr 3, 2025
ab9e500
change publish to published
plamenmitrev Apr 3, 2025
932c8ca
fix typo
a-d-atanasov Apr 3, 2025
b75f199
fix typo and kb order
a-d-atanasov Apr 3, 2025
677e730
updated kbs order
a-d-atanasov Apr 3, 2025
37498e2
Remove windows authentication docs in load test profile.
a-d-atanasov Apr 3, 2025
e6bcef5
fix code block markdown
plamenmitrev Apr 3, 2025
27c026d
Merge branch 'docs-builder-migration' of https://github.com/telerik/t…
plamenmitrev Apr 3, 2025
3f87fcb
change product-name to Telerik Test Studio
plamenmitrev Apr 4, 2025
4bcd3e1
add language to code block
plamenmitrev Apr 4, 2025
bf85c1e
updated path-prefix for teststudio-dev and apis
a-d-atanasov Apr 4, 2025
992cdb7
delete IE article
plamenmitrev Apr 4, 2025
dca6fcb
remove expandable sections and format the article with MD
plamenmitrev Apr 4, 2025
86ef84d
Merge branch 'docs-builder-migration' of https://github.com/telerik/t…
plamenmitrev Apr 4, 2025
eba3ada
changed dev and apis primary color
a-d-atanasov Apr 4, 2025
ac03d6a
Fix code blocks missing closing annotation
plamenmitrev Apr 4, 2025
82f0041
fix code block
plamenmitrev Apr 4, 2025
b54277b
Merge branch 'docs-builder-migration' of https://github.com/telerik/t…
plamenmitrev Apr 4, 2025
b5dd9f2
Update translator tables to remove custom scripts
plamenmitrev Apr 4, 2025
68f2b4c
Update product-name
plamenmitrev Apr 4, 2025
3e954db
fix CTA panel name
plamenmitrev Apr 4, 2025
68cd7e5
rename the landing page
plamenmitrev Apr 4, 2025
7bb1964
fix md typo
plamenmitrev Apr 4, 2025
bd4c70d
add new redirects since the branch was created
plamenmitrev Apr 4, 2025
2de1e0d
Fix inline code that are discovered through testing
plamenmitrev Apr 4, 2025
5715fa2
fix order in Silverlight section
plamenmitrev Apr 4, 2025
040ff8d
fix trial link for dev edition
plamenmitrev Apr 4, 2025
b342c63
fix code block language that is not recognized
plamenmitrev Apr 4, 2025
203c4f7
add headings to translators for each product
plamenmitrev Apr 4, 2025
350cd19
fix code block objects
plamenmitrev Apr 4, 2025
a91c11d
remove custom expanders and fix CTA panel
plamenmitrev Apr 4, 2025
03d9b94
fix code blocks in dev edition
plamenmitrev Apr 4, 2025
836e9df
fix typo
plamenmitrev Apr 4, 2025
213e724
fix list indentation
plamenmitrev Apr 4, 2025
f1647a2
fix code blocks in api testing
plamenmitrev Apr 4, 2025
cb5bde1
fix CTA panels
plamenmitrev Apr 4, 2025
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
4 changes: 2 additions & 2 deletions docs-apitesting/advanced-topics/ci-server-integration.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ page_title: CI Server Integration
description: "Progress® Test Studio® for APIs - CI Server Integration"
previous_url: /api-testing/advanced-topics
position: 1
publish: true
published: true
---

# CI Server Integration
Expand All @@ -14,7 +14,7 @@ Continuous Integration regularly integrates the individual developer's changes i
Thanks to its command line interface, Test Studio for APIs can easily be integrated in most famous CI Servers.

{% if site.has_cta_panels == true %}
{% include cta-panel-teststudio-overview.html %}
{% include cta-panel-overview.html %}
{% endif %}

## Jenkins Integration
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/advanced-topics/configure-custom-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Configure Custom Proxy
page_title: Configure Custom Proxy
description: "Progress® Test Studio® for APIs - CI Server Integration"
position: 2
publish: true
published: true
---

# Overview
Expand Down
59 changes: 59 additions & 0 deletions docs-apitesting/docs-builder.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
#top nagivation might be wrong
top-navigation-product: api-testing
path-prefix: /teststudio-apis/documentation
product-id: 1720
product-name: Telerik Test Studio for APIs
product-url: https://www.telerik.com/teststudio-apis
search-engine-id: 001595215763381649090:lxlmtcw2g-u
cta-overview: "@ProductLink is a test automation platform for web, WPF, and responsive web applications, supporting UI, functional, load, and RESTful API testing. Sign up for a free 30-day trial!"
cta-intro: "@ProductLink is a test automation platform for web, WPF, and responsive web applications, supporting UI, functional, load, and RESTful API testing. Sign up for a free 30-day trial!"
default-title-prefix: Telerik Test Studio for APIs
avatar-path: ./images/avatar-ninja.svg
no-results-image-path: ./images/ninja-no-results.svg
primary-color:
light: "#1D8800"
dark: "#68BF51"

product-code: TESTSTUDIOAPI
product-trial-url: https://www.telerik.com/try/test-studio-ultimate
contribute-url: https://github.com/telerik/teststudio-docs/edit/master/docs-apitesting
enable-tabbed-code-blocks: true
#pdf-cover-png-path: ./images/pdf-cover.png
img-max-width: 100%
table-layout: fixed


meta:
# === Test Studio for APIs Documentation Main Nodes ===
getting-started:
title: "Getting Started"
position: 2
features:
title: "Features"
position: 3
advanced-topics:
title: "Advanced Topics"
position: 4
troubleshooting-guide:
title: "Troubleshooting Guide"
position: 5

# Features Section
features/steps:
title: "Steps"
position: 1
features/code-features:
title: "Code Features"
position: 2
features/record:
title: "Record"
position: 3
features/command-line:
title: "Command Line Interface"
position: 4

redirects:
-
from: "^/?$"
to: "/"
type: Permanent
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Add Assembly Reference
page_title: Add Assembly Reference
description: "Progress® Test Studio® for APIs - Code Features - Add Assembly Reference"
position: 8
publish: true
published: true
---

# Add Assembly Reference
Expand Down
62 changes: 28 additions & 34 deletions docs-apitesting/features/code-features/code-behind-files.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Code-Behind Files
page_title: Code-Behind Files
description: "Progress® Test Studio® for APIs - Code Features - Code-Behind Files"
position: 2
publish: true
published: true
---

# Code-Behind Files
Expand Down Expand Up @@ -44,7 +44,7 @@ The example below shows hot to log messages to the test output before and after

![Base Test Methods][4]

```C#
````C#
// This method will execute before the start of the test case
public override void OnBeforeTestStarted()
{
Expand All @@ -56,9 +56,8 @@ public override void OnAfterTestCompleted()
{
this.Log.WriteLine("Ending the test case ...");
}
```

```VB
````
````VB
' This method will execute before the start of the test Case'
Public Overrides Sub OnBeforeTestStarted()
Log.WriteLine("The test case is starting ...")
Expand All @@ -68,7 +67,7 @@ End Sub
Public Overrides Sub OnAfterTestCompleted()
Log.WriteLine("Ending the test case ...")
End Sub
```
````

[Back to top](#Code-Behind-Files)

Expand All @@ -94,25 +93,24 @@ The **Context.SetValue** method sets a value to a runtime variable. You can stor

#### Examples

```C#
````C#
// This statement will create a variable named "user-name" with value "user1"
// in the scope of the current test case
this.Context.SetValue("user-name", "user1", o);

// This statement will create a variable named "user-id" with value 123
// in the root scope of the project
this.Context.SetValue("user-id", 123, 1);
```

```VB
````
````VB
// This statement will create a variable named "user-name" with value "user1"
// in the scope of the current test case
this.Context.SetValue("user-name", "user1", 0);

// This statement will create a variable named "user-id" with value 123
// in the root scope of the project
this.Context.SetValue("user-id", 123, 1);
```
````

[Back to top](#Code-Behind-Files)

Expand All @@ -135,19 +133,18 @@ The **Context.GetValue** method returns the value of a specified runtime variabl

#### Examples

```C#
````C#
string userName = this.Context.GetValue("user-name").ToString();
```

```VB
````
````VB
Dim userName As String = Context.GetValue("user-name").ToString()
```
````

> Remember to cast properly your variables when using Context.GetValue. The method returns an object and you need to be aware of where and how the target value was initially created. Any variable, created manually in the Variables pane in the UI, is stored as a string.

![Casting Variables][5]

```C#
````C#
int count = 5;
this.Context.SetValue("count", count, 0);

Expand All @@ -164,7 +161,7 @@ this.Log.WriteLine(newUserId.ToString());
// The "user-name" variable is stored as string, but you still need to convert it with .ToString()
string userName = this.Context.GetValue("user-name").ToString();
this.Log.WriteLine(userName);
```
````

[Back to top](#Code-Behind-Files)

Expand All @@ -180,13 +177,12 @@ The **ApiTestBase** base class exposes a **Log** property of type **ILog** which

#### Examples

```C#
````C#
this.Log.WriteLine("Logging some message from C# code ...");
```

```VB
````
````VB
Log.WriteLine("Logging some message from VB code ...")
```
````

> See the [Sample Project](../../getting-started/sample-project) for more examples.

Expand All @@ -198,7 +194,7 @@ The Telerik.ApiTesting.Framework namespace provides a basic assertion framework

The following methods ae available:

```C#
````C#
static void AreEqual<T>(T expected, T actual);

static void AreEqual<T>(T expected, T actual, string message);
Expand Down Expand Up @@ -226,9 +222,8 @@ static void IsNull(object value, string message);
static void IsTrue(bool condition);

static void IsTrue(bool condition, string message);
```

```VB
````
````VB
Shared Sub AreEqual(Of T)(expected As T, actual As T)

Shared Sub AreEqual(Of T)(expected As T, actual As T, message As String)
Expand Down Expand Up @@ -256,19 +251,18 @@ Shared Sub IsNull(value As Object, message As String)
Shared Sub IsTrue(condition As Boolean)

Shared Sub IsTrue(condition As Boolean, message As String)
```
````

> When an assertion fails, the execution of the test step will be terminated with status **failed** and the assertion message will be logged to the test output.

### Examples

```C#
Assert.AreEqual("administrator", actualValue);
```

```VB
````C#
Assert.AreEqual("administrator", actualValue);
```
````
````VB
Assert.AreEqual("administrator", actualValue)
````

![Assertion Error][6]

Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/code-features/code-items.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Code Items
page_title: Code Items
description: "Progress® Test Studio® for APIs - Code Features - Code Items"
position: 3
publish: true
published: true
---

# Code Items
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/code-features/coded-steps.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Coded Steps
page_title: Coded Steps
description: "Progress® Test Studio® for APIs - Code Features - Coded Steps"
position: 1
publish: true
published: true
---

# Coded Steps
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/code-features/compile-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Compile Project
page_title: Compile Project
description: "Progress® Test Studio® for APIs - Code Features - Compile Project"
position: 5
publish: true
published: true
---

# Compile Project
Expand Down
15 changes: 7 additions & 8 deletions docs-apitesting/features/code-features/debug-project.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Debug Project
page_title: Compile Project
description: "Progress® Test Studio® for APIs - Code Features - Debug Project"
position: 6
publish: true
published: true
---

# Debug Project
Expand All @@ -12,13 +12,12 @@ When a test project is compiled, Progress® Test Studio® for APIs generates a *

To launch the debugger in Visual studio, you can add a `Debugger.Launch()` statement in the code that you wish to debug. (You wll need a `using System.Diagnostics` statement too.)

```C#
`Debugger.Launch();
```

```VB
`Debugger.Launch()`
```
````C#
Debugger.Launch();
````
````VB
Debugger.Launch()
````

![Add Debug Statement][1]

Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/code-features/output-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Output Panel
page_title: Output Panel
description: "Progress® Test Studio® for APIs - Code Features - Output Panel"
position: 7
publish: true
published: true
---

# Output Panel
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/code-features/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Overview
page_title: Overview
description: "Progress® Test Studio® for APIs - Code Features - Overview"
position: 0
publish: true
published: true
---

# Code Features Overview
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Project Coding Language
page_title: Project Coding Language
description: "Progress® Test Studio® for APIs - Code Features - Project Coding Language"
position: 4
publish: true
published: true
---

# Project Coding Language
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Command Line Parameters
page_title: Command Line Parameters
description: "Progress® Test Studio® for APIs - Command Line Parameters"
position: 1
publish: true
published: true
---
# Command Line Parameters

Expand Down
4 changes: 2 additions & 2 deletions docs-apitesting/features/command-line/overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ title: Overview
page_title: Overview
description: "Progress® Test Studio® for APIs - Command Line Interface - Overview"
position: 0
publish: true
published: true
---
# Command Line Interface - Overview

Test Studio for APIs provides a Command Line Interface application (Telerik.ApiTesting.Runner.exe) that you can use to directly execute an existing test project without using the application's user interface.

{% if site.has_cta_panels == true %}
{% include cta-panel-teststudio-overview.html %}
{% include cta-panel-overview.html %}
{% endif %}

<br>
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/condition.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Condition
page_title: Condition
description: "Progress® Test Studio® for APIs - Condition"
position: 0
publish: true
published: true
---

# Condition
Expand Down
2 changes: 1 addition & 1 deletion docs-apitesting/features/project-explorer.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Project Explorer
page_title: Project Explorer
description: "Progress® Test Studio® for APIs - Project explorer functionality"
tags: project, explorer, mobile
publish: true
published: true
position: 0
---

Expand Down
Loading