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

[Docs] Add Index basics page #464

Merged
merged 10 commits into from
Feb 18, 2025
Merged

Conversation

wajihaparvez
Copy link
Contributor

@wajihaparvez wajihaparvez commented Feb 14, 2025

Closes #369
Preview here

Summary

What I changed:

  • Combined content from the three mapped pages
  • Altered the heading structure to make sense of the added content and improve readability i.e.: divided the page into H2: Index components and H2: Index management + changed all other headings to H3 and moved them under the relevant H2
  • Drafted a new Manage component templates subsection to be consistent with the UI/screenshots
  • Cut down extra descriptive content from subsections to limit this page to Index basics only, but linked out to relevant pages to compensate. The additions to the Mapping page are from one of the raw migrated files that I think made more sense there than on Index basics
  • Deleted links to Enriching your data examples from the Manage enrich policies subsection because I don't think that's relevant to this page

I'll delete the code comments after this is reviewed. @colleenmcginnis @kilfoyle let me know what you think of these decisions. I'm open to all insight/suggestions 😄

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

This approach makes sense to me! I left a couple comments below that are more technical than editorial.

manage-data/data-store/index-basics.md Outdated Show resolved Hide resolved
Investigate your indices and perform operations from the **Indices** view.

:::{image} /images/serverless-index-management-indices.png
Copy link
Contributor

Choose a reason for hiding this comment

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

The images in this PR aren't showing up for me in the preview... I'm not sure, but this might help.

Suggested change
:::{image} /images/serverless-index-management-indices.png
:::{image} ../../images/serverless-index-management-indices.png

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm not sure what the issue was but when I was adding the ../../ on Friday, the deployment was failing. I can see the images in the preview now, could you confirm if that's true for you as well?

Copy link
Contributor

Choose a reason for hiding this comment

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

Ah I had to hard refresh to get the page built with the latest docs-builder update (including the redesign). After that I can see the images. 👍

Copy link
Contributor

@colleenmcginnis colleenmcginnis left a comment

Choose a reason for hiding this comment

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

@wajihaparvez wajihaparvez enabled auto-merge (squash) February 18, 2025 20:57
@wajihaparvez wajihaparvez merged commit ab5bd09 into elastic:main Feb 18, 2025
5 checks passed
@wajihaparvez wajihaparvez deleted the 369/index-basics branch February 18, 2025 21:03
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