remove any/all code language hints for now #715
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
qrkourier
previously approved these changes
Sep 28, 2023
|
The Markdown linter suggests Instead of bare fences. https://github.com/DavidAnson/markdownlint/blob/v0.31.1/doc/md040.md based on https://cirosantilli.com/markdown-style-guide/#option-code-fenced |
qrkourier
requested changes
Sep 29, 2023
There was a problem hiding this comment.
need to keep the mermaid fences or diagrams won't work
bash highlighter seems to be the problem. Let's keep the others, especially yaml, json, which appear to render flawlessly and are where the majority of the benefits of highlighting lie, because they're structured data.
| @@ -4,7 +4,7 @@ title: Workload Tunneling | |||
|
|
|||
| This guide will help you discover the best strategy and tool for connecting a Kubernetes workload. This overview page links to child pages for each strategy and tool, and a summary of each is provided in the sections below. Click on the chart's outcomes to see the corresponding documentation. | |||
|
|
|||
| ```mermaid | |||
There was a problem hiding this comment.
These have to be mermaid or the diagrams will break
| @@ -10,7 +10,7 @@ This [daemonset manifest](https://get.openziti.io/tun/docker/ziti-tun-daemonset. | |||
|
|
|||
| The default nameserver address is `100.64.0.2`, but containers don't automatically use it until you configure cluster DNS. CoreDNS doesn't currently have a fallthrough mechanism, but you can use conventional names for your OpenZiti services' like `*.ziti`, and configure CoreDNS to forward queries that match that namespace to the OpenZiti nameserver. | |||
|
|
|||
| ```yaml | |||
There was a problem hiding this comment.
Are the yaml highlights actually creating a problem, or just bash? The yaml and json look right to me.
| @@ -1,6 +1,6 @@ | |||
| # Endpoint Initialization | |||
|
|
|||
| ```mermaid | |||
| @@ -1,6 +1,6 @@ | |||
| # Endpoint Registration | |||
|
|
|||
| ```mermaid | |||
| @@ -1,6 +1,6 @@ | |||
| # Service Dial | |||
|
|
|||
| ```mermaid | |||
| @@ -15,7 +15,7 @@ or the Ziti [Edge Management API](docs/reference/developer/api/02-edge-managemen | |||
| Below is diagram showing initial authentication for some client. The same model is used between the [Edge Client API](docs/reference/developer/api/01-edge-client-reference.mdx) | |||
| and [Edge Management API](docs/reference/developer/api/02-edge-management-reference.mdx). | |||
|
|
|||
| ```mermaid | |||
| @@ -10,7 +10,7 @@ client in the form of [Posture Checks](posture-checks.md). | |||
| Authorization to connect to an Edge Router affects the Edge Router that are discoverable by a client. This will be | |||
| reflected when listing a Edge Router directly and receiving a list of them during Session creation. | |||
|
|
|||
| ```mermaid | |||
| @@ -13,7 +13,7 @@ Environmental state is saved as Posture Data - a set of values describing enviro | |||
| to the controller via Posture Response sent from the client. Posture Responses are constructed from Posture Queries | |||
| which are reported to the client per service from the controller. | |||
|
|
|||
| ```mermaid | |||
| @@ -209,7 +209,7 @@ ziti@724087d30014:/persistent$ ziti edge list identities | |||
| ╰────────────┴───────────────────────┴────────┴────────────╯ | |||
| results: 1-6 of 6 | |||
|
|
|||
| ```` | |||
| cd "${ZITI_HOME}/ziti-console" | ||
| npm install | ||
| ```` |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
removes any language hints for now until the formatter can be consistent
did a find/replace for: