Skip to content

Commit d196803

Browse files
DMiradakisDMiradakis
authored
Merge pull request #35 from DidactHQ/preparing-v1
Catching up on a lot of v1 wip
2 parents 84c912d + 932fd8b commit d196803

53 files changed

Lines changed: 1245 additions & 333 deletions

Some content is hidden

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

‎docs/.vitepress/config.ts‎

Lines changed: 72 additions & 109 deletions
Original file line numberDiff line numberDiff line change
@@ -75,8 +75,6 @@ export default defineConfig({
7575
{
7676
text: 'Resources',
7777
items: [
78-
// { text: 'FAQ', link: '/faq/index' },
79-
// { text: 'Internal Mechanics', link: '/resources/internal-mechanics' },
8078
{ text: 'Feedback', link: 'https://didact.featurebase.app' },
8179
{ text: 'Roadmap', link: 'https://didact.featurebase.app/roadmap' },
8280
{ text: 'Status', link: 'https://status.didact.dev' },
@@ -101,26 +99,16 @@ export default defineConfig({
10199
items: [
102100
{ text: 'Create a Flow Library', link: '/getting-started/quickstart/create-a-flow-library' },
103101
{ text: 'Write a Flow', link: '/getting-started/quickstart/write-a-flow' },
104-
// { text: 'Configure dependency injection', link: '/getting-started/quickstart/configure-dependency-injection' },
105-
{ text: 'Setup a database', link: '/getting-started/quickstart/setup-a-database' },
106-
{ text: 'Install Didact CLI', link: '/getting-started/quickstart/install-didact-cli'},
102+
{ text: 'Installation', link: '/getting-started/quickstart/installation' },
107103
{ text: 'Deploy Flow Library', link: '/getting-started/quickstart/deploy-flow-library' },
108-
{ text: 'Install Didact Engine', link: '/getting-started/quickstart/install-didact-engine' },
109-
{ text: 'Install Didact UI', link: '/getting-started/quickstart/install-didact-ui' },
110104
]
111105
},
112106
{
113-
text: 'Business',
107+
text: 'About',
114108
items: [
115109
{ text: 'Licensing and Monetization', link: '/getting-started/licensing-and-monetization' },
116-
{ text: 'Meet the Team', link: '/getting-started/meet-the-team' }
117-
]
118-
},
119-
{
120-
text: 'Open Source',
121-
items: [
122-
{ text: 'Structure', link: '/getting-started/open-source-structure' },
123-
{ text: 'Contributing', link: '/getting-started/contributing' },
110+
{ text: 'Meet the Team', link: '/getting-started/meet-the-team' },
111+
{ text: 'Contributing', link: '/getting-started/contributing' }
124112
]
125113
}
126114
],
@@ -140,62 +128,46 @@ export default defineConfig({
140128
{
141129
text: 'Setup',
142130
items: [
143-
{ text: 'Database', link: '/core-concepts/database/database-setup' },
144-
{
145-
text: 'Didact CLI',
146-
items: [
147-
{ text: 'Installation' },
148-
{ text: 'Config', link: '/core-concepts/didact-cli/cli-config' },
149-
{ text: 'Migrations', link: '/core-concepts/database/database-migrations' }
150-
]
151-
},
152-
{
153-
text: 'Didact Engine',
154-
items: [
155-
{ text: 'Installation', link: '/core-concepts/didact-engine/engine-installation' },
156-
{ text: 'Config', link: '/core-concepts/didact-engine/engine-config' },
157-
]
158-
},
159-
{
160-
text: 'Didact UI',
161-
items: [
162-
{ text: 'Installation', link: '/core-concepts/didact-ui/ui-installation' },
163-
{ text: 'Config', link: '/core-concepts/didact-ui/ui-config' },
164-
]
165-
}
131+
{ text: 'Installation', link: '/core-concepts/setup/installation' },
132+
{ text: 'Config', link: '/core-concepts/setup/config' }
166133
]
167134
},
168135
{
169136
text: 'Flow Libraries',
170137
items: [
171138
{ text: 'Create', link: '/core-concepts/flow-libraries/create-flow-libraries' },
172-
{ text: 'Setup Dependency Injection', link: '/core-concepts/flow-libraries/dependency-injection' },
173-
// { text: 'Versioning' }
139+
{ text: 'Dependency Injection', link: '/core-concepts/flow-libraries/dependency-injection' },
174140
]
175141
},
176142
{
177143
text: 'Flows',
178144
items: [
179145
{ text: 'Overview', link: '/core-concepts/flows/flows-overview' },
180-
{ text: 'Use Dependency Injection', link: '/core-concepts/flows/dependency-injection' },
146+
{ text: 'Dependency Injection', link: '/core-concepts/flows/dependency-injection' },
181147
{ text: 'Versioning', link: '/core-concepts/flows/flow-versioning' },
182148
{ text: 'Schedules' },
183149
{ text: 'Triggers' },
184-
{ text: 'Logging' },
185-
{ text: 'Retry Policies' },
186-
{ text: 'Queues' }
187-
// { text: 'Flow Variables', link: '/core-concepts/flows/flow-variables' },
188-
// { text: 'Execution Blocks', link: '/setup/required-credentials' },
150+
{ text: 'Logging', link: '/core-concepts/flows/logging' },
151+
{ text: 'Retry Policies' }
152+
]
153+
},
154+
{
155+
text: 'Platform',
156+
items: [
157+
{ text: 'Environments', link: '/core-concepts/environments' },
158+
{ text: 'Queues', link: '/core-concepts/queues' },
159+
{ text: 'Variables', link: '/core-concepts/variables' },
160+
{ text: 'Secrets', link: '/core-concepts/secrets' },
161+
// { text: 'Engine Tunings', link: '/core-concepts/engine-tunings' }
189162
]
190163
},
191164
{
192165
text: 'Deployments',
193166
items: [
194167
{ text: 'Overview', link: '/core-concepts/deployments/deployments-overview' },
195-
{ text: 'Environments' },
168+
{ text: 'Deployments File', link: '/core-concepts/deployments/deployments-file' },
196169
{ text: 'Deployment Types' },
197-
{ text: 'Workflow' },
198-
{ text: 'Targets' }
170+
{ text: 'Deployment Sources', link: '/core-concepts/deployments/deployment-sources' }
199171
]
200172
},
201173
// {
@@ -232,33 +204,36 @@ export default defineConfig({
232204
// { text: 'Engine Tuning', link: '/' }
233205
// ]
234206
// },
235-
{
236-
text: 'Advanced Features',
237-
items: [
238-
// { text: 'Versioning', link: '/' },
239-
// { text: 'Environments', link: '/' },
240-
{ text: 'Secrets Storage', link: '/' },
241-
// { text: 'Queus', link: '/' },
242-
{ text: 'Engine Tunings', link: '/' }
243-
]
244-
},
245207
{
246208
text: 'Licensing System',
247209
items: [
248-
// { text: 'Needs and Motivations', link: '/' },
249210
{ text: 'Terminology', link: '/core-concepts/licensing-system/terminology' },
250-
{ text: 'Authentication', link: '/core-concepts/licensing-system/authentication' },
251-
{ text: 'Validation', link: '/core-concepts/licensing-system/validation' },
252-
{ text: 'Features Validator', link: '/' },
253-
{ text: 'Failsafe Mechanics', link: '/' },
211+
{ text: 'License Key', link: '/core-concepts/licensing-system/license-keys' },
212+
{ text: 'Smart Key', link: '/core-concepts/licensing-system/smart-keys' },
213+
// { text: 'Features Validator', link: '/' },
214+
{ text: 'Failsafe Mechanics', link: '/core-concepts/licensing-system/failsafe-mechanics' },
254215
{ text: 'Uptime and Alerting', link: '/core-concepts/licensing-system/uptime-and-alerting' },
255216
// { text: 'Airgapped Systems', link: '/' }
256217
]
257218
},
258219
],
259220
'guides': [
260221
{
261-
text: 'CI/CD', link: '/'
222+
text: 'Maintenance',
223+
items: [
224+
{ text: 'Setup encryption key', link: '/guides/setup-encryption-key' },
225+
// { text: 'Rotate encryption keys', link: '/guides/rotate-encryption-keys' },
226+
{ text: 'Updating Didact' }
227+
]
228+
},
229+
{
230+
text: 'Deployments',
231+
items: [
232+
{ text: 'Deploy to filesystem' },
233+
{ text: 'Deploy to GitHub' },
234+
{ text: 'Deploy to Azure DevOps' },
235+
{ text: 'Deploy to Docker' }
236+
]
262237
},
263238
{
264239
text: 'Reverse Proxies',
@@ -273,78 +248,66 @@ export default defineConfig({
273248
{
274249
text: 'Infrastructure Deployments',
275250
items: [
251+
{ text: 'Windows Service' },
252+
{ text: 'Windows Server' },
276253
{ text: 'Azure VM' },
277254
{ text: 'AWS EC2' },
278255
{ text: 'Docker' },
279256
{ text: 'Kubernetes' }
280257
]
281258
},
282259
{
283-
text: 'Scaling', link: '/'
260+
text: 'CICD'
284261
},
285262
{
286-
text: 'Updating', link: '/'
263+
text: 'Scaling', link: '/'
287264
}
288265
],
289-
// '/deployments/': [
290-
// {
291-
// text: 'Self-hosted',
292-
// items: [
293-
// { text: 'Deploy Didact Engine', link: '/setup/' },
294-
// { text: 'Deploy Didact UI', link: '/setup/what-is-displagent' },
295-
// { text: 'Deploy Didact Sentinel', link: '/setup/' },
296-
// { text: 'Multiple Engines', link: '/setup/required-credentials' },
297-
// ]
298-
// },
299-
// {
300-
// text: 'Containerization',
301-
// items: [
302-
// { text: 'Deploy Didact Engine', link: '/setup/' },
303-
// { text: 'Deploy Didact UI', link: '/setup/what-is-displagent' },
304-
// { text: 'Deploy Didact Sentinel', link: '/setup/' },
305-
// { text: 'Multiple Engines', link: '/setup/required-credentials' },
306-
// ]
307-
// }
308-
// ],
309266
'/api/': [
310267
{
311268
text: 'Didact CLI',
312-
collapsed: true,
269+
collapsed: false,
313270
items: [
314271
{ text: 'version', link: '/api/didact-cli/version' },
272+
{ text: 'install', link: '/api/didact-cli/install' },
273+
{ text: 'migrate', link: '/api/didact-cli/migrate' },
274+
{ text: 'start', link: '/api/didact-cli/start' },
315275
// { text: 'update' },
316-
// { text: 'config', link: '/api/didact-cli/config' },
317276
{ text: 'config init', link: '/api/didact-cli/config-init' },
277+
{ text: 'config profile init', link: '/api/didact-cli/config-profile-init' },
278+
{ text: 'config profile activate', link: '/api/didact-cli/config-profile-activate' },
318279
{ text: 'config set', link: '/api/didact-cli/config-set' },
319280
{ text: 'config inspect', link: '/api/didact-cli/config-inspect' },
320-
{ text: 'migrate', link: '/api/didact-cli/migrate' },
321281
{ text: 'environment init', link: '/api/didact-cli/environment-init' },
322282
{ text: 'environment list', link: '/api/didact-cli/environment-list' },
323283
{ text: 'license authenticate', link: '/api/didact-cli/license-authenticate' },
284+
{ text: 'license refresh', link: '/api/didact-cli/license-refresh' },
324285
// { text: 'license validate', link: '/api/didact-cli/license-validate' },
325-
{ text: 'engine install', link:'/api/didact-cli/engine-install' },
326-
{ text: 'engine config init', link: '/api/didact-cli/engine-config-init' },
327-
{ text: 'engine config set', link: '/api/didact-cli/engine-config-set' },
328-
{ text: 'engine config inspect', link: '/api/didact-cli/engine-config-inspect' },
329-
{ text: 'engine run', link: '/api/didact-cli/engine-run' },
330-
{ text: 'ui install', link: '/api/didact-cli/ui-install' },
331-
{ text: 'ui config init', link: '/api/didact-cli/ui-config-init' },
332-
{ text: 'ui config set', link: '/api/didact-cli/ui-config-set' },
333-
{ text: 'ui config inspect', link: '/api/didact-cli/ui-config-inspect' },
334-
{ text: 'ui run', link: '/api/didact-cli/ui-run' },
335-
// { text: 'library list', link: '/api/didact-cli/library-list' },
336-
// { text: 'library add', link: '/api/didact-cli/library-add' },
337-
// { text: 'library remove', link: '/api/didact-cli/library-remove' },
338-
// { text: 'library deploy', link: '/api/didact-cli/library-deploy' },
286+
// { text: 'engine install', link:'/api/didact-cli/engine-install' },
287+
// { text: 'engine config init', link: '/api/didact-cli/engine-config-init' },
288+
// { text: 'engine config set', link: '/api/didact-cli/engine-config-set' },
289+
// { text: 'engine config inspect', link: '/api/didact-cli/engine-config-inspect' },
290+
// { text: 'engine run', link: '/api/didact-cli/engine-run' },
291+
// { text: 'ui install', link: '/api/didact-cli/ui-install' },
292+
// { text: 'ui config init', link: '/api/didact-cli/ui-config-init' },
293+
// { text: 'ui config set', link: '/api/didact-cli/ui-config-set' },
294+
// { text: 'ui config inspect', link: '/api/didact-cli/ui-config-inspect' },
295+
// { text: 'ui run', link: '/api/didact-cli/ui-run' },
339296
{ text: 'deployment init', link: '/api/didact-cli/deployment-init' },
340-
{ text: 'deployment config' },
341-
{ text: 'deployment push', link: '/api/didact-cli/deployment-push' },
342-
// { text: 'cron validate' }
297+
{ text: 'deployment set', link: '/api/didact-cli/deployment-set' },
298+
{ text: 'deployment version', link: '/api/didact-cli/deployment-version' },
299+
{ text: 'deployment-profile init', link: '/api/didact-cli/deployment-profile-init' },
300+
{ text: 'deployment profile sources', items: [
301+
{ text: 'deployment-profile-source set filesystem', link: '/api/didact-cli/deployment-profile-source-set-filesystem' }
302+
]},
303+
{ text: 'deployment generate', link: '/api/didact-cli/deployment-generate' },
304+
{ text: 'deployment inspect', link: '/api/didact-cli/deployment-inspect' },
305+
{ text: 'encryption-key generate', link: '/api/didact-cli/encryption-key-generate' },
306+
// { text: 'encryption-key rotate', link: '/api/didact-cli/encryption-key-rotate' }
343307
]
344308
},
345309
{ text: 'REST API', link: '/' },
346310
{ text: 'Didact Core', link: '/' },
347-
{ text: 'Didact Cron', link: '/' },
348311
{ text: 'Errors and Exceptions', link: '/' }
349312
]
350313
},

‎docs/api/didact-cli/config-init.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Config Init
22

3-
Initializes a new `cliconfig.json` file for Didact CLI.
3+
Initializes a new [config file](/core-concepts/setup/config#config-file) and creates and activates a `default` [config profile](/core-concepts/setup/config#config-profiles).
44

55
```bash-vue
66
didact config init

‎docs/api/didact-cli/config-profile-activate.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config Profile Activate
2+
3+
Activates a [config profile](/core-concepts/setup/config#config-profiles) in Didact's [config file](/core-concepts/setup/config#config-file).
4+
5+
```bash-vue
6+
didact config profile activate <PROFILE_NAME>
7+
```
8+
9+
- `<PROFILE_NAME>` (string): The name of the config profile.
10+
11+
## Examples
12+
13+
Activates the config profile named `production`.
14+
15+
```bash
16+
didact config profile activate production
17+
```

‎docs/api/didact-cli/config-profile-init.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Config Profile Init
2+
3+
Initializes a new [config profile](/core-concepts/setup/config#config-profiles) in Didact's [config file](/core-concepts/setup/config#config-file).
4+
5+
```bash-vue
6+
didact config profile init <PROFILE_NAME>
7+
```
8+
9+
- `<PROFILE_NAME>` (string): The name of the new config profile.
10+
11+
## Examples
12+
13+
Initialize a new config profile named `production`.
14+
15+
```bash
16+
didact config profile init production
17+
```

‎docs/api/didact-cli/config-set.md‎

Lines changed: 9 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -3,35 +3,30 @@
33
Sets a configuration key and value for Didact CLI.
44

55
```bash-vue
6-
didact config set --key "<KEY_NAME>" --value <KEY_VALUE>
6+
didact config set <KEY_NAME> <KEY_VALUE>
77
```
88

9-
## Options
10-
- `--key` (string): The name of the configuration key.
11-
- `--value` (string or number or boolean or null): The value of the configuration key.
9+
- `<KEY_NAME>` (string): The config setting name.
10+
- `<KEY_VALUE>` (any): The config setting value.
1211

13-
For a full list of the config keys that you can set, see the [config key matrix](/core-concepts/didact-cli/cli-config#cliconfig-json-key-matrix).
12+
::: info
13+
For a list of all config settings, see the [config page](/core-concepts/setup/config#config-settings). The settings must be referenced by their exact JSON dot notation.
14+
:::
1415

1516
## Examples
1617

1718
Set the database provider and database connection string in back-to-back commands.
1819

1920
```bash
20-
didact config set --key "Database.Provider" --value "SQLServer"
21+
didact config set Database.Provider SQLServer
2122
```
2223

2324
```bash
24-
didact config set --key "Database.ConnectionString" --value "localhost"
25-
```
26-
27-
Set the default environment.
28-
29-
```bash
30-
didact config set --key "Environment" --value "Production"
25+
didact config set Database.ConnectionString "localhost"
3126
```
3227

3328
Set the license key.
3429

3530
```bash
36-
didact config set --key "LicenseKey" --value "someAPIKeyabd123..."
31+
didact config set LicenseKey someAPIKeyabd123...
3732
```

‎docs/api/didact-cli/deployment-generate.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Deployment Generate
2+
3+
Generates a new deployment from the specified [deployment profile](/core-concepts/deployments/deployments-file#deployment-profiles).
4+
5+
```bash
6+
didact deployment generate --profile <PROFILE_NAME>
7+
```
8+
9+
- `--profile` (string): The name of the target deployment profile to generate the new deployment from.
10+
11+
## Examples
12+
13+
Generate a new deployment from a deployment profile named `default`.
14+
15+
```bash
16+
didact deployment generate --profile default
17+
```

0 commit comments

Comments
 (0)