Skip to content

[DOCS] Adds Configuration section to PHP docs #1100

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
Merged
merged 1 commit into from
Feb 16, 2021
Merged

[DOCS] Adds Configuration section to PHP docs #1100

merged 1 commit into from
Feb 16, 2021

Conversation

szabosteve
Copy link
Contributor

@szabosteve szabosteve commented Jan 21, 2021 •
edited
Loading

Overview

This PR:

  • restructures the Configuration section in the PHP client documentation book:
    • chunks Configuration page content into subpages, so it won't be a one-pager
    • adds Namespaces, Connection pool, Selectors, Serializers, Per request configuration, and Future Mode as subsections of the Configuration section
    • moves the content of the Host configuration options, Set retries, Enabling logger, HTTP handler config, Connection factory, Endpoint closure, Config hash sections to separated files
  • adds discrete attributes to the section titles
  • deletes Authentication subsection from Configuration as the same info is available in Connecting
  • deletes PHP version requirement file as the same information is available in Installation.

This PR is part of the Client docs redesign effort. Related issue: https://github.com/elastic/clients-team/issues/257

Preview

PHP TOC
(Preview will be optimal after elastic/docs#2043 is merged.)

@szabosteve szabosteve requested a review from ezimuel January 21, 2021 16:59
@szabosteve szabosteve marked this pull request as ready for review January 21, 2021 17:02
ezimuel
ezimuel approved these changes Feb 16, 2021
View reviewed changes
Copy link
Contributor

@ezimuel ezimuel left a comment

Choose a reason for hiding this comment

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

LGTM, the CI errors are not related with this PR, I'm going to merge it.

@ezimuel ezimuel merged commit 35eab26 into elastic:master Feb 16, 2021
@szabosteve szabosteve deleted the drs.config branch February 16, 2021 10:20
szabosteve added a commit to szabosteve/elasticsearch-php that referenced this pull request Feb 16, 2021
@szabosteve
[DOCS] Adds Configuration section to PHP docs. (elastic#1100)
6b18fc8
@szabosteve szabosteve mentioned this pull request Feb 16, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ezimuel ezimuel ezimuel approved these changes

Assignees
No one assigned
Labels
8.0 Documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@szabosteve @ezimuel