[docs] Migrate docs from AsciiDoc to Markdown #123507
Conversation
|
Documentation preview: |
elasticsearchmachine
added
external-contributor
leemthompo
added
v9.0.0
and removed
v9.1.0
external-contributor
|
@elasticmachine test this |
There is a 🐔 🥚 problem with cross-repo link checking in the PRs where we're adding reference content to other repos. This PR temporarily uses `asciidocalypse` for cross-repo links until all repos are set up with content. This will fix errors reported in the "Validate Inbound Links" step in elastic/elasticsearch-java#952 and elastic/elasticsearch#123507.
|
Regarding my work in https://github.com/elastic/asciidocalypse/pull/137, this could either be ported to this PR, or I could simply make a new PR in elasticsearch with these changes later. I view the work I did there as preparatory work towards getting things correctly laid out in elasticsearch, but more work needs to be done once this PR is merged. I personally would prioritize getting this PR merged, and only include https://github.com/elastic/asciidocalypse/pull/137 if it is trivial to do so. Do not let https://github.com/elastic/asciidocalypse/pull/137 delay getting this work into |
|
Thanks @craigtaverner, was just about to ping you about that :) |
|
I've done spot-checking and don't see anything crazy. But I'd like to give folks until tomorrow to look around and make sure nothing seems out of place, make sure we're only throwing out bathwater etc. If Colleen has bandwidth to get the ESQL PR in here, that would be cool, but definitely only a nice-to-have. |
|
I think there are some additional files that can be removed (e.g. README.asciidoc, Versions.asciidoc, community-clients/index.asciidoc, java-rest/*.asciidoc) but IMO we can do that in a subsequent PR along with the remainder of the outstanding reference cleanup. |
This reverts commit 8be6886.
Yeah we'll need to rewrite the readme for V3. Thanks Lisa for the cleanup link! |
|
I've created a list of the deleted files, because the only (small) concern I have at this point is that we delete files that aren't in the published docs, or somehow or another fall through the cracks. https://gist.github.com/leemthompo/aa35dcb7785c7fa920894884733707c2 99.99% of the deletions are expected as we replace with markdown equivalents (across this repo, the docs-content repo, and the elasticsearch spec for API docs) |
…ch into migrate-docs
elasticsearchmachine
added
the
needs:triage
|
Pinging @elastic/es-docs (Team:Docs) |
elasticsearchmachine
removed
the
needs:triage
leemthompo
added
the
auto-backport
💚 All backports created successfully
Note: Successful backport PRs will be merged automatically after passing CI. Questions ?Please refer to the Backport tool documentation |
* delete asciidoc files * add migrated files * fix errors * Disable docs tests * Clarify release notes page titles * Revert "Clarify release notes page titles" This reverts commit 8be6886. * Comment out edternal URI images * Clean up query languages landing pages, link to conceptual docs * Add .md to url * Fixes inference processor nesting. --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Martijn Laarman <[email protected]> Co-authored-by: István Zoltán Szabó <[email protected]> (cherry picked from commit b7e3a1e) # Conflicts: # docs/build.gradle # docs/reference/migration/index.asciidoc # docs/reference/migration/migrate_9_0.asciidoc # docs/reference/release-notes.asciidoc # docs/reference/release-notes/9.0.0.asciidoc # docs/reference/release-notes/highlights.asciidoc
* [docs] Migrate docs from AsciiDoc to Markdown (#123507) * delete asciidoc files * add migrated files * fix errors * Disable docs tests * Clarify release notes page titles * Revert "Clarify release notes page titles" This reverts commit 8be6886. * Comment out edternal URI images * Clean up query languages landing pages, link to conceptual docs * Add .md to url * Fixes inference processor nesting. --------- Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Liam Thompson <[email protected]> Co-authored-by: Martijn Laarman <[email protected]> Co-authored-by: István Zoltán Szabó <[email protected]> (cherry picked from commit b7e3a1e) # Conflicts: # docs/build.gradle # docs/reference/migration/index.asciidoc # docs/reference/migration/migrate_9_0.asciidoc # docs/reference/release-notes.asciidoc # docs/reference/release-notes/9.0.0.asciidoc # docs/reference/release-notes/highlights.asciidoc * Fix build file * Really fix build file --------- Co-authored-by: Colleen McGinnis <[email protected]>
👀 🖥️ URL Preview
Migrate docs from AsciiDoc to Markdown. The preview can be built after #123506 is merged.
@leemthompo please tag reviewers, add the appropriate label(s), and take this out of draft when you're ready.
Notes:
navigation_titles might look a little strange. For example, this is how the reference content will eventually fit into the larger IA: