chore: various markdown warnings resolved #30657
Conversation
|
#30659 will handle the failed job related to invalid URLs. |
CodeWithEmad
force-pushed
the
chore/markdown-cleanup
branch
2 times, most recently
from
57e66f8 to
fd91e8c
Compare
| $ source venv/bin/activate | ||
| $ python3 -m pip install -r requirements/development.txt | ||
| $ pip-compile-multi --no-upgrade | ||
| python3 -m venv venv |
There was a problem hiding this comment.
I suppose some people like the prompts in their doc... but I'm personally fine without them.
There was a problem hiding this comment.
Well, that fixes a Markdown warning: Dollar signs used before commands without showing output.
If someone needs to copy this into their terminal, they have to delete a lot of dollar signs.
| @@ -773,7 +773,7 @@ To debug Flask running in POD inside a kubernetes cluster, you'll need to make s | |||
| add: ["SYS_PTRACE"] | |||
| ``` | |||
|
|
|||
| See (set capabilities for a container)[https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container] for more details. | |||
| See [set capabilities for a container](https://kubernetes.io/docs/tasks/configure-pod-container/security-context/#set-capabilities-for-a-container) for more details. | |||
There was a problem hiding this comment.
I'm shocked how many of these continue to sneak through!
| @@ -137,7 +137,7 @@ You can override this path using the **SUPERSET_HOME** environment variable. | |||
| Another workaround is to change where superset stores the sqlite database by adding the following in | |||
| `superset_config.py`: | |||
|
|
|||
| ``` | |||
| ```python | |||
There was a problem hiding this comment.
Things are going to get a lot prettier with all these syntax formatters added! Thanks!
| @@ -35,15 +35,15 @@ helm repo add superset https://apache.github.io/superset | |||
| "superset" has been added to your repositories | |||
| ``` | |||
|
|
|||
| 2. View charts in repo | |||
| 1. View charts in repo | |||
There was a problem hiding this comment.
Hmmm... this doesn't look right... these should actually be in numeric order, not all "1".
There was a problem hiding this comment.
You're right, in this case, we cannot use the "auto numbering" feature of the markdown. I'll revert those but
In Markdown, when you use "1." for each item in a numbered list, it treats them all as part of the same list and automatically renumbers them in the output.
|
One small change and one small conflict to deal with, but generally looking great. Did you hand-edit these to resolve the warnings, or is there a linter/formatter we can plug into the pre-commit hook (and/or CI)? |
CodeWithEmad
force-pushed
the
chore/markdown-cleanup
branch
2 times, most recently
from
836b42f to
695a39e
Compare
|
I'm using markdownlint extension to handle simple warnings like new lines before and after ordered/unordered lists but I've added some fixes like the code blocks manually. Also, I fixed the link checker failed job a while back, but it looks like SSL certificate of this URL has expired: https://www.plaidcloud.com/ |
CodeWithEmad
force-pushed
the
chore/markdown-cleanup
branch
from
695a39e to
d4208d7
Compare
This will fix markdown syntax issues across all documents.
Suggestion: We can implement a linter in pre-commit to maintain well-formatted and concise documentation.