Skip to content

Commit f384947

Browse files
matifalimatifali
committed
Add icons to various documentation sections
Enhance navigation by adding relevant icons to improve visual distinction and accessibility: - Added `icon_path` for CLI, Docker, Kubernetes, OpenShift - Enhanced cloud and other install methods with icons - Updated user guides and control plane sections - Added icons for infrastructure, users, and templates - Included icons for provisioners, integrations, workspaces - Added `icon_path` for networking, monitoring, security - Included icons for automation and notifications sections
1 parent 53c7eb3 commit f384947

File tree

1 file changed

+33
-9
lines changed

1 file changed

+33
-9
lines changed

‎docs/manifest.json

Lines changed: 33 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -34,27 +34,33 @@
3434
{
3535
"title": "Coder CLI",
3636
"description": "Install the standalone binary",
37-
"path": "./install/cli.md"
37+
"path": "./install/cli.md",
38+
"icon_path": "./images/icons/terminal.svg"
3839
},
3940
{
4041
"title": "Docker",
4142
"description": "Install Coder using Docker",
42-
"path": "./install/docker.md"
43+
"path": "./install/docker.md",
44+
"icon_path": "./images/icons/docker.svg"
45+
4346
},
4447
{
4548
"title": "Kubernetes",
4649
"description": "Install Coder on Kubernetes",
47-
"path": "./install/kubernetes.md"
50+
"path": "./install/kubernetes.md",
51+
"icon_path": "./images/icons/kubernetes.svg"
4852
},
4953
{
5054
"title": "OpenShift",
5155
"description": "Install Coder on OpenShift",
52-
"path": "./install/openshift.md"
56+
"path": "./install/openshift.md",
57+
"icon_path": "./images/icons/openshift.svg"
5358
},
5459
{
5560
"title": "Cloud Providers",
5661
"description": "Install Coder on cloud providers",
5762
"path": "./install/cloud/README.md",
63+
"icon_path": "./images/icons/cloud.svg",
5864
"children": [
5965
{
6066
"title": "AWS EC2",
@@ -76,7 +82,8 @@
7682
{
7783
"title": "Unofficial Install Methods",
7884
"description": "Other installation methods",
79-
"path": "./install/other/README.md"
85+
"path": "./install/other/README.md",
86+
"icon_path": "./images/icons/generic.svg"
8087
}
8188
]
8289
},
@@ -131,7 +138,8 @@
131138
{
132139
"title": "Dotfiles",
133140
"description": "Personalize your environment with dotfiles",
134-
"path": "./user-guides/workspace-dotfiles.md"
141+
"path": "./user-guides/workspace-dotfiles.md",
142+
"icon_path": "./images/icons/art-pad.svg"
135143
}
136144
]
137145
},
@@ -144,12 +152,14 @@
144152
{
145153
"title": "Control Plane",
146154
"description": "Configure user access to your control plane.",
147-
"path": "./admin/configure.md"
155+
"path": "./admin/configure.md",
156+
"icon_path": "./images/icons/control-plane.svg"
148157
},
149158
{
150159
"title": "Infrastructure",
151160
"description": "How to integrate Coder with your organization's compute",
152161
"path": "./admin/infrastructure/README.md",
162+
"icon_path": "./images/icons/container.svg",
153163
"children": [
154164
{
155165
"title": "Architecture",
@@ -191,6 +201,7 @@
191201
"title": "Users",
192202
"description": "Learn how to manage and audit users",
193203
"path": "./admin/users/README.md",
204+
"icon_path": "./images/icons/users.svg",
194205
"children": [
195206
{
196207
"title": "OIDC Authentication",
@@ -227,6 +238,7 @@
227238
"title": "Templates",
228239
"description": "Learn how to author and maintain Coder templates",
229240
"path": "./admin/templates/README.md",
241+
"icon_path": "./images/icons/picture.svg",
230242
"children": [
231243
{
232244
"title": "Creating Templates",
@@ -327,7 +339,8 @@
327339
{
328340
"title": "Provisioners",
329341
"description": "Learn how to run external provisioners with Coder",
330-
"path": "./admin/provisioners.md"
342+
"path": "./admin/provisioners.md",
343+
"icon_path": "./images/icons/key.svg"
331344
},
332345
{
333346
"title": "Integrations",
@@ -375,6 +388,7 @@
375388
"title": "Workspaces",
376389
"description": "Learn how to manage \u0026 audit workspaces",
377390
"path": "./admin/workspaces/README.md",
391+
"icon_path": "./images/icons/layers.svg",
378392
"children": [
379393
{
380394
"title": "Workspace Lifecycle",
@@ -387,6 +401,7 @@
387401
"title": "Networking",
388402
"description": "Understand Coder's networking layer",
389403
"path": "./admin/networking/README.md",
404+
"icon_path": "./images/icons/networking.svg",
390405
"children": [
391406
{
392407
"title": "Port Forwarding",
@@ -409,6 +424,7 @@
409424
"title": "Monitoring",
410425
"description": "Configure security policy and audit your deployment",
411426
"path": "./admin/monitoring/README.md",
427+
"icon_path": "./images/icons/health.svg",
412428
"children": [
413429
{
414430
"title": "Logs",
@@ -431,6 +447,7 @@
431447
"title": "Security",
432448
"description": "Configure security policy and audit your deployment",
433449
"path": "./admin/security/README.md",
450+
"icon_path": "./images/icons/lock.svg",
434451
"children": [
435452
{
436453
"title": "Audit Logs",
@@ -447,7 +464,14 @@
447464
{
448465
"title": "Automation",
449466
"description": "DIfferent ways to automate Coder actions and workflows",
450-
"path": "./admin/automation.md"
467+
"path": "./admin/automation.md",
468+
"icon_path": "./images/icons/automation.svg"
469+
},
470+
{
471+
"title": "Notifications",
472+
"description": "Configure notifications for your deployment",
473+
"path": "./admin/notifications.md",
474+
"icon_path": "./images/icons/notifications.svg"
451475
}
452476
]
453477
},

0 commit comments

Comments
 (0)