Skip to content

Conversation

@dedemorton
Copy link
Contributor

@dedemorton dedemorton commented Sep 22, 2020

Add edits and structural fixes for the messed up book structure:

image

Inconsistencies in the rendering of table and example titles made the docs harder to scan, so I removed those. I also flattened out the heading hierarchy a bit because the flattened structure will work better in the future doc design.

@dedemorton dedemorton added docs review needs_backport PR is waiting to be backported to other branches. Team:Integrations Label for the Integrations team v8.0.0 v7.9.0 Team:Docs Label for the Observability docs team labels Sep 22, 2020
@dedemorton dedemorton requested a review from sayden September 22, 2020 21:43
@elasticmachine
Copy link
Collaborator

Pinging @elastic/integrations (Team:Integrations)

@elasticmachine
Copy link
Collaborator

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

@botelastic botelastic bot added needs_team Indicates that the issue/PR needs a Team:* label and removed needs_team Indicates that the issue/PR needs a Team:* label labels Sep 22, 2020
@elasticmachine
Copy link
Collaborator

elasticmachine commented Sep 22, 2020

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #21233 updated]

  • Start Time: 2020-10-01T02:51:07.710+0000

  • Duration: 24 min 42 sec

@dedemorton dedemorton self-assigned this Sep 24, 2020
@dedemorton dedemorton requested a review from a team September 29, 2020 18:10
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.

A couple of comments. LGTM.

@dedemorton dedemorton merged commit 8e9298e into elastic:master Oct 1, 2020
@dedemorton dedemorton deleted the fix_sql_doc_structure branch October 1, 2020 18:59
dedemorton added a commit to dedemorton/beats that referenced this pull request Oct 1, 2020
* Edit SQL module docs and fix broken doc structure

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>

* Run make update

Co-authored-by: Brandon Morelli <[email protected]>
dedemorton added a commit to dedemorton/beats that referenced this pull request Oct 1, 2020
* Edit SQL module docs and fix broken doc structure

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>

* Run make update

Co-authored-by: Brandon Morelli <[email protected]>
dedemorton added a commit that referenced this pull request Oct 1, 2020
* Edit SQL module docs and fix broken doc structure

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>

* Run make update

Co-authored-by: Brandon Morelli <[email protected]>

Co-authored-by: Brandon Morelli <[email protected]>
dedemorton added a commit that referenced this pull request Oct 1, 2020
* Edit SQL module docs and fix broken doc structure

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>

* Run make update

Co-authored-by: Brandon Morelli <[email protected]>

Co-authored-by: Brandon Morelli <[email protected]>
v1v added a commit to v1v/beats that referenced this pull request Oct 2, 2020
* upstream/master: (27 commits)
  [Ingest Manager] Split index restrictions into type,dataset, namespace parts (elastic#21406)
  Update Filebeat module expected logs files (elastic#21454)
  Edit SQL module docs and fix broken doc structure (elastic#21233)
  [Ingest Manager] Send snapshot flag together with metadata (elastic#21285)
  Revert "[JJBB] Set shallow cloning to 10 (elastic#21409)" (elastic#21447)
  [JJBB] Use reference repo for fast checkouts (elastic#21410)
  Add initial skeleton of filestream input (elastic#21427)
  Initial spec file for apm-server (elastic#21225)
  [Ingest Manager] Upgrade Action: make source URI optional (elastic#21372)
  Add field limit check for AWS Cloudtrail flattened fields (elastic#21388)
  [Winlogbeat] Move winlogbeat javascript processor to libbeat (elastic#21402)
  ci: pipeline to generate the changelog (elastic#21426)
  [JJBB] Set shallow cloning to 10 (elastic#21409)
  docs: add link to release notes for 7.9.2 (elastic#21405) (elastic#21419)
  docs: Prepare Changelog for 7.9.2 (elastic#21229) (elastic#21403)
  fix: mark flaky tests (elastic#21300)
  fix: use a fixed version of setuptools (elastic#21393)
  Move Kubernetes events metricset to its own block in reference config (elastic#21407)
  [libbeat] Enable WriteAheadLimit in the disk queue (elastic#21391)
  docs: fix apt/yum formatting (elastic#21362)
  ...
v1v added a commit to v1v/beats that referenced this pull request Oct 2, 2020
…ne-2.0-arm

* upstream/master: (54 commits)
  [CI] Change x-pack/auditbeat build events (comments, labels) (elastic#21463)
  [CI] changeset from elastic#20603 was not added to CI2.0 (elastic#21464)
  Add new log file reader for filestream input (elastic#21450)
  [CI] Send slack message with build status (elastic#21428)
  Remove duplicated sources url in dependencies report (elastic#21462)
  Add implementation of FSWatcher and FSScanner for filestream (elastic#21444)
  [Ingest Manager] Split index restrictions into type,dataset, namespace parts (elastic#21406)
  Update Filebeat module expected logs files (elastic#21454)
  Edit SQL module docs and fix broken doc structure (elastic#21233)
  [Ingest Manager] Send snapshot flag together with metadata (elastic#21285)
  Revert "[JJBB] Set shallow cloning to 10 (elastic#21409)" (elastic#21447)
  [JJBB] Use reference repo for fast checkouts (elastic#21410)
  Add initial skeleton of filestream input (elastic#21427)
  Initial spec file for apm-server (elastic#21225)
  [Ingest Manager] Upgrade Action: make source URI optional (elastic#21372)
  Add field limit check for AWS Cloudtrail flattened fields (elastic#21388)
  [Winlogbeat] Move winlogbeat javascript processor to libbeat (elastic#21402)
  ci: pipeline to generate the changelog (elastic#21426)
  [JJBB] Set shallow cloning to 10 (elastic#21409)
  docs: add link to release notes for 7.9.2 (elastic#21405) (elastic#21419)
  ...
v1v added a commit to v1v/beats that referenced this pull request Oct 2, 2020
…ci-build-label-support

* upstream/master:
  [CI] Change x-pack/auditbeat build events (comments, labels) (elastic#21463)
  [CI] changeset from elastic#20603 was not added to CI2.0 (elastic#21464)
  Add new log file reader for filestream input (elastic#21450)
  [CI] Send slack message with build status (elastic#21428)
  Remove duplicated sources url in dependencies report (elastic#21462)
  Add implementation of FSWatcher and FSScanner for filestream (elastic#21444)
  [Ingest Manager] Split index restrictions into type,dataset, namespace parts (elastic#21406)
  Update Filebeat module expected logs files (elastic#21454)
  Edit SQL module docs and fix broken doc structure (elastic#21233)
  [Ingest Manager] Send snapshot flag together with metadata (elastic#21285)
  Revert "[JJBB] Set shallow cloning to 10 (elastic#21409)" (elastic#21447)
  [JJBB] Use reference repo for fast checkouts (elastic#21410)
  Add initial skeleton of filestream input (elastic#21427)
  Initial spec file for apm-server (elastic#21225)
  [Ingest Manager] Upgrade Action: make source URI optional (elastic#21372)
  Add field limit check for AWS Cloudtrail flattened fields (elastic#21388)
  [Winlogbeat] Move winlogbeat javascript processor to libbeat (elastic#21402)
  ci: pipeline to generate the changelog (elastic#21426)
@sayden
Copy link
Contributor

sayden commented Oct 5, 2020

I'm coming a bit late but thanks for the help with the new structure! and all the corrections 😃

@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Oct 17, 2020
leweafan pushed a commit to leweafan/beats that referenced this pull request Apr 28, 2023
…astic#21452)

* Edit SQL module docs and fix broken doc structure

* Apply suggestions from code review

Co-authored-by: Brandon Morelli <[email protected]>

* Run make update

Co-authored-by: Brandon Morelli <[email protected]>

Co-authored-by: Brandon Morelli <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs review Team:Docs Label for the Observability docs team Team:Integrations Label for the Integrations team v7.9.0 v8.0.0

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants