ce-cns/mkdocs.yml at master · IBM/ce-cns · 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
# Project information
site_name: "Jumpstart: Deploy a Java Microservices Application to `Code Engine`"
site_url: https://ibm.github.io/ce-cns
site_author: Thomas Suedbroecker

# Repository
repo_name: Code Engine - Cloud-Native-Starter
repo_url: https://github.com/ibm/ce-cns
edit_uri: edit/master/documentation
docs_dir: documentation

# Navigation
nav:
  - Introduction:
     - Workshop overview: ./README.md
  - Labs:
    - 1. Setup the example application: ./setup-example.md
    - 2. Inspect the `Code Engine` project: ./inspect-the-project.md
    - 3. Monitoring of the applications: ./monitoring.md
    - 4. Logging of the applications: ./logging.md
    - 5. Cleanup the example application: ./cleanup-example.md
  - Optional Labs:
    - 1. Run the example application locally: ./run-application-locally.md
    - 2. Push the example container images to a container image registry: ./push-to-container-registry.md
    - 3. Use IBM Cloud App ID for the example application: ./app-id-optional.md
    - 4. Use Code Engine to build a container image: ./build-container-image.md
  - Additional Resources:
    - Known issues: ./known-issues.md
    - Techzone access: ./techzone.md
    - Cloud Native Starter example:
       - Cloud-Native-Starter project: https://github.com/IBM/cloud-native-starter
       - Cloud-Native-Starter project security: https://github.com/IBM/cloud-native-starter/security
       - Keycloak core concepts of open-source identity and access management: https://developers.redhat.com/blog/2019/12/11/keycloak-core-concepts-of-open-source-identity-and-access-management/
    - IBM Cloud Code Engine:
       - YouTube Video 'Code Engine Run Your Source Code, Containers, Batch Jobs - Serverless' : https://youtu.be/QZTfivC2ZEA
       - Examples on GitHub: https://github.com/IBM/CodeEngine
       - Code Engine CLI reference: https://cloud.ibm.com/docs/codeengine?topic=codeengine-cli

## DO NOT CHANGE BELOW THIS LINE

# Copyright
# copyright: Copyright &copy; 2020 IBM Developer

# Theme
theme:
  name: material
  font:
    text: IBM Plex Sans
    code: IBM Plex Mono
  icon:
    # .svg automatically appended
    logo: ibm_8bar_reverse_2
    #logo: material/library
  features:
    # - navigation.tabs
    - navigation.instant
    # - navigation.expand
  palette:
    scheme: default
    primary: black
    accent: blue
  # palette:
  #  scheme: default
  #  primary: blue
  #  accent: blue
  # enable if you want to use a custom icon
  custom_dir: overrides

# Plugins
plugins:
  - search

# Customization
extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/ibm
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ibmdeveloper
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/company/ibm/
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/user/developerworks
    - icon: fontawesome/brands/dev
      link: https://dev.to/ibmdeveloper

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - meta
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
  - pymdownx.highlight
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      check_paths: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tilde