[DOCS] Streamline Docker Compose docs #99371
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
jrodewig
changed the title
Contributor
|
Documentation preview: |
jrodewig
added
>docs
Contributor
Author
|
@elasticsearchmachine run elasticsearch-ci/docs |
Collaborator
|
Pinging @elastic/es-docs (Team:Docs) |
Collaborator
|
Pinging @elastic/es-delivery (Team:Delivery) |
Contributor
Author
|
Thanks @abdonpijpelink! |
This was referenced Sep 11, 2023
Contributor
Author
💚 All backports created successfully
Questions ?Please refer to the Backport tool documentation |
jrodewig
added a commit
that referenced
this pull request
Sep 11, 2023
**Problem:** Other Elastic doc sets ([Beats](https://www.elastic.co/guide/en/beats/auditbeat/current/running-on-docker.html), [APM](https://www.elastic.co/guide/en/apm/guide/current/running-on-docker.html)) link to the [Verify the Elasticsearch Docker image signature](https://www.elastic.co/guide/en/elasticsearch/reference/8.9/docker.html#docker-verify-signature) section of the Docker docs. This section was removed as part of #99371. When we bump to the next version, this will create broken links and break the docs build. **Solution:** Re-add the anchor so we don't create broken links or break the docs build. This commit was added to the backports of #99371: - #99429 - #99430
jrodewig
added a commit
that referenced
this pull request
Sep 11, 2023
jrodewig
added a commit
that referenced
this pull request
Sep 11, 2023
This was referenced Sep 11, 2023
jrodewig
added a commit
to elastic/beats
that referenced
this pull request
Sep 13, 2023
**Problem:** The Beats Docker docs ([example](https://www.elastic.co/guide/en/beats/auditbeat/8.9/running-on-docker.html)) include an x-ref to the Elasticsearch docs for image verification. I recently removed this section as part of elastic/elasticsearch#99371. **Solution:** Replace the x-ref with info about image verification. Also: - Removes unneeded `ifeval` tags - Aligns notes for upcoming releases with those in the Elasticsearch docs
mergify bot
pushed a commit
to elastic/beats
that referenced
this pull request
Sep 13, 2023
**Problem:** The Beats Docker docs ([example](https://www.elastic.co/guide/en/beats/auditbeat/8.9/running-on-docker.html)) include an x-ref to the Elasticsearch docs for image verification. I recently removed this section as part of elastic/elasticsearch#99371. **Solution:** Replace the x-ref with info about image verification. Also: - Removes unneeded `ifeval` tags - Aligns notes for upcoming releases with those in the Elasticsearch docs (cherry picked from commit e96b4ef)
Scholar-Li
pushed a commit
to Scholar-Li/beats
that referenced
this pull request
Feb 5, 2024
**Problem:** The Beats Docker docs ([example](https://www.elastic.co/guide/en/beats/auditbeat/8.9/running-on-docker.html)) include an x-ref to the Elasticsearch docs for image verification. I recently removed this section as part of elastic/elasticsearch#99371. **Solution:** Replace the x-ref with info about image verification. Also: - Removes unneeded `ifeval` tags - Aligns notes for upcoming releases with those in the Elasticsearch docs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Problem:
The Docker Compose docs are overly long. They currently display the entire length of related
.envanddocker-compose.ymlfiles.Solution:
.envanddocker-compose.ymlfiles rather than display them.Closes https://github.com/elastic/platform-docs-team/issues/186
Depends on https://github.com/elastic/enterprise-search-pubs/pull/3788