Add mdformat plugins for GitHub support (#1172)

jupyter-server · Oct 18, 2022 · 439d019 · 439d019
1 parent 3d57fe9
commit 439d019
Show file tree

Hide file tree

Showing 6 changed files with 19 additions and 14 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -41,6 +41,8 @@ repos:
     rev: 0.7.16
     hooks:
       - id: mdformat
+        additional_dependencies:
+          [mdformat-gfm, mdformat-frontmatter, mdformat-footnote]
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.1.0

diff --git a/docs/source/operators/deploy-kubernetes.md b/docs/source/operators/deploy-kubernetes.md
@@ -444,10 +444,10 @@ can override them with helm's `--set` or `--values` options. Always use `--set`
 | ------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------ |
 | `global.rbac`                              | Create Kubernetes RBAC resources                                                                                                                                                                                                                 | `true`                                                                         |
 | `global.commonLabels`                      | Common labels to apply to daemonset and deployment resources                                                                                                                                                                                     | `{}`                                                                           |
-| `global.imagePullSecrets`                  | Optional array of image pull secrets for Service Account for pulling images from private service registries                                                                                                                                      | \[\]                                                                             |
+| `global.imagePullSecrets`                  | Optional array of image pull secrets for Service Account for pulling images from private service registries                                                                                                                                      | \[\]                                                                           |
 | `imagePullSecretsCreate.enabled`           | Optional enable creation of the Kubernetes secrets to access private registries.                                                                                                                                                                 | 'false'                                                                        |
 | `imagePullSecretsCreate.annotations`       | Annotations for Kubernetes secrets                                                                                                                                                                                                               | '{}'                                                                           |
-| `imagePullSecretsCreate.secrets`           | Array of Kubernetes secrets to create with the following structure: `name` - secret name and `data` - base64 encoded Secret value. Example: `{ name: "myregistrykey", data: "SGVsbG8gc2VjcmV0Cg==" }`                                            | '\[\]'                                                                           |
+| `imagePullSecretsCreate.secrets`           | Array of Kubernetes secrets to create with the following structure: `name` - secret name and `data` - base64 encoded Secret value. Example: `{ name: "myregistrykey", data: "SGVsbG8gc2VjcmV0Cg==" }`                                            | '\[\]'                                                                         |
 | `image`                                    | Enterprise Gateway image name and tag to use. Ensure the tag is updated to the version of Enterprise Gateway you wish to run.                                                                                                                    | `elyra/enterprise-gateway:VERSION`, where `VERSION` is the release being used  |
 | `imagePullPolicy`                          | Enterprise Gateway image pull policy. Use `IfNotPresent` policy so that dev-based systems don't automatically update. This provides more control. Since formal tags will be release-specific this policy should be sufficient for them as well.  | `IfNotPresent`                                                                 |
 | `service.type`                             | Kubernetes Service Type - Nodeport,ClusterIP,LoadBalancer                                                                                                                                                                                        | `ClusterIP`                                                                    |

diff --git a/website/index.md b/website/index.md
@@ -1,3 +1,3 @@
-______________________________________________________________________
-
-## layout: home
+---
+layout: home
+---
diff --git a/website/platform-kubernetes.md b/website/platform-kubernetes.md
@@ -1,6 +1,7 @@
-______________________________________________________________________
-
-## layout: page title: Jupyter Enterprise Gateway and Kubernetes
+---
+layout: page
+title: Jupyter Enterprise Gateway and Kubernetes
+---
 
 Recently, we have experienced various advances in AI, in particular around Deep Learning. This have
 increased the popularity of Deep Learning use cases and also the proliferation of several development

diff --git a/website/platform-spark.md b/website/platform-spark.md
@@ -1,6 +1,7 @@
-______________________________________________________________________
-
-## layout: page title: Jupyter Enterprise Gateway and Apache Spark
+---
+layout: page
+title: Jupyter Enterprise Gateway and Apache Spark
+---
 
 The Big Data Analytics use cases require processing large data sets which are not containable by
 the resources available on a single machine.

diff --git a/website/privacy-policy.md b/website/privacy-policy.md
@@ -1,6 +1,7 @@
-______________________________________________________________________
-
-## layout: page title: Jupyter Enterprise Gateway Privacy Policy
+---
+layout: page
+title: Jupyter Enterprise Gateway Privacy Policy
+---
 
 ## Jupyter Enterprise Gateway Privacy Policy