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

Edit Elastic Agent docs #19146

Merged
merged 2 commits into from
Jun 12, 2020
Merged

Edit Elastic Agent docs #19146

merged 2 commits into from
Jun 12, 2020

Conversation

dedemorton
Copy link
Contributor

Summary of changes:

  • Break content into separate files so that there is a one to one mapping between the source and html file.
  • Clean up asciidoc coding
  • Change heading levels because we want to control nesting from the TOC rather than section levels (makes it easier to move content around and contributors don't need to worry about heading levels).
  • More edits...moved some things around to improve the flow of ideas.
  • Changed the name of the top-level container because I think it's weird to have two getting started guides in the same doc.

Here's what the TOC looks like when this is hooked into the nav (agent will resolve to Elastic Agent):

image

@dedemorton dedemorton added docs needs_backport PR is waiting to be backported to other branches. Team:Ingest Management v7.8.0 labels Jun 11, 2020
@dedemorton dedemorton requested review from ph and nchaulet June 11, 2020 22:35
@elasticmachine
Copy link
Collaborator

Pinging @elastic/ingest-management (Team:Ingest Management)

@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 Jun 11, 2020
@dedemorton
Copy link
Contributor Author

cc @bmorelli25 In case you want to review. Progress over perfection here....

@dedemorton dedemorton mentioned this pull request Jun 11, 2020
Closed
66 tasks
@elasticmachine
Copy link
Collaborator

elasticmachine commented Jun 11, 2020 •
edited
Loading

💚 Build Succeeded

Pipeline View Test View Changes Artifacts preview

Expand to view the summary

Build stats

  • Build Cause: [Pull request #19146 updated]

  • Start Time: 2020-06-12T16:23:51.352+0000

  • Duration: 23 min 24 sec

@dedemorton dedemorton self-assigned this Jun 12, 2020
ph
ph approved these changes Jun 12, 2020
View reviewed changes
Copy link
Contributor

@ph ph left a comment

Choose a reason for hiding this comment

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

Added two notes for configuration and datasource, this look good.

x-pack/elastic-agent/docs/elastic-agent-configuration-example.asciidoc Show resolved Hide resolved
x-pack/elastic-agent/docs/elastic-agent-configuration.asciidoc Outdated Show resolved Hide resolved
michalpristas
michalpristas approved these changes Jun 12, 2020
View reviewed changes
Copy link
Contributor

@michalpristas michalpristas left a comment

Choose a reason for hiding this comment

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

👍

@dedemorton dedemorton merged commit 2991320 into elastic:master Jun 12, 2020
@dedemorton dedemorton deleted the update_agent_asciidoc_tags branch June 12, 2020 17:06
@dedemorton dedemorton mentioned this pull request Jun 12, 2020
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Jun 12, 2020
@dedemorton
Edit Elastic Agent docs (elastic#19146)
6aa777c 
* Edit Elastic Agent docs

* Remove example config and reviewer notes
@dedemorton dedemorton mentioned this pull request Jun 12, 2020
Merged
dedemorton added a commit to dedemorton/beats that referenced this pull request Jun 12, 2020
@dedemorton
Edit Elastic Agent docs (elastic#19146)
39b9dd3 
* Edit Elastic Agent docs

* Remove example config and reviewer notes
dedemorton added a commit that referenced this pull request Jun 12, 2020
@dedemorton
Edit Elastic Agent docs (#19146) (#19169)
5566feb 
* Edit Elastic Agent docs

* Remove example config and reviewer notes
dedemorton added a commit that referenced this pull request Jun 12, 2020
@dedemorton
Edit Elastic Agent docs (#19146) (#19170)
b3156aa 
* Edit Elastic Agent docs

* Remove example config and reviewer notes
v1v added a commit to v1v/beats that referenced this pull request Jun 15, 2020
@v1v
Merge remote-tracking branch 'upstream/master' into feature/fix-warni…
1a069b1 
…ngs-archive

* upstream/master:
  Fix minor spelling error in Jenkinsfile (elastic#19153)
  [CI] fail if not possible to install python3 (elastic#19164)
  [Elastic Agent] Improved mage demo experience (elastic#18445)
  [yum] Clear cached data and add retry loop (elastic#19182)
  fix lint job by updating NOTICE (elastic#19161)
  Fix tags for coredns/envoyproxy (elastic#19134)
  Disable host.* fields by default for CrowdStrike module (elastic#19132)
  Allow host.* fields to be disabled in Zeek module (elastic#19113)
  Rename to management.Manager, add UpdateStatus to Manager interface. (elastic#19114)
  Edit Elastic Agent docs (elastic#19146)
  [JJBB] create job definition for the golang-crossbuild project (elastic#19162)
  Fix incorrect usage of hints builder when exposed port is a substring of the hint (elastic#19052)
  Add basic cloudfoundry integration tests (elastic#19018)
@dedemorton dedemorton removed the needs_backport PR is waiting to be backported to other branches. label Jun 15, 2020
melchiormoulin pushed a commit to melchiormoulin/beats that referenced this pull request Oct 14, 2020
@dedemorton @melchiormoulin
Edit Elastic Agent docs (elastic#19146)
1a9e35c 
* Edit Elastic Agent docs

* Remove example config and reviewer notes
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ph ph ph approved these changes

@michalpristas michalpristas michalpristas approved these changes

@nchaulet nchaulet Awaiting requested review from nchaulet

Assignees

@dedemorton dedemorton

Labels
docs v7.8.0
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@dedemorton @elasticmachine @ph @michalpristas