Skip to content
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.

Sign up for GitHub

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

Jump to bottom

[docs] Migrate docs from AsciiDoc to Markdown #212558

Merged
merged 6 commits into from
Mar 4, 2025
Merged

[docs] Migrate docs from AsciiDoc to Markdown #212558

merged 6 commits into from
Mar 4, 2025
+24,162 −65,560

Conversation

colleenmcginnis
Copy link
Contributor

@colleenmcginnis colleenmcginnis commented Feb 26, 2025 •
edited by kibanamachine
Loading

Migrate docs from AsciiDoc to Markdown. The preview can be built after #212557 is merged.

@florent-leborgne please tag reviewers, add the appropriate label(s), and take this out of draft when you're ready.

Note: More files are deleted than added here because the content from some files was moved to elastic/docs-content.

What has moved to elastic/docs-content?

Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs:

  • explore-analyze: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools...
  • deploy-manage: Stack management (Spaces, user management, remote clusters...)
  • troubleshooting: .... troubleshooting pages

What is staying in the Kibana repo?

  • Reference content (= anything that is or could be auto-generated): Settings, syntax references
  • Release notes
  • Developer guide

@github-actions GitHub Actions
Copy link
Contributor

A documentation preview will be available soon.

Request a new doc build by commenting
  • Rebuild this PR: run docs-build
  • Rebuild this PR and all Elastic docs: run docs-build rebuild

run docs-build is much faster than run docs-build rebuild. A rebuild should only be needed in rare situations.

If your PR continues to fail for an unknown reason, the doc build pipeline may be broken. Elastic employees can check the pipeline status here.

@florent-leborgne florent-leborgne mentioned this pull request Feb 26, 2025
Merged
@colleenmcginnis colleenmcginnis mentioned this pull request Feb 28, 2025
Merged
@florent-leborgne florent-leborgne marked this pull request as ready for review March 3, 2025 09:51
@florent-leborgne florent-leborgne requested review from a team as code owners March 3, 2025 09:51
@elasticmachine
Copy link
Contributor

Pinging @elastic/kibana-docs (Team:Docs)

@florent-leborgne florent-leborgne added release_note:skip Skip the PR/issue when compiling release notes backport:skip This commit does not require backporting labels Mar 3, 2025
leemthompo
leemthompo approved these changes Mar 3, 2025
View reviewed changes
Copy link
Contributor

@leemthompo leemthompo left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs build is green ✅

@elasticmachine
Copy link
Contributor

💚 Build Succeeded

Metrics [docs]

✅ unchanged

@florent-leborgne
Copy link
Contributor

florent-leborgne commented Mar 3, 2025 •
edited
Loading

Hi teams @elastic/response-ops @elastic/appex-sharedux

As part of the docs migration to Markdown, we're moving & converting a bunch of docs file:

What has moved to elastic/docs-content?

Public-facing narrative and conceptual docs have moved. Most can now be found under the following directories in the new docs:

  • explore-analyze: Discover, Dashboards, Visualizations, Reporting, Alerting, dev tools...
  • deploy-manage: Stack management (Spaces, user management, remote clusters...)
  • troubleshooting: .... troubleshooting pages

What is staying in the Kibana repo?

  • Reference content (= anything that is or could be auto-generated): Settings, syntax references, functions lists...
  • Release notes
  • Developer guide

This is a step towards building our new docs site for 9.0.

florent-leborgne
florent-leborgne approved these changes Mar 3, 2025
View reviewed changes
Copy link
Contributor

@florent-leborgne florent-leborgne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛻

@florent-leborgne florent-leborgne merged commit 1814c60 into elastic:main Mar 4, 2025
16 checks passed
@florent-leborgne florent-leborgne added v9.0.0 backport:version Backport to applied version labels and removed backport:skip This commit does not require backporting labels Mar 4, 2025
@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/13658245881

@kibanamachine
Copy link
Contributor

Starting backport for target branches: 9.0

https://github.com/elastic/kibana/actions/runs/13658245956

@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
❌ 9.0 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 212558

Questions ?

Please refer to the Backport tool documentation

1 similar comment
@kibanamachine
Copy link
Contributor

💔 All backports failed

Status Branch Result
❌ 9.0 Backport failed because of merge conflicts

Manual backport

To create the backport manually run:

node scripts/backport --pr 212558

Questions ?

Please refer to the Backport tool documentation

@colleenmcginnis colleenmcginnis deleted the migrate-docs branch March 4, 2025 16:32
@florent-leborgne florent-leborgne mentioned this pull request Mar 4, 2025
Open
@florent-leborgne
Copy link
Contributor

💚 All backports created successfully

Status Branch Result
✅ 9.0

Note: Successful backport PRs will be merged automatically after passing CI.

Questions ?

Please refer to the Backport tool documentation

florent-leborgne pushed a commit to florent-leborgne/kibana that referenced this pull request Mar 4, 2025
@colleenmcginnis
[docs] Migrate docs from AsciiDoc to Markdown (elastic#212558)
96a2ecb 
Migrate docs from AsciiDoc to Markdown. The preview can be built after
elastic#212557 is merged.

@florent-leborgne please tag reviewers, add the appropriate label(s),
and take this out of draft when you're ready.

Note: More files are deleted than added here because the content from
some files was moved to
[elastic/docs-content](https://github.com/elastic/docs-content).

**What has moved to
[elastic/docs-content](https://github.com/elastic/docs-content)?**

Public-facing narrative and conceptual docs have moved. Most can now be
found under the following directories in the new docs:
- explore-analyze: Discover, Dashboards, Visualizations, Reporting,
Alerting, dev tools...
- deploy-manage: Stack management (Spaces, user management, remote
clusters...)
- troubleshooting: .... troubleshooting pages

**What is staying in the Kibana repo?**

- Reference content (= anything that is or could be auto-generated):
Settings, syntax references
- Release notes
- Developer guide

---------

Co-authored-by: Florent Le Borgne <florent.leborgne@elastic.co>
(cherry picked from commit 1814c60)

# Conflicts:
#	docs/enterprise-search-settings.asciidoc
#	docs/setup/settings.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@adcoelho adcoelho adcoelho approved these changes

@Dosant Dosant Dosant approved these changes

@florent-leborgne florent-leborgne florent-leborgne approved these changes

@leemthompo leemthompo leemthompo approved these changes

Assignees
No one assigned
Labels
backport:version Backport to applied version labels docs release_note:skip Skip the PR/issue when compiling release notes Team:Docs v9.0.0 v9.1.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
7 participants
@colleenmcginnis @elasticmachine @florent-leborgne @kibanamachine @adcoelho @Dosant @leemthompo