database-assessment/mkdocs.yml at main · GoogleCloudPlatform/database-assessment · 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
site_name: Database Migration Assessment
site_url: https://googlecloudplatform.github.io/database-assessment/
repo_url: https://github.com/GoogleCloudPlatform/database-assessment
repo_name: GoogleCloudPlatform/database-assessment
edit_uri: edit/main/docs

theme:
  name: material
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  language: en
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
      primary: teal
      accent: purple
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode
      primary: teal
      accent: lime

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

plugins:
  - search:
      separator: '[\s\-,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - mkdocstrings:
      handlers:
        python:
          paths: [src]
  - minify:
      minify_html: true
      minify_js: true
      minify_css: true
      htmlmin_opts:
        remove_comments: true

nav:
  - Home: index.md
  - Collection Scripts:
    - Oracle Data Collection:
        - Data Collection: user_guide/shell_scripts/oracle/collection_scripts.md
        - Permissions Required: user_guide/shell_scripts/oracle/permissions.md
        - Database User Scripts: user_guide/shell_scripts/oracle/db_user_create.md
        - Collection Masking: user_guide/shell_scripts/oracle/collection_masker.md
        - DMS Migration Job Validation: user_guide/shell_scripts/oracle/dms_migration_job_validation.md
    - Microsoft SQL Server Data Collection:
        - Data Collection: user_guide/shell_scripts/sqlserver/collection_scripts.md
        - Database User Scripts: user_guide/shell_scripts/sqlserver/db_user_create.md
    - Postgres Data Collection:
        - Data Collection: user_guide/shell_scripts/postgres/collection_scripts.md
    - MySQL Data Collection:
        - Data Collection: user_guide/shell_scripts/mysql/collection_scripts.md
  - Readiness Check Utility:
      - Overview: user_guide/readiness_check/overview.md
      - Installation: user_guide/readiness_check/package-installation.md
  - Developers:
      - Developer Setup: developer_guide/developer_setup.md
      - Commands: developer_guide/commands.md
      - Workflows: developer_guide/workflows.md
      - Releases: developer_guide/releases.md
  - Code Of Conduct: code_of_conduct.md
  - Contributing: contributing.md