Skip to content

initial version of studio pages #43

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
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
15 changes: 15 additions & 0 deletions docs/.vuepress/config.js
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,7 @@ module.exports = {
{ text: 'Getting Started', link: '/guide/' },
{ text: 'Tutorials', link: '/tutorials/'},
{ text: 'ObjectAPI Specification', link: '/objectapi/' },
{ text: 'API Solutions', link: '/solutions/' },
{ text: 'ObjectAPI Mappings', link: '/mappings/' } ,
{ text: 'ObjectLink Specification', link: '/objectlink/' }
]
Expand Down Expand Up @@ -81,6 +82,13 @@ module.exports = {
children: ['']
}
],
'/studio/': [
{
title: 'Desktop Studio',
collapsable: false,
children: ['', 'projects', 'new', 'dashboard', 'modules', 'solutions', 'simulations', 'monitoring', 'templates', 'logs', 'settings']
},
],
'/tutorials/': [
{
title: 'Tutorials',
Expand All @@ -95,6 +103,13 @@ module.exports = {
children: ['', 'cpp14-sdk', 'qtcpp-sdk', 'python-sdk', 'go-sdk', 'typescript-sdk']
}
],
'/solutions/': [
{
title: 'Solutions',
collapsable: false,
children: ['']
}
],
'/simulation/': [
{
title: 'Simulation',
Expand Down
7 changes: 7 additions & 0 deletions docs/solutions/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# API Solutions

The API solution document captures the configuration of API modules and the technology templates used to generate the source code. You can see it as a recipe for creating a larger single or multi layered SDK.

The solution consist of a set of layers. Each layer is a combination of API modules with a technology template and an output folder.

When a solution runs it generates for each layer a SDK. This is very helpful in case you want to create a solution based on the same API for multiple targets and languages.
7 changes: 7 additions & 0 deletions docs/studio/dashboard.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Dashboard

The dashboard shows you all the API documents in the project. These are typically API modules, solutions and simulation documents.

![Studio Dashboard](./studio-dashboard.png)

When you click on a document, you will open the document in a more detailed view. From there you can edit the document or delete it. Also i the specific view you can run the associated actions.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"Also i ???"
Looks like something is missing?

10 changes: 10 additions & 0 deletions docs/studio/index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
# Desktop Studio

The ApiGear Desktop Studio allows you to manage your API modules and solutions in a simple and intuitive way.
Furthermore, it provides access to the simulation docs and an overview of API events in the monitoring view.

![Desktop Studio](./studio-desktop.png)

The desktop application is available on windows/mac and linux. It can be installed from the [Studio download site](https://github.com/apigear-io/apigear-studio/releases).

At the bottom of the application you can find a link to the current version and to the API discussions forum.
5 changes: 5 additions & 0 deletions docs/studio/logs.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Log Events
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The log view will be added in the next version, I guess :)


The logs view shows you all the log messages in the project. Here you can get an overview of the behavior of the project and the application.

The logs show you log messages during code generation, monitoring and simulation. Also warnings and errors will be displayed here.
11 changes: 11 additions & 0 deletions docs/studio/modules.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# API Modules

The API Modules View shows you all the API modules in the project. You can edit and delete the documents.

![Studio Modules](./studio-modules.png)

API modules are typically used inside API solutions with technology templates to generate API SDKs.

An API module describes a set of interfaces and operations which can be translated to different output using the technology templates.

API Modules are described in detail in the [ObjectAPI guide](/objectapi).
11 changes: 11 additions & 0 deletions docs/studio/monitoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# API Monitor

The API Monitoring view shows you all the API events in the project. You can also halt the monitoring to better view th events. When you continue the monitoring, the events will continue with the latest events.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo: "to better view thE events"


![Studio Monitoring](./studio-monitor.png)

The events are ordered by the time with the newest on top. There are different events based if the event is an API call, a state change or a server side signal.

Each events shows the source of the event and the attached data.

Monitoring events are described in detail in the [monitoring guide](/monitoring).
5 changes: 5 additions & 0 deletions docs/studio/new.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# New Documents

To create a new document press the `New +` button and select the type of document you want to create. A dialog will open to enter the document name. The document will be created in the current project.

![New Document](./studio-new-docs.png)
19 changes: 19 additions & 0 deletions docs/studio/projects.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# API Projects

The dashboard shows the recently used API projects and allows you to create new API projects or import exiting projects.

![Studio Projects](./studio-projects.png)

:::tip
The API project is basically a folder with an `apigear` folder containing the API documents.
:::

To create a new project, click the `Create Project` button and enter the location of the project folder.

:::tip
Ensure yu always used the folder where the `apigear` folder is located in.
:::

- To import an existing project, click the `Import Project` button and provide the import location of the exiting project.
- To open an existing project, click the `Open Project` button and select the project folder.
- To open a recently used project, click one of the recent projects in the list.
5 changes: 5 additions & 0 deletions docs/studio/settings.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Settings

Settings allows you to set the different network settings for the monitor and simulation endpoints.

![Studio Settings](./studio-settings.png)
9 changes: 9 additions & 0 deletions docs/studio/simulations.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
# API Simulations

The API Simulation View shows you all the API simulation documents in the project. You can edit and delete the documents. You can also run the simulation, which will run a simulation server loaded with the selected simulation.

![Studio Simulations](./studio-simulations.png)

Now you can target your client API towards the simulation server and use the API to test the simulation, without a service backend required.

The simulation document format is described in the [simulation guide](/simulation).
7 changes: 7 additions & 0 deletions docs/studio/solutions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# API Solutions

The API Solutions View shows you all the API solutions in the project. You can edit and delete the documents. You can also run the solution, which will run all the API modules in the solution and generate the source code using the linked technology templates.

![Studio Solutions](./studio-solutions.png)

The solution document format is described in the [solutions guide](/solutions).
3 changes: 3 additions & 0 deletions docs/studio/studio-dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-desktop.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-footer.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-header.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-modules.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-monitor.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-new-docs.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-projects.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-settings.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-simulations.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-solutions.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions docs/studio/studio-templates.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
13 changes: 13 additions & 0 deletions docs/studio/templates.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# API Templates

The API Templates view shows you all the API templates in the project or available from the cloud. You can install, update or remove the templates.

These templates are listed at the ApiGEar template server and can be used to generate the source code for your API modules.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

casing: ApiGEar


To install your local custom templates, click the `Local Template` button and select the template package to be installed.

The installed packages are then available for your solutions to be used.

The currently available templates are listed in the [SDK Templates](/sdks) section.

If you are interested to create your own template or extend an existing template, please read the [template guide](/maker).