Skip to content

Commit 6b8420a

Browse files
committed
📝 docs(tfs-work-item-migration-processor): remove deprecated anchor links
- remove redundant anchor links from section headers for cleaner documentation - improve readability by simplifying the markdown structure 💄 style(docs): enhance TOC and section heading styles - add optional class data rendering conditionally - improve table of contents with custom TOC items - add link icons to section headings for better navigation 💄 style(css): update container styling for responsiveness - apply media query for container width on larger screens - improve layout adaptability across different screen sizes
1 parent 5608b22 commit 6b8420a

File tree

4 files changed

+58
-24
lines changed

4 files changed

+58
-24
lines changed

site/content/docs/reference/processors/tfs-work-item-migration-processor/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ Overall, the `WorkItemMigrationContext` processor is a comprehensive tool for tr
2525

2626
---
2727

28-
## <a name="WIQLQuery"></a>WIQL Query
28+
## WIQL Query
2929

3030
The Work Item queries are all built using Work Item [Query Language (WIQL)](https://docs.microsoft.com/en-us/azure/devops/boards/queries/wiql-syntax). We only support flat quereis that have `FROM WorkItems` in the query.
3131

@@ -53,11 +53,11 @@ Limit to specific work items (for testing purposes)
5353
"WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.Id] in (123,456,789) AND [System.TeamProject] = @TeamProject AND [System.AreaPath] UNDER 'project\Team 1\' AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
5454
```
5555

56-
## <a name="NodeBasePath"></a>NodeBasePath Configuration
56+
## NodeBasePath Configuration
5757

5858
Moved to the TfsNodeStructure
5959

60-
# Iteration Maps and Area Maps
60+
## Iteration Maps and Area Maps
6161

6262
Moved to the TfsNodeStructure
6363

@@ -89,6 +89,6 @@ A complete list of [FieldMaps](../FieldMaps/index.md) are available.
8989

9090
> Note: These mappings could also be achieved with other forms of Field mapper e.g. `RegexFieldMapConfig`, but the value mapper as an example is easy to understand
9191
92-
# Removed Properties
92+
## Removed Properties
9393

9494
- PrefixProjectToNodes - This option was removed in favour of the Area and Iteration Maps on [TfsNodeStructure](/Reference/v2/ProcessorEnrichers/TfsNodeStructure/)

templates/ToolsSite/layouts/docs/single.html

Lines changed: 22 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,10 @@ <h1 class="docs-title">{{ .Title }}</h1>
3737

3838
{{/* Page content */}}
3939
<div class="docs-body">
40-
{{ partial "docs/class-data.html" . }}
40+
{{/* Optional class data */}}
41+
{{ if .Params.dataFile }}
42+
{{ partial "docs/class-data.html" . }}
43+
{{ end }}
4144
{{ .Content }}
4245
</div>
4346

@@ -47,11 +50,27 @@ <h1 class="docs-title">{{ .Title }}</h1>
4750
</div>
4851
</div>
4952
</div>
50-
5153
{{/* Table of contents (optional right sidebar) */}}
5254
<div class="col-xl-2 d-none d-xl-block">
55+
<h5>In this article</h5>
5356
<div class="docs-toc">
54-
{{ .TableOfContents }}
57+
<nav>
58+
<ul>
59+
{{/* Custom TOC items */}}
60+
{{ if .Params.dataFile }}
61+
62+
<li><a href="#options">Options</a></li>
63+
<li><a href="#examples">Examples</a></li>
64+
<li><a href="#metadata">Metadata </a></li>
65+
<li><hr /></li>
66+
{{ end }}
67+
68+
{{/* Generated TOC */}}
69+
{{ if .TableOfContents }}
70+
{{ .TableOfContents | safeHTML }}
71+
{{ end }}
72+
</ul>
73+
</nav>
5574
</div>
5675
</div>
5776
</div>

templates/ToolsSite/layouts/partials/docs/class-data.html

Lines changed: 28 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,14 @@
1919
<p>{{ $data.description | markdownify }}</p>
2020
</div>
2121
{{ end }}
22-
2322
{{/* Render Options as Table */}}
24-
{{ if $data.options }}
25-
<div class="class-options">
26-
<h3>Options</h3>
23+
{{ if $data.options }} <div class="class-options">
24+
<h3 id="options" class="position-relative">
25+
Options
26+
<a href="#options" class="text-decoration-none text-muted ms-2" title="Link to this heading">
27+
<i class="fas fa-link fa-sm"></i>
28+
</a>
29+
</h3>
2730
<table class="table table-striped">
2831
<thead>
2932
<tr>
@@ -52,14 +55,21 @@ <h3>Options</h3>
5255
</table>
5356
</div>
5457
{{ end }}
55-
5658
{{/* Render Examples */}}
57-
{{ if $data.configurationSamples }}
58-
<div class="class-examples">
59-
<h3>Examples</h3>
60-
{{ range $data.configurationSamples }}
61-
<div class="example-item">
62-
<h4>{{ .name | title }}</h4>
59+
{{ if $data.configurationSamples }} <div class="class-examples">
60+
<h3 id="examples" class="position-relative">
61+
Examples
62+
<a href="#examples" class="text-decoration-none text-muted ms-2" title="Link to this heading">
63+
<i class="fas fa-link fa-sm"></i>
64+
</a>
65+
</h3>
66+
{{ range $data.configurationSamples }} <div class="example-item">
67+
<h4 id="example-{{ anchorize .name }}" class="position-relative">
68+
{{ .name | title }}
69+
<a href="#example-{{ anchorize .name }}" class="text-decoration-none text-muted ms-2" title="Link to this heading">
70+
<i class="fas fa-link fa-sm"></i>
71+
</a>
72+
</h4>
6373
{{ if .description }}
6474
<p>{{ .description | markdownify }}</p>
6575
{{ end }}
@@ -70,11 +80,14 @@ <h4>{{ .name | title }}</h4>
7080
{{ end }}
7181
</div>
7282
{{ end }}
73-
7483
{{/* Additional Information */}}
75-
{{ if or $data.status $data.processingTarget $data.className }}
76-
<div class="class-metadata">
77-
<h3>Metadata</h3>
84+
{{ if or $data.status $data.processingTarget $data.className }} <div class="class-metadata">
85+
<h3 id="metadata" class="position-relative">
86+
Metadata
87+
<a href="#metadata" class="text-decoration-none text-muted ms-2" title="Link to this heading">
88+
<i class="fas fa-link fa-sm"></i>
89+
</a>
90+
</h3>
7891
<dl class="row">
7992
{{ if $data.className }}
8093
<dt class="col-sm-3">Class Name</dt>

templates/ToolsSite/static/css/style.css

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1-
.container {
2-
max-width: 1200px;
1+
@media (min-width: 1200px) {
2+
.container {
3+
width: 1200px;
4+
}
35
}
46

57
/* Menu item styling for light and dark themes */

0 commit comments

Comments
 (0)