Skip to content

docs: New APM configuration section#10790

Merged
carsonip merged 9 commits intoelastic:mainfrom
bmorelli25:ft-new-config
May 15, 2023
Merged

docs: New APM configuration section#10790
carsonip merged 9 commits intoelastic:mainfrom
bmorelli25:ft-new-config

Conversation

@bmorelli25
Copy link
Member

Summary

This PR is mostly structural. It moves the Configure section up two levels in the navigation. This requires many heading-level changes. I also moved all of the configure documentation to a new subdirectory so it's easier to find and edit.

Separating this into its own PR should make the content changes that are coming easier to review.

@mergify
Copy link
Contributor

mergify bot commented May 10, 2023

This pull request does not have a backport label. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you need to add the backport labels for the needed
branches, such as:

  • backport-7.x is the label to automatically backport to the 7.x branch.
  • backport-7./d is the label to automatically backport to the 7./d branch. /d is the digit

NOTE: backport-skip has been added to this pull request.

@mergify mergify bot added the backport-skip Skip notification from the automated backport with mergify label May 10, 2023
@ghost
Copy link

ghost commented May 10, 2023

💚 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: 2023-05-15T23:12:13.148+0000

  • Duration: 1 min 59 sec

🤖 GitHub comments

Expand to view the GitHub comments

To re-run your PR in the CI, just comment with:

  • /test : Re-trigger the build.

  • /package : Generate and publish the docker images.

  • /test windows : Build & tests on Windows.

  • run elasticsearch-ci/docs : Re-trigger the docs validation. (use unformatted text in the comment!)

@bmorelli25 bmorelli25 marked this pull request as ready for review May 10, 2023 20:42
@bmorelli25 bmorelli25 requested a review from a team May 10, 2023 20:42
@bmorelli25 bmorelli25 self-assigned this May 10, 2023
Copy link
Contributor

@simitt simitt left a comment

Choose a reason for hiding this comment

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

I have several comments for the content, but keep them (mostly) for the dedicated content PR. From the structural changes, this LGTM


URL::
The publicly reachable server URL. For deployments on Elastic Cloud or ECK, the default is unchangeable.
+
Copy link
Contributor

Choose a reason for hiding this comment

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

note on content: we should add that the URL is purely informational, and has no effect on where the server is reachable. For changing where the server is listening, the Host needs to be configured.

@bmorelli25 totally up to you if you want to add this here or in a follow up PR

Copy link
Member Author

Choose a reason for hiding this comment

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

As discussed offline with Silvia on 10/05/23, I'll address this and all other feedback in the follow-up PR.

==== `max_header_size`
=== `max_header_size`
Maximum permitted size of a request's header accepted by the server to be processed (in Bytes).
Defaults to 1048576 Bytes (1 MB).
Copy link
Contributor

Choose a reason for hiding this comment

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

The host and max_header_size are duplicated now (as they are also documented in the general section)

@mergify
Copy link
Contributor

mergify bot commented May 15, 2023

This pull request is now in conflicts. Could you fix it @bmorelli25? 🙏
To fixup this pull request, you can check out it locally. See documentation: https://help.github.com/articles/checking-out-pull-requests-locally/

git fetch upstream
git checkout -b ft-new-config upstream/ft-new-config
git merge upstream/main
git push upstream ft-new-config

bmorelli25 and others added 2 commits May 15, 2023 16:10
…new-config

# Conflicts:
#	docs/configure/agent-config.asciidoc
Co-authored-by: Silvia Mitter <silvia.mitter@elastic.co>
@carsonip carsonip merged commit a814460 into elastic:main May 15, 2023
bmorelli25 added a commit to bmorelli25/apm-server that referenced this pull request May 23, 2023
This PR is mostly structural. It moves the Configure section up two levels in the navigation. This requires many heading-level changes. I also moved all of the configure documentation to a new subdirectory so it's easier to find and edit.

Separating this into its own PR should make the content changes that are coming easier to review.
# Conflicts:
#	docs/configure/general.asciidoc
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport-skip Skip notification from the automated backport with mergify

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants