docs/sidebars.ts at main · psake/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
import type { SidebarsConfig } from '@docusaurus/plugin-content-docs';
import commands from "./docs/commands/docusaurus.sidebar.js";

/**
 * Creating a sidebar enables you to:
 - create an ordered group of docs
 - render a sidebar for each doc of that group
 - provide next/previous navigation

 The sidebars can be generated from the filesystem, or explicitly defined here.

 Create as many sidebars as you want.
 */
const sidebars: SidebarsConfig = {
  // Getting Started - For newcomers and quick onboarding
  gettingStartedSidebar: [
    'intro',
    'tutorial-basics/installing',
    'tutorial-basics/getting-help',
    'tutorial-basics/run-psake',
    'tutorial-basics/tasks',
    'tutorial-basics/parameters-properties',
  ],

  // Guides - How-to guides, examples, and best practices
  guidesSidebar: [
    {
      type: 'category',
      label: 'Core Concepts',
      items: [
        'tutorial-basics/default-build-files',
        'tutorial-basics/how-to-fail-a-build',
        'tutorial-basics/nested-build',
        'tutorial-advanced/structure-of-a-psake-build-script',
      ],
    },
    {
      type: 'category',
      label: 'Advanced Techniques',
      items: [
        'tutorial-advanced/access-functions-in-another-file',
        'tutorial-advanced/build-script-resilience',
        'tutorial-advanced/debug-script',
        'tutorial-advanced/custom-logging',
        'tutorial-advanced/psake-config',
        'tutorial-advanced/logging-errors',
        'tutorial-advanced/outputs-and-artifacts',
        'tutorial-advanced/print-psake-task-name',
        'tutorial-advanced/retry-rules',
        'tutorial-advanced/variable-referencing',
      ],
    },
    {
      type: 'category',
      label: 'Build Type Examples',
      items: [
        'build-types/dot-net-solution',
        'build-types/nodejs',
        'build-types/docker'
      ]
    },
    {
      type: 'category',
      label: 'CI/CD Integration',
      items: [
        'ci-examples/github-actions',
        'ci-examples/azure-pipelines',
        'ci-examples/gitlab-ci',
        'ci-examples/hudson',
        'ci-examples/cruise-control',
        'ci-examples/team-city',
      ]
    },
    {
      type: 'category',
      label: 'Editor & Tool Integration',
      items: [
        'integrations/vscode-extension',
      ]
    },
  ],

  // PowerShellBuild - Companion module for building PowerShell modules
  powershellBuildSidebar: [
    'powershellbuild/introduction',
    'powershellbuild/getting-started',
    'powershellbuild/task-reference',
    'powershellbuild/configuration',
    'powershellbuild/real-world-example',
  ],

  // Reference - Command reference, troubleshooting, and lookup materials
  referenceSidebar: [
    {
      type: 'category',
      label: 'Command Reference',
      items: commands
    },
    {
      type: 'category',
      label: 'Reference Materials',
      items: [
        'reference/configuration-reference',
        'reference/cheat-sheet',
        'reference/glossary',
        'reference/exit-codes',
      ]
    },
    {
      type: 'category',
      label: 'Troubleshooting',
      items: [
        'troubleshooting/common-errors',
        'troubleshooting/faq',
        'troubleshooting/debugging-guide',
      ]
    },
    {
      type: 'doc',
      label: 'Code of Conduct',
      id: 'code_of_conduct'
    },
  ],
};

export default sidebars;