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

(Doc+) Link API doc to parent object - part1 #111951

Merged
merged 16 commits into from
Aug 20, 2024
Merged

(Doc+) Link API doc to parent object - part1 #111951

merged 16 commits into from
Aug 20, 2024

Conversation

stefnestor
Copy link
Contributor

👋 hey, @shainaraskas !

This is part 1/UNK from our discussion Aug08 about Support wanting Elasticsearch API docs to link up to their parent reference guide. I got so however many pages below in before calling a random cut off point because the git diff list was getting long. This only updates the first parent reference to have it be linked.

TIA! 💚 cc: @danielharada

@github-actions GitHub Actions
Copy link
Contributor

Documentation preview:

@elasticsearchmachine elasticsearchmachine added needs:triage Requires assignment of a team area label v8.16.0 external-contributor Pull request authored by a developer outside the Elasticsearch team labels Aug 17, 2024
@gareth-ellis gareth-ellis added >docs General docs changes and removed needs:triage Requires assignment of a team area label labels Aug 19, 2024
@elasticsearchmachine elasticsearchmachine added the Team:Docs Meta label for docs team label Aug 19, 2024
@elasticsearchmachine
Copy link
Collaborator

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

@shainaraskas shainaraskas self-requested a review August 19, 2024 16:22
shainaraskas
shainaraskas reviewed Aug 20, 2024
View reviewed changes
docs/reference/ilm/start-stop.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/lifecycle/apis/delete-lifecycle.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/lifecycle/index.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/promote-data-stream-api.asciidoc Outdated Show resolved Hide resolved
docs/reference/eql/detect-threats-with-eql.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/set-up-a-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/lifecycle/tutorial-migrate-data-stream-from-ilm-to-dsl.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/lifecycle/tutorial-migrate-data-stream-from-ilm-to-dsl.asciidoc Show resolved Hide resolved
docs/reference/data-streams/lifecycle/tutorial-manage-new-data-stream.asciidoc Outdated Show resolved Hide resolved
docs/reference/data-streams/lifecycle/tutorial-manage-existing-data-stream.asciidoc Outdated Show resolved Hide resolved
shainaraskas
shainaraskas reviewed Aug 20, 2024
View reviewed changes
docs/reference/ccr/auto-follow.asciidoc Outdated Show resolved Hide resolved
docs/reference/ccr/bi-directional-disaster-recovery.asciidoc Outdated Show resolved Hide resolved
docs/reference/ccr/getting-started.asciidoc Outdated Show resolved Hide resolved
docs/reference/ccr/managing.asciidoc Outdated Show resolved Hide resolved
docs/reference/ccr/uni-directional-disaster-recovery.asciidoc Outdated Show resolved Hide resolved
docs/reference/ccr/upgrading.asciidoc Outdated Show resolved Hide resolved
shainaraskas
shainaraskas reviewed Aug 20, 2024
View reviewed changes
docs/reference/ilm/error-handling.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/ilm-index-lifecycle.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/set-up-lifecycle-policy.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/start-stop.asciidoc Outdated Show resolved Hide resolved
docs/reference/ilm/update-lifecycle-policy.asciidoc Outdated Show resolved Hide resolved
shainaraskas
shainaraskas reviewed Aug 20, 2024
View reviewed changes
docs/reference/behavioral-analytics/apis/delete-analytics-collection.asciidoc Outdated Show resolved Hide resolved
docs/reference/behavioral-analytics/apis/put-analytics-collection.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/esql-multi-index.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/esql-security-solution.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/esql-syntax.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/esql-using.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/metadata-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/multivalued-fields.asciidoc Outdated Show resolved Hide resolved
docs/reference/esql/task-management.asciidoc Outdated Show resolved Hide resolved
@shainaraskas
Apply suggestions from code review
af5071c 
rm in-context links, fix grammar
shainaraskas
shainaraskas reviewed Aug 20, 2024
View reviewed changes
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

sorry for the noise on this PR - was trying to do edits in batches.

I'm not approving this yet - take a look at this comment and tell me what you think about it before we proceed.

Here's a high-level overview of the changes I made:

  • small grammatical fixes (mostly article agreement - an becomes a)
  • Applying the link to the first instance of a concept
  • Removing duplicate links where they were introduced
  • Removing some links added to the conceptual docs - these are usually situated in a section all about the topic, so the link isn't actually super helpful. We might choose to reintroduce these later, but right now it's injecting inconsistency.

For the next round, I suggest focusing specifically on API pages, which should make your PRs a little smaller.

@stefnestor
Copy link
Contributor Author

sorry for the noise on this PR - was trying to do edits in batches.

Thanks, @shainaraskas ! I appreciate your heavy lifting 💪🏽 💚.

I'm not approving this yet - take a look at this comment and tell me what you think about it before we proceed.

💬

For the next round, I suggest focusing specifically on API pages, which should make your PRs a little smaller.

I was having trouble determining which files were API-only from the docs structure (since I was doing it from local code VS usually do single-page edit via Docs-to-Github). But happy to figure out how to future narrow this.

@shainaraskas
Copy link
Contributor

I was having trouble determining which files were API-only from the docs structure (since I was doing it from local code VS usually do single-page edit via Docs-to-Github). But happy to figure out how to future narrow this.

yeah the files are kinda mashed together unfortunately. most of them open with a single verb phrase around the action the call accomplishes.

@stefnestor
Copy link
Contributor Author

I'm not approving this yet - take a look at this comment and tell me what you think about it before we proceed.

Thread applied across data-streams/lifecycle files from ILM to DLM link. 👌

shainaraskas
shainaraskas approved these changes Aug 20, 2024
View reviewed changes
Copy link
Contributor

@shainaraskas shainaraskas left a comment

Choose a reason for hiding this comment

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

rad! gotta wait for tests to pass, then good to merge 🎉

@stefnestor stefnestor merged commit c1019d4 into elastic:main Aug 20, 2024
5 checks passed
@stefnestor stefnestor mentioned this pull request Aug 20, 2024
Merged
@elasticsearchmachine
Copy link
Collaborator

💚 Backport successful

Status Branch Result
✅ 8.15

stefnestor added a commit to stefnestor/elasticsearch that referenced this pull request Aug 20, 2024
@stefnestor @shainaraskas
(Doc+) Link API doc to parent object - part1 (elastic#111951)
9665022 
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
elasticsearchmachine pushed a commit that referenced this pull request Aug 20, 2024
@stefnestor @shainaraskas
(Doc+) Link API doc to parent object - part1 (#111951) (#112041)
d527073 
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
lkts pushed a commit to lkts/elasticsearch that referenced this pull request Aug 20, 2024
@stefnestor @shainaraskas @lkts
(Doc+) Link API doc to parent object - part1 (elastic#111951)
803f2e4 
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
cbuescher pushed a commit to cbuescher/elasticsearch that referenced this pull request Sep 4, 2024
@stefnestor @shainaraskas @cbuescher
(Doc+) Link API doc to parent object - part1 (elastic#111951)
6d37cc9 
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
davidkyle pushed a commit to davidkyle/elasticsearch that referenced this pull request Sep 5, 2024
@stefnestor @shainaraskas @davidkyle
(Doc+) Link API doc to parent object - part1 (elastic#111951)
8aa7ce5 
* (Doc+) Link API to parent Doc part1

---------

Co-authored-by: shainaraskas <[email protected]>
Co-authored-by: shainaraskas <[email protected]>
This was referenced Sep 25, 2024
Merged
Closed
@stefnestor stefnestor deleted the stef_apiLinkParent_p1 branch November 15, 2024 22:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shainaraskas shainaraskas shainaraskas approved these changes

Assignees
No one assigned
Labels
>docs General docs changes external-contributor Pull request authored by a developer outside the Elasticsearch team Team:Docs Meta label for docs team v8.15.1 v8.16.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@stefnestor @elasticsearchmachine @shainaraskas @gareth-ellis