Skip to content

Commit 918aa75

Browse files
MrHinshMrHinsh
committed
💄 style(prettier): add prettier configuration for go template and html
- create a new .prettierrc file - configure prettier to use go-template parser for html files - set custom rules like bracket spacing and line width 📝 docs(content): remove quick start options section - delete quick start options from _index.md - streamline documentation content for better focus 🌐 i18n(hugo): enable config wizard feature flag - add configWizard feature flag to hugo.yaml files - enhance documentation localization capabilities ♻️ refactor(layouts): improve html structure and readability - adjust html layout for better readability - improve comments and spacing in config-wizard.html and list.html ✨ feat(js): enhance configuration wizard with new features - introduce JSON schema loading for configuration wizard - add processor and endpoint extraction from schema - improve migration type selection with dynamic options - refactor endpoint and processor configuration generation 🔧 chore(config): update yaml references and ids - change ids and urls in yaml files for consistency - ensure correct linking and referencing within the project
1 parent 10e237f commit 918aa75

File tree

12 files changed

+661
-189
lines changed

12 files changed

+661
-189
lines changed

‎.prettierrc‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
{
2+
"plugins": ["prettier-plugin-go-template"],
3+
"overrides": [
4+
{
5+
"files": ["*.html"],
6+
"options": {
7+
"parser": "go-template"
8+
}
9+
}
10+
],
11+
"goTemplateBracketSpacing": true,
12+
"bracketSameLine": true,
13+
"printWidth": 455,
14+
"formatOnSave": true
15+
}

‎docs/content/docs/_index.md‎

Lines changed: 0 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -10,36 +10,5 @@ discussionId: 2832
1010

1111
---
1212

13-
## Quick Start Options
1413

15-
<div class="row g-4 mb-5">
16-
<div class="col-md-6">
17-
<div class="card h-100 border-primary">
18-
<div class="card-body text-center">
19-
<div class="mb-3">
20-
<i class="fas fa-magic fa-3x text-primary"></i>
21-
</div>
22-
<h5 class="card-title">Configuration Wizard</h5>
23-
<p class="card-text">Build your configuration step-by-step with our interactive wizard. Perfect for beginners!</p>
24-
<a href="config-wizard/" class="btn btn-primary">
25-
<i class="fas fa-magic me-2"></i>Start Wizard
26-
</a>
27-
</div>
28-
</div>
29-
</div>
30-
<div class="col-md-6">
31-
<div class="card h-100 border-success">
32-
<div class="card-body text-center">
33-
<div class="mb-3">
34-
<i class="fas fa-book fa-3x text-success"></i>
35-
</div>
36-
<h5 class="card-title">Manual Configuration</h5>
37-
<p class="card-text">Follow our comprehensive getting started guide for manual configuration setup.</p>
38-
<a href="get-started/" class="btn btn-success">
39-
<i class="fas fa-book me-2"></i>Get Started
40-
</a>
41-
</div>
42-
</div>
43-
</div>
44-
</div>
4514

‎docs/data/classes/reference.processors.keepoutboundlinktargetprocessor.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ configurationSamples:
2020
"Enabled": false,
2121
"WIQLQuery": "Select [System.Id] From WorkItems Where [System.TeamProject] = @project and not [System.WorkItemType] contains 'Test Suite, Test Plan,Shared Steps,Shared Parameter,Feedback Request'",
2222
"TargetLinksToKeepOrganization": "https://dev.azure.com/nkdagility",
23-
"TargetLinksToKeepProject": "a1d99afb-901e-4ee5-8418-ba16ce04e7af",
23+
"TargetLinksToKeepProject": "76f8386f-3067-4dd4-ba51-65fc53d19d33",
2424
"CleanupFileName": "c:/temp/OutboundLinkTargets.bat",
2525
"PrependCommand": "start",
2626
"DryRun": true,

‎docs/hugo.canary.yaml‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,8 @@ buildDrafts: true
66
buildFuture: true
77
buildExpired: true
88

9+
params:
10+
features:
11+
configWizard: true
912

1013
# PullRequestNumber

‎docs/hugo.local.yaml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,3 +6,8 @@ buildFuture: true
66
buildExpired: true
77

88
disableAliases: true
9+
10+
11+
params:
12+
features:
13+
configWizard: true

‎docs/hugo.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@ summaryLength: 30
99
enableRobotsTXT: true
1010
enableGitInfo: true
1111

12+
13+
1214
# Disable default taxonomies (tags and categories)
1315
taxonomies: {}
1416

@@ -44,6 +46,8 @@ params:
4446
downloadUrl: "/download"
4547
menu_image_light: "/images/logo-wide-transparent-light.png"
4648
menu_image_dark: "/images/logo-wide-transparent-dark.png"
49+
features:
50+
configWizard: "none"
4751

4852
# Enable sitemap and robots.txt
4953
sitemap:

‎docs/layouts/config-wizard.html‎

Lines changed: 22 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,36 +1,32 @@
11
{{- define "main" }}
2-
<div class="container-fluid py-4">
3-
<div class="row justify-content-center">
4-
<div class="col-12" style="max-width: 1200px;">
5-
6-
{{/* Page header */}}
7-
<div class="text-center mb-5">
8-
<h1 class="display-4 text-primary mb-3">
9-
<i class="fas fa-magic me-3"></i>Configuration Wizard
10-
</h1>
11-
<p class="lead">Build your Azure DevOps Migration Tools configuration step-by-step</p>
12-
</div>
2+
<div class="container-fluid py-4">
3+
<div class="row justify-content-center">
4+
<div class="col-12" style="max-width: 1200px;">
5+
{{/* Page header */}}
6+
<div class="text-center mb-5">
7+
<h1 class="display-4 text-primary mb-3"><i class="fas fa-magic me-3"></i>Configuration Wizard</h1>
8+
<p class="lead">Build your Azure DevOps Migration Tools configuration step-by-step</p>
9+
</div>
1310

14-
{{/* Wizard container */}}
15-
<div id="config-wizard-app">
16-
{{/* Loading state */}}
17-
<div class="wizard-loading text-center py-5">
18-
<div class="spinner-border text-primary" role="status">
19-
<span class="visually-hidden">Loading...</span>
11+
{{/* Wizard container */}}
12+
<div id="config-wizard-app">
13+
{{/* Loading state */}}
14+
<div class="wizard-loading text-center py-5">
15+
<div class="spinner-border text-primary" role="status">
16+
<span class="visually-hidden">Loading...</span>
17+
</div>
18+
<p class="mt-3">Loading configuration wizard...</p>
2019
</div>
21-
<p class="mt-3">Loading configuration wizard...</p>
2220
</div>
2321
</div>
24-
2522
</div>
2623
</div>
27-
</div>
2824

29-
{{/* Load the wizard JavaScript and CSS */}}
30-
<link rel="stylesheet" href="/css/config-wizard.css">
31-
<script type="module" src="/js/config-wizard.js"></script>
25+
{{/* Load the wizard JavaScript and CSS */}}
26+
<link rel="stylesheet" href="/css/config-wizard.css" />
27+
<script type="module" src="/js/config-wizard.js"></script>
3228

33-
{{/* Pass Hugo data to JavaScript */}}
29+
{{/* Pass Hugo data to JavaScript */}}
3430
<script>
3531
window.migrationToolsData = {
3632
processors: {
@@ -61,7 +57,8 @@ <h1 class="display-4 text-primary mb-3">
6157
{{- end }}
6258
{{- end }}
6359
},
64-
baseURL: {{ .Site.BaseURL | jsonify }}
60+
baseURL: {{ .Site.BaseURL | jsonify }},
61+
schemaURL: "/schema/configuration.schema.json"
6562
};
6663
</script>
6764
{{- end }}

‎docs/layouts/docs/list.html‎

Lines changed: 44 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,10 @@
11
{{- define "main" }}
22
<div class="container-fluid py-4">
33
<div class="row justify-content-center">
4-
<div class="col-12" style="max-width: 1800px;">
4+
<div class="col-12" style="max-width: 1800px">
55
<div class="row">
66
{{/* Sidebar - Hidden on smaller screens */}}
7-
<div class="col-12 col-xl-3 docs-navbar-container d-none d-xl-block">
8-
{{ partial "docs/sidebar.html" . }}
9-
</div>
7+
<div class="col-12 col-xl-3 docs-navbar-container d-none d-xl-block">{{ partial "docs/sidebar.html" . }}</div>
108
{{/* Dropdown Navigation for smaller screens */}}
119
<div class="col-12 d-xl-none mb-3">
1210
<div class="dropdown">
@@ -44,7 +42,7 @@ <h5 class="card-title">
4442
{{ .Title }}
4543
</a>
4644
</h5>
47-
<p class="card-text text-muted">{{ .Description | markdownify }}</p>
45+
<p class="card-text text-muted">{{ .Description | markdownify }}</p>
4846

4947
{{/* Show child pages count */}}
5048
{{ if .Pages }}
@@ -77,13 +75,46 @@ <h5 class="card-title">
7775
</div>
7876
</div>
7977
{{ end }}
80-
8178
{{/* Page content */}}
82-
<div class="docs-body">
83-
{{ .Content | markdownify }}
84-
</div>
79+
<div class="docs-body">{{ .Content | markdownify }}</div>
8580

86-
81+
{{ if eq .RelPermalink "/docs/" }}
82+
{{ if .Site.Params.features.configWizard }}
83+
<h2>Quick Start Options</h2>
84+
<div class="row g-4 mb-5">
85+
<div class="col-md-6">
86+
<div class="card h-100 border-primary">
87+
<div class="card-body text-center">
88+
<div class="mb-3">
89+
<i class="fas fa-magic fa-3x text-primary"></i>
90+
</div>
91+
<h5 class="card-title">Configuration Wizard</h5>
92+
<p class="card-text">Build your configuration step-by-step with our interactive wizard. Perfect for beginners!</p>
93+
<a href="config-wizard/" class="btn btn-primary">
94+
<i class="fas fa-magic me-2"></i>
95+
Start Wizard
96+
</a>
97+
</div>
98+
</div>
99+
</div>
100+
<div class="col-md-6">
101+
<div class="card h-100 border-success">
102+
<div class="card-body text-center">
103+
<div class="mb-3">
104+
<i class="fas fa-book fa-3x text-success"></i>
105+
</div>
106+
<h5 class="card-title">Manual Configuration</h5>
107+
<p class="card-text">Follow our comprehensive getting started guide for manual configuration setup.</p>
108+
<a href="get-started/" class="btn btn-success">
109+
<i class="fas fa-book me-2"></i>
110+
Get Started
111+
</a>
112+
</div>
113+
</div>
114+
</div>
115+
</div>
116+
{{ end }}
117+
{{ end }}
87118

88119
{{/* Getting started section */}}
89120
{{ $gettingStarted := .Site.GetPage "/docs/get-started/getting-started/" }}
@@ -103,9 +134,8 @@ <h4 class="alert-heading">
103134
</div>
104135
{{ end }}
105136

106-
<div class="docs-comments">
107-
{{ partial "docs/comments.html" . }}
108-
</div>
137+
138+
<div class="docs-comments">{{ partial "docs/comments.html" . }}</div>
109139
</div>
110140
</div>
111141
</div>
@@ -114,6 +144,4 @@ <h4 class="alert-heading">
114144
</div>
115145
{{- end }}
116146

117-
{{- define "template" }}
118-
docs/list.html
119-
{{- end }}
147+
{{- define "template" }}docs/list.html{{- end }}

‎docs/layouts/list.html‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
<div class="container-fluid py-4">
33
<div class="row justify-content-center">
44
<div class="col-12" style="max-width: 1800px;">
5-
<div class="docs-body">
6-
{{ .Content | markdownify }}
7-
</div> </div> </div> </div>
5+
<div class="docs-body">
6+
{{ .Content | markdownify }}
7+
</div>
8+
</div>
9+
</div>
10+
</div>
811
{{- end }}
912
{{- define "template" }}
1013
_default/list.html

0 commit comments

Comments
 (0)