Docs/mkdocs.yml at master · ComposableAnalytics/Docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
site_name: Composable DataOps Platform
site_url: https://docs.composable.ai/en/latest/
site_description: Composable DataOps Platform technical documentation for big data orchestration, automation and analytics
site_author: Composable Analytics, Inc.

repo_url: https://github.com/ComposableAnalytics/Docs

theme:
    name: material
    custom_dir: 'themeExtension'
    palette:
      primary: blue grey
    logo: img/Composable_Logo.svg
    features:
      - toc.integrate

nav:
- Home: 'index.md'
- About: 'about/about.md'
#- Documentation:
- 1. Getting Started:
    - '1.1 Overview': 'Getting-Started/01.Overview.md'
    - '1.2 System Requirements': 'Getting-Started/02.System-Requirements.md'
    - '1.3 Installation and Deployment': 'Getting-Started/03.Installation-and-Deployment.md'
    - Installation Options:
        - 'Composable Installer - GUI': 'Getting-Started/03-1.Installation-GUI.md'
        - 'Deployment Scripts': 'Getting-Started/03-2.Deployment-Scripts.md'
        - 'Entra ID / AD Authentication': 'Getting-Started/03-3.Azure-Authentication.md'
- 2. Composable Platform:
    - '2.1 Overview': 'Composable-Platform/01.Overview.md'
    - '2.2 Navigation': 'Composable-Platform/02.Navigation.md'
    - '2.3 Search': 'Composable-Platform/03.Search.md'
    - '2.4 Product Areas': 'Composable-Platform/04.Product-Areas.md'
    - '2.5 System Administration': 'Composable-Platform/05.System-Administration.md'
- 3. DataFlows:
    - '3.1 Overview': 'DataFlows/01.Overview.md'
    - '3.2 Composable Designer': 'DataFlows/02.Composable-Designer.md'
    - '3.3 KeyBoard Shortcuts': 'DataFlows/03.KeyBoard-Shortcuts.md'
    - '3.4 Modules': 'DataFlows/04.Modules.md'
    - '3.5 DataFlows': 'DataFlows/05.DataFlows.md'
    - '3.6 DataFlow Reuse': 'DataFlows/06.DataFlow-Reuse.md'
    - '3.7 DataFlow Resume': 'DataFlows/DataFlow-Resume.md'
    - '3.8 DataFlow Error Handling': 'DataFlows/DataFlow-Error-Handling.md'
    - '3.9 DataFlow Runs': 'DataFlows/10.Runs.md'
    - '3.10 Custom Module Extensions': 'DataFlows/07.Custom-Modules.md'
    - 3.11 Module Details:
        - 'Code Module': 'DataFlows/09.Module-Details/Code-Module.md'
        - 'DataLab Notebook Runner': 'DataFlows/09.Module-Details/DataLabNotebookRunner.md'
        - 'DataPortal Delete Module': 'DataFlows/09.Module-Details/DataPortalDelete.md'
        - 'DataPortal Sync Module': 'DataFlows/09.Module-Details/DataPortalSync.md'
        - 'DataPortal Query Module': 'DataFlows/09.Module-Details/DataPortalQuery.md'
    - '3.12 DataFlow Testing': 'DataFlows/Testing.md'
- 4. QueryViews:
    - '4.1 Overview': 'QueryViews/01.Overview.md'
    - '4.2 QueryView Basics': 'QueryViews/02.Create-QueryView.md'
    - '4.3 Paging': 'QueryViews/Paging.md'
    - '4.4 Inputs': 'QueryViews/Inputs.md'
    - '4.5 Child QueryViews': 'QueryViews/ChildrenQueries.md'
    - '4.6 Actions': 'QueryViews/Actions.md'
    - '4.7 Hyperlinks': 'QueryViews/Hyperlinks.md'
- 5. DataPortals:
    - '5.1 Overview': 'DataPortals/01.Overview.md'
    - '5.2 DataPortal Basics': 'DataPortals/02.Create-DataPortals.md'
    - '5.3 Master Sheets': 'DataPortals/03.MasterSheet.md'
    - '5.4 Container Sheets': 'DataPortals/04.ContainerSheet.md'
    - 5.5 Control Types:
        - 'AppRun': 'DataPortals/05.Control-Details/AppRun.md'
        - 'Category': 'DataPortals/05.Control-Details/Category.md'
        - 'ClearButton': 'DataPortals/05.Control-Details/ClearButton.md'
        - 'CheckBox': 'DataPortals/05.Control-Details/CheckBox.md'
        - 'Computed': 'DataPortals/05.Control-Details/Computed.md'
        - 'Date': 'DataPortals/05.Control-Details/Date.md'
        - 'DateTime': 'DataPortals/05.Control-Details/DateTime.md'
        - 'HyperLink': 'DataPortals/05.Control-Details/HyperLink.md'
        - 'File': 'DataPortals/05.Control-Details/File.md'
        - 'Label': 'DataPortals/05.Control-Details/Label.md'
        - 'Link': 'DataPortals/05.Control-Details/Link.md'
        - 'NumberFormatting': 'DataPortals/05.Control-Details/NumberFormatting.md'
        - 'Page': 'DataPortals/05.Control-Details/Page.md'
        - 'Percent': 'DataPortals/05.Control-Details/Percent.md'
        - 'Phone': 'DataPortals/05.Control-Details/Phone.md'
        - 'Pill': 'DataPortals/05.Control-Details/Pill.md'
        - 'QueryView': 'DataPortals/05.Control-Details/QueryView.md'
        - 'QueryViewChooser': 'DataPortals/05.Control-Details/QueryViewChooser.md'
        - 'Radio': 'DataPortals/05.Control-Details/Radio.md'
        - 'Rating': 'DataPortals/05.Control-Details/Rating.md'
        - 'Reference': 'DataPortals/05.Control-Details/Reference.md'
        - 'SaveButton': 'DataPortals/05.Control-Details/SaveButton.md'
        - 'Spin': 'DataPortals/05.Control-Details/Spin.md'
        - 'SSN': 'DataPortals/05.Control-Details/SSN.md'
        - 'SSNMasked': 'DataPortals/05.Control-Details/SSNMasked.md'
        - 'Tab': 'DataPortals/05.Control-Details/Tab.md'
        - 'Table': 'DataPortals/05.Control-Details/Table.md'
        - 'Text': 'DataPortals/05.Control-Details/Text.md'
        - 'Textarea': 'DataPortals/05.Control-Details/Textarea.md'
        - 'User': 'DataPortals/05.Control-Details/User.md'
        - 'Voice': 'DataPortals/05.Control-Details/Voice.md'
        - 'YesNo': 'DataPortals/05.Control-Details/YesNo.md'
        - 'ZIP': 'DataPortals/05.Control-Details/ZIP.md'
    - 5.6 Container Fields:
        - 'AfterSaveUri': 'DataPortals/06.Setting-Details/AfterSaveUri.md'
        - 'CategoryCondition': 'DataPortals/06.Setting-Details/CategoryCondition.md'
        - 'ClearWhenHidden': 'DataPortals/06.Setting-Details/ClearWhenHidden.md'
        - 'Columns': 'DataPortals/06.Setting-Details/Columns.md'
        - 'ComputedCondition': 'DataPortals/06.Setting-Details/ComputedCondition.md'
        - 'ControlGroup': 'DataPortals/06.Setting-Details/ControlGroup.md'
        - 'ControlType': 'DataPortals/06.Setting-Details/ControlType.md'
        - 'CustomIndex': 'DataPortals/06.Setting-Details/CustomIndex.md'
        - 'DefaultSearchFilter': 'DataPortals/06.Setting-Details/DefaultSearchFilter.md'
        - 'DefaultValue': 'DataPortals/06.Setting-Details/DefaultValue.md'
        - 'DeleteType': 'DataPortals/06.Setting-Details/DeleteType.md'
        - 'Description': 'DataPortals/06.Setting-Details/Description.md'
        - 'DisplayName': 'DataPortals/06.Setting-Details/DisplayName.md'
        - 'EndLabel': 'DataPortals/06.Setting-Details/EndLabel.md'
        - 'FormattingLocale': 'DataPortals/06.Setting-Details/FormattingLocale.md'
        - 'FormattingOptions': 'DataPortals/06.Setting-Details/FormattingOptions.md'
        - 'Group': 'DataPortals/06.Setting-Details/Group.md'
        - 'Href': 'DataPortals/06.Setting-Details/Href.md'
        - 'InvalidMessage': 'DataPortals/06.Setting-Details/InvalidMessage.md'
        - 'MaskedCondition': 'DataPortals/06.Setting-Details/MaskedCondition.md'
        - 'Max': 'DataPortals/06.Setting-Details/Max.md'
        - 'Min': 'DataPortals/06.Setting-Details/Min.md'
        - 'Name': 'DataPortals/06.Setting-Details/Name.md'
        - 'OptionController': 'DataPortals/06.Setting-Details/OptionController.md'
        - 'Pattern': 'DataPortals/06.Setting-Details/Pattern.md'
        - 'PatternFlags': 'DataPortals/06.Setting-Details/PatternFlags.md'
        - 'ReadOnlyCondition': 'DataPortals/06.Setting-Details/ReadOnlyCondition.md'
        - 'RefreshComponents': 'DataPortals/06.Setting-Details/RefreshComponents.md'
        - 'Required': 'DataPortals/06.Setting-Details/Required.md'
        - 'SaveBeforeRun': 'DataPortals/06.Setting-Details/SaveBeforeRun.md'
        - 'SearchBoxes': 'DataPortals/06.Setting-Details/SearchBoxes.md'
        - 'Separator': 'DataPortals/06.Setting-Details/Separator.md'
        - 'StartLabel': 'DataPortals/06.Setting-Details/StartLabel.md'
        - 'StrMax': 'DataPortals/06.Setting-Details/StrMax.md'
        - 'StrMin': 'DataPortals/06.Setting-Details/StrMin.md'
        - 'Style': 'DataPortals/06.Setting-Details/Style.md'
        - 'TabIndex': 'DataPortals/06.Setting-Details/TabIndex.md'
        - 'Target': 'DataPortals/06.Setting-Details/Target.md'
        - 'Type': 'DataPortals/06.Setting-Details/Type.md'
        - 'UniqueConstraint': 'DataPortals/06.Setting-Details/UniqueConstraint.md'
        - 'UniqueConstraintScopeToParent': 'DataPortals/06.Setting-Details/UniqueConstraintScopeToParent.md'
        - 'ValidationCondition': 'DataPortals/06.Setting-Details/ValidationCondition.md'
        - 'VisibilityCondition': 'DataPortals/06.Setting-Details/VisibilityCondition.md'
    - '5.7 Categories': 'DataPortals/05.Categories.md'
    - '5.8 Setting Sheets': 'DataPortals/06.SettingSheet.md'
    - '5.9 Search': 'DataPortals/03.Search-Features.md'
    - '5.10 Updating DataPortals': 'DataPortals/10.UpdateDataPortals.md'
- 6. DataRepository:
    - '6.1 Overview': 'DataRepository/01.Overview.md'
    - '6.2 DataRepository Basics': 'DataRepository/Create-DataRepository.md'
    - '6.3 Repository Details': 'DataRepository/Repository-Details.md'
    - '6.4 DeepQueries': 'DataRepository/DeepQuery-Overview.md'
    - '6.5 DeepQuery Basics': 'DataRepository/DeepQuery-Basics.md'
    - '6.6 DeepQuery Details': 'DataRepository/DeepQuery-Details.md'
    - 6.7 DeepQuery Fields:
        - 'Simple Fields': 'DataRepository/Field-Types/Simple.md'
        - 'Aggregate Fields': 'DataRepository/Field-Types/Aggregate.md'
        - 'Constant Fields': 'DataRepository/Field-Types/Constant.md'
    - 6.8 DeepQuery Filters:
        - 'Value Filters': 'DataRepository/Filter-Types/Value.md'
        - 'Condition Filters': 'DataRepository/Filter-Types/Condition.md'
    - 6.9 DeepQuery Collection Actions:
        - 'Add': 'DataRepository/Collection-Menu-Options/Add.md'
        - 'Remove': 'DataRepository/Collection-Menu-Options/Remove.md'
        - 'Edit': 'DataRepository/Collection-Menu-Options/Edit.md'
        - 'Link': 'DataRepository/Collection-Menu-Options/Link.md'
        - 'Add Field': 'DataRepository/Collection-Menu-Options/Add-Field.md'
        - 'Default Paging': 'DataRepository/Collection-Menu-Options/Default-Paging.md'
        - 'Rename': 'DataRepository/Collection-Menu-Options/Rename.md'
    - 6.10 DeepQuery Field Actions:
        - 'Add': 'DataRepository/Field-Menu-Options/Add.md'
        - 'Show': 'DataRepository/Field-Menu-Options/Show.md'
        - 'Remove': 'DataRepository/Field-Menu-Options/Remove.md'
        - 'Hide': 'DataRepository/Field-Menu-Options/Hide.md'
        - 'Edit': 'DataRepository/Field-Menu-Options/Edit.md'
        - 'Rename': 'DataRepository/Field-Menu-Options/Rename.md'
        - 'Add Filter': 'DataRepository/Field-Menu-Options/Add-Filter.md'
        - 'Edit Filter': 'DataRepository/Field-Menu-Options/Edit-Filter.md'
        - 'Aggregate': 'DataRepository/Field-Menu-Options/Aggregate.md'
        - 'Group By': 'DataRepository/Field-Menu-Options/Group-By.md'
        - 'Ungroup': 'DataRepository/Field-Menu-Options/Ungroup.md'
        - 'Link': 'DataRepository/Field-Menu-Options/Link.md'
- 7. DataCatalog:
    - '7.1 Overview': 'DataCatalogs/Overview.md'
- 8. DataLabs:
    - '8.1 Overview': 'DataLabs/Overview.md'
- 9. WebApps:
    - '9.1 Overview': 'WebApps/01.Overview.md'
    - '9.2 Creating a WebApp': 'WebApps/02.WebApp-Create-New.md'
    - '9.3 The WebApp Editor': 'WebApps/03.WebApp-Editor.md'
    - '9.4 WebApp Templates': 'WebApps/04.WebApp-Templates.md'
    - '9.5 Using Build Tools': 'WebApps/05.WebApp-Build-Tools.md'
- 10. Boards:
    - '10.1 Overview': 'Boards/01.Overview.md'
    - '10.2 Edit Mode': 'Boards/02.Edit-Mode.md'
    - '10.3 The Sidebar': 'Boards/03.The-Sidebar.md'
    - '10.4 View Mode': 'Boards/04.View-Mode.md'
    - '10.5 Details Mode': 'Boards/05.Details-Mode.md'
- 11. Keys:
    - '11.1 Overview': 'Keys/01.Overview.md'
    - '11.2 Using Keys': 'Keys/02.Using-Keys.md'
- 12. Users and Groups:
    - '12.1 Overview': 'Users-and-Groups/01.Overview.md'
    - '12.2 User Profile': 'Users-and-Groups/02.User-Profile.md'
- 13. FluentAPI:
    - '13.1 FluentAPI User Guide': 'FluentAPI/01.FluentAPI-User-Guide.md'
    - '13.2 FluentAPI Reference': 'FluentAPI/02.FluentAPI-Reference.md'
- 14. Code Promotion:
    - '14.1 Overview': 'Code-Promotion/01.Overview.md'
    - '14.2 Setup': 'Code-Promotion/02.Setup.md'
    - '14.3 Optional Settings': 'Code-Promotion/03.Optional-Settings.md'
    - '14.4 Possible-Issues': 'Code-Promotion/04.Possible-Issues.md'
- 15. System Monitoring and Visualization:
    - '15.1 Overview': 'Monitoring/01.Overview.md'
    - '15.2 Resource Networks': 'Monitoring/02.Resource-Network.md'
    - '15.3 Runs Visualization': 'Monitoring/03.Runs-Visualization.md'
- Tutorials:
    - 'DataFlow: "Hello, World!"': 'Tutorial/DataFlow-Hello-World.md'
    - 'DataFlow: Word Count Using Python and C#': 'Tutorial/DataFlow-Word-Count.md'
    - 'DataFlow: Image Processing DataFlows': 'Tutorial/DataFlow-Image-Processing.md'
    - 'DataFlow: Reading in Data from the Web': 'Tutorial/ReadingBlueBikes.md'
    - 'DataFlow: Lunch Recommender Slack App': 'Tutorial/Lunch.md'
    - 'QueryView: Creation from a DataPortal and Functionality Demo': 'Tutorial/QueryViewDataPortal.md'
    - 'DataPortal: Creating a Simple Survey Form': 'Tutorial/DataPortals-Survey.md'
    - 'DataPortal: ETL Logging and Monitoring': 'Tutorial/DataPortals-ETL-Logs.md'
    - 'DataPortal: Online Delivery App': 'Tutorial/DataPortals-DeliveryApp.md'
    - 'DataPortal: Creating a Database and Inserting Data': 'Tutorial/BlueBikesDataPortal.md'
    - 'WebApp: Creating a Full Stack WebApp': 'Tutorial/WebApp-Tutorial.md'
- Project Lab Series:
    - 'Overview': 'PLS/Overview.md'
    - 'NASDAQ API':
        - 'NASDAQ API Project goals': 'PLS/NASDAQ-API/0-NASDAQ-Goals.md'
        - 'Connect to the NASDAQ API': 'PLS/NASDAQ-API/1-ConnectAPI.md'
    - 'BlueBikes':
        - 'BlueBikes Project goals': 'PLS/BlueBikes/0-BlueBikes-Goals.md'
        - 'Lab 1: DataFlow - Reading Data from the Web': 'Tutorial/ReadingBlueBikes.md'
        - 'Lab 2: DataPortal - Creating a Database and Inserting Data': 'Tutorial/BlueBikesDataPortal.md'
        - 'Lab 3: QueryView - Querying, Filtering, and Generating an Interactive Map': 'Tutorial/QueryViewDataPortal.md'
- Videos:
    - 'Video Tutorials': 'Videos/Composable-Videos.md'
- References:
    - 'SQL Tutorial':
        - 'SQL Overview': 'References/01.SQL.Overview.md'
        - 'SQL Primer': 'References/02.SQL.Tutorial.md'
        - 'SQL Advanced Concepts': 'References/03.SQL.AdvancedConcepts.md'
    - 'DataOps Overview': 'References/02.DataOps.Overview.md'
    - 'ModelOps Overview': 'References/03.ModelOps.Overview.md'
    - 'LLMs Overview': 'References/04.LLMs.Overview.md'
    - 'Glossary': 'References/Glossary.md'

markdown_extensions:
  - admonition