-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[Meta] Migration tooling bugs #160
Comments
Do note we do support the ```{admonition} 'Example 60. *Logs*'
:open: true/false
//content
```
|
@siamakp-elastic another note is that the output currently generates to The |
In the asciidoc docs all of our dropdowns are currently unstyled so I think this is the better fit. I'd also be interested in discussing whether or not we should support |
Ahh that makes sense @bmorelli25 ! I think your argument to not support dropdown in admonitions makes a lot of sense. Just give me the go-ahead to rip it out :) |
Let's do it! 🔨 |
Migration Tooling Bugs
The following bugs should be prioritized.
Output
docs/source
todocs
Links
Unicode
The migration tool shouldn't output unicode. I see a lot of examples of this in the zip file:
>
, 
,’
, etc.Variables
{{branch}}
)-
in variables (currently converts to_
)navigation_title
frontmatter. To be fixed by @elastic/docs-engineeringScreenshot here
Definition lists
We need a solution for this. See #109.
Tabs
python3 convert.py -dir path/to/dir/
Dropdowns
Related to #107.
The migration script currently migrates dropdowns to following syntax:
We don't support this syntax in docs-builder. The syntax should be:
Note that an optional
:open:
parameter is also supported. I'm not sure if your migration tooling is handling the open-by-default dropdowns or not, @siamakp-elasticOther bugs
Lower priority bugs to look into as time allows.
Table conversion
We should strip the table conversion syntax from:
to just
Bullet points
When a bullet point only contains a link, it doesn't migrate?
Asciidoc link: https://www.elastic.co/guide/en/observability/current/monitor-k8s-otel-edot.html
MD link: http://localhost:5000/monitor-k8s-otel-edot.html
Screenshot here
Code block callouts
We had previously asked @siamakp-elastic to convert code callouts to footnotes. We now support callout syntax in docs-builder. The code callout syntax that we should update
adoc-to-md
is:In other words:
<\d+>
at the end to indicate code callouts.Questions for writers during bug bash
The text was updated successfully, but these errors were encountered: