Skip to content

Conversation

thekofimensah
Copy link
Contributor

Added an intro to this topic to help with understanding of the topic

Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.17.2 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Jan 16, 2025
@AI-IshanBhatt AI-IshanBhatt added the >docs General docs changes label Jan 20, 2025
@elasticsearchmachine elasticsearchmachine added Team:Docs Meta label for docs team and removed needs:triage Requires assignment of a team area label labels Jan 20, 2025
@elasticsearchmachine
Copy link
Collaborator

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

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.

I would avoid manually editing API docs at this point because all API references are moving to being autogenerated from the OpenAPI specs. So my guidance would be to close this PR and focus on non-API docs updates.

Otherwise, I think these changes are problematic.

Your update has a few key issues that could mislead users:

  • You've contradicted yourself by saying the API can "change mappings" but then stating Elasticsearch "does not allow in-place field type changes"
  • You've removed the crucial "adds new fields" capability, which is actually one of the API's main functions

@leemthompo leemthompo changed the title Update put mapping [DOCS] Update put mapping Jan 20, 2025
@georgewallace georgewallace self-assigned this Jan 21, 2025
@lcawl
Copy link
Contributor

lcawl commented Jan 21, 2025

I would avoid manually editing API docs at this point because all API references are moving to being autogenerated from the OpenAPI specs.

If updates to this content do need to go ahead, the appropriate file would be https://github.com/elastic/elasticsearch-specification/blob/main/specification/indices/put_mapping/IndicesPutMappingRequest.ts, which ultimately gets published here: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-indices-put-mapping-1

@leemthompo
Copy link
Contributor

@thekofimensah need to address:

  • You've contradicted yourself by saying the API can "change mappings" but then stating Elasticsearch "does not allow in-place field type changes"
  • You've removed the crucial "adds new fields" capability, which is actually one of the API's main functions

@leemthompo
Copy link
Contributor

Important

Elastic documentation is migrating to Markdown for version 9.0+. See the migration guide for details.

ℹ️ What's happening?

  • Starting January 29, we will start closing all unmerged documentation PRs targeting main/master
  • We're migrating from AsciiDoc to Markdown for 9.0+
  • 9.0 docs will be frozen from January 29 until February 20 2024
  • NOTE: PRs that include both code and documentation changes will remain open

What do I need to do?

For <=8.x docs:

  1. Rebase your PR to target the relevant 8.x branch instead
  2. The content can remain in AsciiDoc format

For 9.0+ docs:

Option 1:

  • Draft docs in Markdown
  • Once migration freeze ends, find the relevant page in the new docs system and use the edit options to submit your changes

Option 2:

💡 Need help?

  1. For Elasticians: Ask in #docs Slack channel
  2. For external contributors: Open an issue in elastic/docs-content

@thekofimensah
Copy link
Contributor Author

@leemthompo For all of these tickets that we didn't quite get in before the finish line, shall I just create a new PR in v9 and drop these?

@leemthompo
Copy link
Contributor

@thekofimensah yup, but remember some of these are API updates that need to happen in the spec, which is unaffected by the migration :)

@thekofimensah
Copy link
Contributor Author

@leemthompo, @georgewallace for this one, it's targeting 8.17, so can this be merged as is?

@leemthompo leemthompo added auto-backport Automatically create backport pull requests when merged v8.18.0 v8.19.0 labels Feb 28, 2025
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.

Good to merge into 8.x.

Please follow up on #120248 (comment) if you want these changes reflected in 9.x API docs.

@leemthompo leemthompo merged commit 99cb4ce into elastic:8.17 Feb 28, 2025
7 checks passed
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
8.18
8.x

georgewallace pushed a commit to georgewallace/elasticsearch that referenced this pull request Feb 28, 2025
elasticsearchmachine pushed a commit that referenced this pull request Feb 28, 2025
elasticsearchmachine pushed a commit that referenced this pull request Feb 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

auto-backport Automatically create backport pull requests when merged >docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.17.4 v8.18.0 v8.19.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants