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.

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

Add inital AsciiDoc index page #1093

Merged
merged 1 commit into from
Dec 10, 2024

Conversation

colleenmcginnis
Copy link
Contributor

Description

Adds a placeholder AsciiDoc index file to be used in a new Search UI book.

This is part of an effort to move the current Search UI docs to AsciiDoc. There is a bit of a 🐔 / 🥚 problem with this process:

  • This PR must be merged before the elastic/docs PR that adds the Search UI book (Add Search UI to config docs#3140).
  • The elastic/docs PR adds a stub Search UI book with the index.asciidoc file as the only page. This stub book will not be indexable by search engines.
  • After that elastic/docs PR is merged, I will open a PR in this repo to add all the AsciiDoc content. That PR will include a preview that the docs and search teams can use to validate the AsciiDoc version of the Search UI docs.
  • After that PR is merged and the full Search UI book is live, I'll open another PR in the elastic/docs repo to remove noindex so the book will start being indexed by search engines.

List of changes

  • index.asciidoc: Placeholder index file to set us up for creating AsciiDoc previews of the new Search UI book.
  • .gitignore: Adds html_docs, which is a directory that may be generated when you build the docs locally.

Associated Github Issues

Related to elastic/docs#3140

@colleenmcginnis colleenmcginnis marked this pull request as ready for review December 10, 2024 14:10
@colleenmcginnis colleenmcginnis requested a review from a team as a code owner December 10, 2024 14:10
@joemcelroy joemcelroy merged commit 013e99e into elastic:main Dec 10, 2024
2 checks passed
@colleenmcginnis colleenmcginnis deleted the add-asciidoc-index branch December 10, 2024 14:48
This was referenced Dec 10, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants