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

Update change-index-name.asciidoc #26703

Merged
merged 2 commits into from
Aug 19, 2021
Merged

Update change-index-name.asciidoc #26703

merged 2 commits into from
Aug 19, 2021

Conversation

insukcho
Copy link
Contributor

@insukcho insukcho commented Jul 5, 2021 •
edited
Loading

The current doc can be misread like the user need to visit the ILM page to learn how to change the index name. But the TIP is saying they should visit the ILM page and change the index name in the existing ILM policy with the new index name. Need to be more clear sentence. Feel free to suggest better comments.

What does this PR do?

Fixing confusing comment.

Why is it important?

It can lead the user to visit the ILM page to check how to change the index name.

Checklist

  • My code follows the style guidelines of this project
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • I have made corresponding change to the default configuration files
  • I have added tests that prove my fix is effective or that my feature works
  • I have added an entry in CHANGELOG.next.asciidoc or CHANGELOG-developer.next.asciidoc.

@insukcho
Update change-index-name.asciidoc
d1ef850 
The current doc can be misread like the user need to visit the ILM page to learn how to change the index name. But the TIP is saying they should visit the ILM page and change the index name in the existing ILM policy with the new index name. Need to be more clear sentance. Feel free to suggest better comments.
@botelastic botelastic bot added the needs_team Indicates that the issue/PR needs a Team:* label label Jul 5, 2021
@insukcho insukcho added the docs label Jul 5, 2021
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jul 5, 2021 •
edited by jenkins-beats-ci bot
Loading

💚 Build Succeeded

the below badges are clickable and redirect to their specific view in the CI or DOCS
Pipeline View Test View Changes Artifacts preview preview

Expand to view the summary

Build stats

  • Start Time: 2021-08-19T03:27:41.775+0000

  • Duration: 21 min 0 sec

  • Commit: 445bcb2

Trends 🧪

Image of Build Times

❕ Flaky test report

No test was executed to be analysed.

@andresrc andresrc added the Team:Docs Label for the Observability docs team label Jul 6, 2021
@botelastic botelastic bot removed the needs_team Indicates that the issue/PR needs a Team:* label label Jul 6, 2021
@elasticmachine
Copy link
Collaborator

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

@andresrc andresrc requested review from dedemorton, urso and kvch August 4, 2021 17:11
dedemorton
dedemorton suggested changes Aug 13, 2021
View reviewed changes
Copy link
Contributor

@dedemorton dedemorton left a comment

Choose a reason for hiding this comment

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

Minor correction to remove phrase that seems unnecessary. Thanks for fixing this!

libbeat/docs/howto/change-index-name.asciidoc Outdated Show resolved Hide resolved
@dedemorton dedemorton self-assigned this Aug 13, 2021
@insukcho @dedemorton
Update libbeat/docs/howto/change-index-name.asciidoc
445bcb2 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@insukcho
Copy link
Contributor Author

@dedemorton Thank you for the suggestion. Just applied ;)

bmorelli25
bmorelli25 approved these changes Aug 19, 2021
View reviewed changes
Copy link
Member

@bmorelli25 bmorelli25 left a comment

Choose a reason for hiding this comment

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

Thanks, Insuk! I'll get this cherry-picked to master and backport

@bmorelli25 bmorelli25 merged commit 7dfecc0 into 7.13 Aug 19, 2021
@bmorelli25 bmorelli25 deleted the insukcho-patch-1 branch August 19, 2021 15:21
This was referenced Aug 19, 2021
Merged
Merged
bmorelli25 pushed a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
@insukcho @dedemorton @bmorelli25
Update change-index-name.asciidoc (elastic#26703)
51cd47a 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@bmorelli25 bmorelli25 mentioned this pull request Aug 19, 2021
Merged
bmorelli25 pushed a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
@insukcho @dedemorton @bmorelli25
Update change-index-name.asciidoc (elastic#26703)
c8b0548 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
bmorelli25 pushed a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
@insukcho @dedemorton @bmorelli25
Update change-index-name.asciidoc (elastic#26703)
5250d66 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
@bmorelli25 bmorelli25 mentioned this pull request Aug 19, 2021
Merged
bmorelli25 pushed a commit to bmorelli25/beats that referenced this pull request Aug 19, 2021
@insukcho @dedemorton @bmorelli25
Update change-index-name.asciidoc (elastic#26703)
308d66b 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
bmorelli25 added a commit that referenced this pull request Aug 19, 2021
@bmorelli25 @insukcho @dedemorton
Update change-index-name.asciidoc (#26703) (#27504)
20d17c4 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Insuk (Chris) Cho <isi.cho@gmail.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
bmorelli25 added a commit that referenced this pull request Aug 19, 2021
@bmorelli25 @insukcho @dedemorton
Update change-index-name.asciidoc (#26703) (#27503)
1c1b9be 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Insuk (Chris) Cho <isi.cho@gmail.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
bmorelli25 added a commit that referenced this pull request Aug 19, 2021
@bmorelli25 @insukcho @dedemorton
Update change-index-name.asciidoc (#26703) (#27505)
5ec88b7 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Insuk (Chris) Cho <isi.cho@gmail.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
bmorelli25 added a commit that referenced this pull request Aug 23, 2021
@bmorelli25 @insukcho @dedemorton
Update change-index-name.asciidoc (#26703) (#27502)
362b5fa 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Insuk (Chris) Cho <isi.cho@gmail.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Icedroid pushed a commit to Icedroid/beats that referenced this pull request Nov 1, 2021
@bmorelli25 @insukcho @dedemorton
Update change-index-name.asciidoc (elastic#26703) (elastic#27502)
73391f4 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>

Co-authored-by: Insuk (Chris) Cho <isi.cho@gmail.com>
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
@insukcho @dedemorton
Update change-index-name.asciidoc (elastic#26703)
720b7dc 
Co-authored-by: DeDe Morton <dede.morton@elastic.co>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dedemorton dedemorton dedemorton requested changes

@bmorelli25 bmorelli25 bmorelli25 approved these changes

@urso urso Awaiting requested review from urso

@kvch kvch Awaiting requested review from kvch

Assignees

@dedemorton dedemorton

Labels
docs Team:Docs Label for the Observability docs team
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@insukcho @elasticmachine @bmorelli25 @dedemorton @andresrc