Skip to content

Commit 08f777f

Browse files
arnaud4dbasmaelyaagoubimidrissiguillaume-kotulskisalmaelbarboriQodly
authored
welcomed looker studio doc in 1.1.0 (#71)
* Update applicationOverview.png * Update settings.md * Add "Users Page" in the User Management Section * add the "Team Tab (Environment-specific)" section * "Billing Page" section added * Typo * "Subscription Page" section added * added the "Qodly Account Management" section * update how to * shipment-ready * Update intro.md * first draft * final draft * suggestions from samir * Update lang-classes.md * docs(webform-editor): generate docs for v0.3.20 * docs(webform-editor): generate docs for v0.3.20 & fix generator script * Revert "docs(webform-editor): generate docs for v0.3.20 & fix generator script" This reverts commit f5797fe. * Update to 3.6 * small fixes * fix: webform-editor package documentation * premieres correcs * fix mdx * fix * fixes on FAQ and outgoingMessageClass * update dependencies * update * put dot back * revert > to &gt * put &gt; back to avoid docusaurus for validating url * Update EntityClass.md * Data model - Support of singletons * Text input - Password tooltip * Rename OutGoingMessageClass.md to OutgoingMessageClass.md * Three-State Checkbox * Creation of version 1.0.0 * Datatable - Customizable Sorting Options * Update logEvent.md * Detailed Permission Review for Roles * Enhance Permission Review for Roles * Update "Roles & Privileges" to the latest * HTTP Handlers Overview * HTTP Handler Execution Flow * HTTP Handlers Matching Rules * HTTP Handlers - HTTP Methods (Verbs) * HTTP Handlers - Handling Errors * edit url modified link * Customize "Give Feedback on This Page" button * Fix Capitalization * preparing notes * up to pages * up to datasources * 90 percent * final draft for login tuto * States - Privilege (Has at least one privilege / has no privilege) * States - Privilege (Has at least one privilege / has no privilege) * States- Current State and Privilege Dropdown Behavior * fix error call constants * add versioned docs in preprocessing * Update preprocessing.conf added outgoingmessage * Update preprocessing.conf added outgoingmessage * States- Remove Dropdown Behavior for Parent states * Force change Update * fix searchAPI * Update Users class * updated the calls for the functions in the Users class to align with the renamed version * Fix the Users class. reference inclusion tag * Fix the Users class. reference inclusion tag * Fix the Users class. reference inclusion tag * Add Endpoints class doc * Fix the Endpoints class reference inclusion tag * Clarified Template Dragging Instructions for Improved Usability * Checkbox Component - Component-Specific Classes Changed * Fix the Endpoints class reference inclusion tag * update CSS styling for the selectBox component * update CSS classes styling for the selectBox component * Move compatibility behavior details to the release notes for Users class instantiation * Enhance Users class doc * Enhance Endpoints class doc * Update Templates warning tip * Roles and privileges - Remove the Describe action * Update Image * updated 1.0.0 release notes * fixed type and valueType commands * cryptokey update * users and sessions * Update version-1.0.0-sidebars.json * Update version-1.0.0-sidebars.json * Update access.md * Update access.md * MS proofread * Fix closing tag for `<details> * Add a Debugger Icon to the Explorer * fix support link * add google verification * added operators for ast * Direction Option for the Reveal Password Icon - Text Input Component * Text input component (Date type) - Handle intervals * "read only" was removed when the "disabled" option was added * Validation Rule for Qodly Source Selection in Saved Condition * Improve templates UX * Clear Non-Existing Resources - Privileges * Privileges Contextual Panel * add links * Update 1.1.0.md * Add QodlyEvents class doc * Update 1.1.0.md * Update QodlyEvents.md * Added QodlyEvents Class (Interface - Visible in Explorer) * QodlyEvents (Interface) vs cs.QodlyEvents (Singleton) * Update 1.1.0.md * Update textinput.md * Update 1.1.0.md * Added a detailed "Properties Panel Styling Options" section * Add row-reverse and column-reverse to the direction options - Properties Panel * Update 1.1.0.md * Update google key * Change Components directory order - alphabetically * Add the onClear event to the "Select Box" page * added httprequest handler programming guide, incomingmessage class, privileges for singletons * UI for editing HTTP Handlers * UI for editing HTTP Handlers * Update httpHandlers.md * Update httpHandlers.md * Update 1.1.0.md * tcpConnectionClass, added resources, note for singleton in tuto * Update 1.1.0.md * Update docusaurus.config.js * iterator Qodly Source ($This) - standard action, the only available actions are Drop and Copy * Update 1.1.0.md * Update docusaurus.config.js * Update docusaurus.config.js * Update docusaurus.config.js * versioned release notes * New "On Init" Event for Qodly Sources * Update 1.1.0.md * Update 1.1.0.md * Update 1.1.0.md * first version * Update roles-privileges-example.md * final 1st draft * tuto roles, final * Update example-of-configuration.md * small fix in roles and privileges * report tuto roles in 1.0.0 * versioned doc 1.1.0 * Added display-flex css styling on the text component * fixes in faq * Restructure the integration header page to include a custom component, REST API, and Looker connector * Added a "Guide Center" * Added "Known Issues": Unbounded Select Box Displays an Error Message * Revert "Added "Known Issues": Unbounded Select Box Displays an Error Message" This reverts commit 9388c1f. * Revert "Added a "Guide Center"" This reverts commit df9b46f. * Revert "Restructure the integration header page to include a custom component, REST API, and Looker connector" This reverts commit cd4682d. * Added "Known Issues": Unbounded Select Box Displays an Error Message * Added "Known Issues": Unbounded Select Box Displays an Error Message * Added a "Guide Center" * Renamed properties In the intervals datasource of the Text Input component * updated release note 1.1 * Added 1.2.0 release note * removed known issues * last notes version * Added display-flex css styling on the text component * tips * Update 1.2.0.md * Restructure the integration header page to include custom components, REST API, and Looker * guide slugs * Added Qodly Looker Studio Connector * Homepage "Integrations" desc updated * Update Qodly Looker connector link in Release note * Creating Reports in Looker Studio + Embedding them in Qodly * Added images + conclusion * seo fixes * removed webServer APIs * fixes * Update lang-quicktour.md * adjustments to Qodly Looker connector * Change website metadata * insert SEO keywords into each page's metadata based on the current URL path dynamically insert SEO keywords into each page's metadata based on the current URL path * Fix broken links after slug change for Data‑Model docs * Refactor docs: convert (fileID#anchor) links to (fileName.md#anchor) * Refactor docs: convert (fileID#anchor) links to (fileName.md#anchor) * Delete the one slash that sits immediately before a # inside a Markdown link’s URL * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * fix broken links * Replace <br/> between <li> tags with &nbsp; * Replace <br/> with &nbsp; * place <br/> inside the <li>...</li> tag * Test - place content directly inside an <li> to not breaks HTML structure and triggers the minifier error * fix * remove links from custom component api reference * fix broken links * remove links from custom component api reference * Added the Built-in Shared Qodly Namespace * Text input Interval - Include Toggle and Include Switch * Update 1.2.0.md * Update 1.2.0.md * fix tcp ## and bad link1.0.0 * Update TCPConnectionClass.md * Studio Overview - SEO name and alt text for images * UI State -Saved condition * Text input - range Interval Inconsistent Dates * Update 1.2.0.md * Matrix Customizable Scroll Positioning * Update 1.2.0.md * Centralized sidebar for full breakpoint management * Update 1.2.0.md * Breakpoint disabled status * Added the Variables Panel to the Debugger Sidebar * update release notes * detail the Variables Panel * Update 1.2.0.md * Update Matrix Selection Behavior * Roles and privileges UI - Rename the Clear button to Clean * Update HTTP handlers to match the New UI Implementation * Update 1.2.0.md * update version name * update version name * integration looker doc in 1.1 * added netkit menus --------- Co-authored-by: Basma El Yaagoubi <basma.elyaagoubi@4d.com> Co-authored-by: Mohamed IDRISSI <med.idrissi@outlook.com> Co-authored-by: Guillaume.kotulski <guillaume.kotulski@4d.com> Co-authored-by: Salma EL BARBORI <salma.elbarbori@4d.com> Co-authored-by: Basma El Yaagoubi <39849568+basmaelyaagoubi@users.noreply.github.com> Co-authored-by: Guillaume Kotulski <35215837+guillaume-kotulski@users.noreply.github.com>
1 parent 28ea66b commit 08f777f

File tree

415 files changed

+1721
-1339
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

415 files changed

+1721
-1339
lines changed

docs/api/$catalog.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ Each dataclass listed by the `$catalog` endpoint returns the following propertie
7171

7272

7373
:::tip
74-
Only the exposed dataclasses are shown in this list for your project's datastore. For more information, please refer to [Configuring Data Access](./overview#configuring-data-access) section.
74+
Only the exposed dataclasses are shown in this list for your project's datastore. For more information, please refer to [Configuring Data Access](./overview.md#configuring-data-access) section.
7575
:::
7676

7777
### Sample Usage Example in Postman

docs/api/$querypath.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ title: $querypath
1010
The `$querypath` endpoint allows developers to understand how queries are executed in the backend. It provides a step-by-step breakdown of the query execution, showing each operation, its performance, and the results obtained at each stage. It also reveales optimization techniques and the exact path taken by the server to fetch the required data.
1111

1212
:::info
13-
For additional information, please consult the ["About queryPlan and queryPath"](../language/DataClassClass#about-queryplan-and-querypath) documentation.
13+
For additional information, please consult the ["About queryPlan and queryPath"](../language/DataClassClass.md#about-queryplan-and-querypath) documentation.
1414
:::
1515

1616
### Syntax

docs/api/$queryplan.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ title: $queryplan
1212
The `$queryplan` endpoint is designed to provide insights into the execution strategy of queries processed by the server. This endpoint helps developers and database administrators to analyze and optimize query performance by returning a detailed breakdown of the query execution plan.
1313

1414
:::info
15-
For additional information, please consult the ["About queryPlan and queryPath"](../language/DataClassClass#about-queryplan-and-querypath) documentation.
15+
For additional information, please consult the ["About queryPlan and queryPath"](../language/DataClassClass.md#about-queryplan-and-querypath) documentation.
1616
:::
1717

1818
### Syntax

docs/api/$singleton.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ exposed function sayHello (value : string)
8585

8686
:::note
8787

88-
The `mySingleton` class and `sayHello` function are listed when you call the [`$catalog`]($catalog.md#singleton) command.
88+
The `mySingleton` class and `sayHello` function are listed when you call the [`$catalog`]($catalog.md#singletons) command.
8989

9090
:::
9191

docs/api/classFunctionsOverview.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ exposed function getTest() : string
2424
:::
2525

2626
:::info
27-
For more details, refer to the section on [Exposed vs. Non-Exposed Functions](../orda/data-model#exposed-vs-non-exposed-functions).
27+
For more details, refer to the section on [Exposed vs. Non-Exposed Functions](../orda/data-model.md#exposed-vs-non-exposed-functions).
2828
:::
2929

3030
### `onHttpGet` Functions
@@ -78,10 +78,10 @@ The ORDA REST API provides several endpoints to call class functions:
7878

7979
|Class function|Syntax|
8080
|---|----|
81-
|[Datastore Class](../orda/data-model#datastore)|`/rest/$catalog/DataStoreClassFunction`|
82-
|[Dataclass Class](../orda/data-model#dataclass)|`/rest/{{dataClass}}/DataClassClassFunction`|
83-
|[EntitySelection Class](../orda/data-model#entityselection-class)|`/rest/{{dataClass}}/EntitySelectionClassFunction`|
84-
|[Entity Class](../orda/data-model#entity-class)|`/rest/{{dataClass}}(key)/EntityClassFunction`|
81+
|[Datastore Class](../orda/data-model.md#datastore)|`/rest/$catalog/DataStoreClassFunction`|
82+
|[Dataclass Class](../orda/data-model.md#dataclass)|`/rest/{{dataClass}}/DataClassClassFunction`|
83+
|[EntitySelection Class](../orda/data-model.md#entityselection-class)|`/rest/{{dataClass}}/EntitySelectionClassFunction`|
84+
|[Entity Class](../orda/data-model.md#entity-class)|`/rest/{{dataClass}}(key)/EntityClassFunction`|
8585
|[Singleton class](../language/basics/lang-classes.md#singleton-classes)|`/rest/$singleton/SingletonClass/SingletonClassFunction` (see [$singleton page]($singleton.md))|
8686

8787

docs/api/dataclassEndpoints.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ The response structure for the `/rest/{{dataClass}}[2]` endpoint looks something
153153
```
154154

155155

156-
### rest/dataClass:attribute(value)
156+
### rest/dataClass\:attribute(value)
157157

158158
#### Purpose
159159

docs/api/overview.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,8 +28,8 @@ To restrict access to sensitive dataclasses such as those containing user creden
2828
<Column.List align="center" justifyContent="between">
2929
<Column.Item width="65%">
3030
<ol>
31-
<li>Open the Model Editor.</li> <br/>
32-
<li>Access the properties panel of the dataclass you intend to modify.</li> <br/>
31+
<li>Open the Model Editor.<br/></li>
32+
<li>Access the properties panel of the dataclass you intend to modify.<br/></li>
3333
<li>Enable the <code>Do not Expose as REST</code> option within the Scope property.</li>
3434
</ol>
3535
</Column.Item>
@@ -46,7 +46,7 @@ By default, attributes within these dataclasses are also exposed. To limit expos
4646
<Column.List align="center" justifyContent="between">
4747
<Column.Item width="65%">
4848
<ol>
49-
<li>In the Model Editor, select the attribute you intend to hide.</li> <br/>
49+
<li>In the Model Editor, select the attribute you intend to hide.<br/></li>
5050
<li>Enable the <code>Do not Expose as REST</code> option in the Scope property.</li>
5151
</ol>
5252
</Column.Item>

docs/cloud/apiKeys.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -93,9 +93,9 @@ In the API management section, each key includes options to:
9393
<Column.List align="center" justifyContent="between">
9494
<Column.Item width="55%">
9595
<ul>
96-
<li><strong>Show API Key</strong>: This button <img src={require('./img/api-show.png').default} style={{borderRadius: '6px', width: '7%'}} /> reveals the API key in the interface and includes a copy button <img src={require('./img/api-copy.png').default} style={{borderRadius: '6px', width: '6%'}} />, enabling easy duplication of the API key for use in configuring your application or services.</li><br/>
97-
<li><strong>Delete API Key</strong>: Positioned next to the API key, this button <img src={require('./img/api-delete.png').default} style={{borderRadius: '6px', width: '7%'}} /> removes the key upon confirmation, safeguarding against unintended deletions.</li><br/>
98-
<li><strong>Edit API Key</strong>: Also adjacent to the API display, the edit button <img src={require('./img/api-edit.png').default} style={{borderRadius: '6px', width: '7%'}} /> opens a configuration dialog for modifying the API key's details.</li><br/>
96+
<li><strong>Show API Key</strong>: This button <img src={require('./img/api-show.png').default} style={{borderRadius: '6px', width: '7%'}} /> reveals the API key in the interface and includes a copy button <img src={require('./img/api-copy.png').default} style={{borderRadius: '6px', width: '6%'}} />, enabling easy duplication of the API key for use in configuring your application or services.<br/></li>
97+
<li><strong>Delete API Key</strong>: Positioned next to the API key, this button <img src={require('./img/api-delete.png').default} style={{borderRadius: '6px', width: '7%'}} /> removes the key upon confirmation, safeguarding against unintended deletions.<br/></li>
98+
<li><strong>Edit API Key</strong>: Also adjacent to the API display, the edit button <img src={require('./img/api-edit.png').default} style={{borderRadius: '6px', width: '7%'}} /> opens a configuration dialog for modifying the API key's details.<br/></li>
9999
</ul>
100100
</Column.Item>
101101
<Column.Item width="40%">

docs/cloud/billingSubscriptionManagement.md

Lines changed: 14 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -20,10 +20,8 @@ The **Next Invoice** section displays the amount and date of your next scheduled
2020
<Column.List align="center" justifyContent="between">
2121
<Column.Item width="55%">
2222
<ul>
23-
<li><strong>Amount</strong>: The total cost of the upcoming invoice.</li>
24-
<br/>
25-
<li><strong>Billing Date</strong>: The scheduled date for the next payment.</li>
26-
<br/>
23+
<li><strong>Amount</strong>: The total cost of the upcoming invoice.<br/></li>
24+
<li><strong>Billing Date</strong>: The scheduled date for the next payment.<br/></li>
2725
<li><strong>View Details</strong>: Opens a breakdown of the invoice, showing the following details:</li>
2826
</ul>
2927
</Column.Item>
@@ -36,12 +34,9 @@ The **Next Invoice** section displays the amount and date of your next scheduled
3634
<Column.Item width="100%">
3735
<ul>
3836
<ul>
39-
<li><strong>Description</strong>: Items included in the subscription, such as: Qodly Power (computing resources), Storage extensions, and the Internet outbound data transfer packs.</li>
40-
<br/>
41-
<li><strong>Quantity</strong>: Amount of each resource being billed.</li>
42-
<br/>
43-
<li><strong>Unit Price</strong>: The price per unit of each resource.</li>
44-
<br/>
37+
<li><strong>Description</strong>: Items included in the subscription, such as: Qodly Power (computing resources), Storage extensions, and the Internet outbound data transfer packs.<br/></li>
38+
<li><strong>Quantity</strong>: Amount of each resource being billed.<br/></li>
39+
<li><strong>Unit Price</strong>: The price per unit of each resource.<br/></li>
4540
<li><strong>Total</strong>: The cost for each resource and the total sum of all charges.</li>
4641
</ul>
4742
</ul>
@@ -57,12 +52,9 @@ This section provides the status and cycle of your subscription, along with the
5752
<Column.List align="center" justifyContent="between">
5853
<Column.Item width="50%">
5954
<ul>
60-
<li><strong>Status</strong>: Indicates whether the subscription is active or inactive.</li>
61-
<br/>
62-
<li><strong>Start Date</strong>: The date your subscription began.</li>
63-
<br/>
64-
<li><strong>Billing Cycle Start/End</strong>: Defines the current subscription cycle's start and end dates.</li>
65-
<br/>
55+
<li><strong>Status</strong>: Indicates whether the subscription is active or inactive.<br/></li>
56+
<li><strong>Start Date</strong>: The date your subscription began.<br/></li>
57+
<li><strong>Billing Cycle Start/End</strong>: Defines the current subscription cycle's start and end dates.<br/></li>
6658
<li><strong>Payment Method</strong>: Displays the card currently linked to your subscription.</li>
6759
</ul>
6860
</Column.Item>
@@ -79,12 +71,9 @@ Clicking the <strong>Change Payment Method</strong> card <img src={require('./im
7971
<Column.List align="center" justifyContent="between">
8072
<Column.Item width="55%">
8173
<ul>
82-
<li><strong>Email</strong>: The associated email address.</li>
83-
<br/>
84-
<li><strong>Card Number</strong>: The new payment card details.</li>
85-
<br/>
86-
<li><strong>Expiration Date</strong> and <strong>Security Code (CVC)</strong>.</li>
87-
<br/>
74+
<li><strong>Email</strong>: The associated email address.<br/></li>
75+
<li><strong>Card Number</strong>: The new payment card details.<br/></li>
76+
<li><strong>Expiration Date</strong> and <strong>Security Code (CVC)</strong>.<br/></li>
8877
<li><strong>Country</strong>: The billing country for the card.</li>
8978
</ul>
9079
</Column.Item>
@@ -114,8 +103,7 @@ The **Invoices** section lists past invoices with downloadable options for recei
114103
Clicking the <strong>Download Invoice</strong> <img src={require('./img/billingDownloadInvoice.png').default} style={{borderRadius: '6px', width:'20%'}} /> button redirects you to a detailed invoice page where you can:
115104
<br/><br/>
116105
<ul>
117-
<li><strong>Download Invoice</strong>: Get a PDF copy of the invoice for record-keeping.</li>
118-
<br/>
106+
<li><strong>Download Invoice</strong>: Get a PDF copy of the invoice for record-keeping.<br/></li>
119107
<li><strong>Download Receipt</strong>: Obtain a receipt for accounting or reimbursement purposes.</li>
120108
</ul>
121109
</Column.Item>
@@ -201,10 +189,8 @@ The **Delete** <img src={require('./img/subscriptionDelete.png').default} style=
201189
<Column.List align="center" justifyContent="between">
202190
<Column.Item width="50%">
203191
<ul>
204-
<li>Available for all environments except Development.</li>
205-
<br/>
206-
<li>Requires entering the environment name in a confirmation dialog to prevent accidental deletions.</li>
207-
<br/>
192+
<li>Available for all environments except Development.<br/></li>
193+
<li>Requires entering the environment name in a confirmation dialog to prevent accidental deletions.<br/></li>
208194
<li>Once deleted, the environment and its associated resources are removed, and the subscription is updated.</li>
209195
</ul>
210196
</Column.Item>

docs/cloud/environmentsOverview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,8 +30,8 @@ For every environment, you can access your files on the server using the **Secur
3030
<Column.List align="center" justifyContent="between">
3131
<Column.Item width="40%">
3232
<ol>
33-
<li><strong>Click the Access files button</strong>: Navigate to the specific environment you want to manage and click the Access files button.</li><br/>
34-
<li><strong>Open your FTP Client</strong>: Use your preferred FTP client (e.g., Filezilla). This client will allow you to manage and transfer files securely.</li><br/>
33+
<li><strong>Click the Access files button</strong>: Navigate to the specific environment you want to manage and click the Access files button.<br/></li>
34+
<li><strong>Open your FTP Client</strong>: Use your preferred FTP client (e.g., Filezilla). This client will allow you to manage and transfer files securely.<br/></li>
3535
</ol>
3636
</Column.Item>
3737
<Column.Item width="55%">

0 commit comments

Comments
 (0)