Skip to content

Beats: add x-pack/filebeat/docs to contents#507

Merged
dedemorton merged 2 commits intoelastic:masterfrom
adriansr:beats-xpack-docs
Dec 14, 2018
Merged

Beats: add x-pack/filebeat/docs to contents#507
dedemorton merged 2 commits intoelastic:masterfrom
adriansr:beats-xpack-docs

Conversation

@adriansr
Copy link
Copy Markdown
Contributor

This PR adds the x-pack/filebeat/docs to the list of directories to look for docs in Filebeat. This is needed so that we can include x-pack specific docs.

This patch adds the x-pack/filebeat/docs to the list of
directories to look for docs in Filebeat. This is needed so that
we can include x-pack specific docs.
@lcawl
Copy link
Copy Markdown
Contributor

lcawl commented Dec 14, 2018

In case it makes a difference, we're slowly getting rid of that folder structure in the elasticsearch repo and have already removed it from kibana. The "x-pack" content is now just mixed in with the rest.

@lcawl
Copy link
Copy Markdown
Contributor

lcawl commented Dec 14, 2018

My advice would be to leave the x-pack content in the regular docs folder, but if you do go this route of separation I think you'll need to make some additional changes:

  1. Add a --resource parameter to your build command for master (e.g. similar to the docbldesx alias in https://github.com/elastic/docs/blob/master/doc_build_aliases.sh)
  2. Add a separate build alias for 6.x and earlier releases, since they won't use that resource
  3. If you don't already have it, you might also need to add an attribute that clarifies the path to that the two different directories, like the es-repo-dir and xes-repo-dir attributes here: https://raw.githubusercontent.com/elastic/elasticsearch/master/docs/reference/index.asciidoc

@dedemorton
Copy link
Copy Markdown
Contributor

dedemorton commented Dec 14, 2018

@lcawl Which of the changes listed above need to be made before this PR is merged? The Beats docs use relative paths right now in the include statements (not attributes). We should probably improve that, but it hasn't caused build issues so far.

Copy link
Copy Markdown
Contributor

@lcawl lcawl left a comment

Choose a reason for hiding this comment

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

The syntax of this change is fine, though I've left two comments

@dedemorton dedemorton merged commit 9fd2fb6 into elastic:master Dec 14, 2018
@lcawl
Copy link
Copy Markdown
Contributor

lcawl commented Dec 14, 2018

@dedemorton If I remember correctly, the first errors you'll see will likely be related to files that have images in them.

bmorelli25 pushed a commit to bmorelli25/docs that referenced this pull request Feb 15, 2019
* Beats: add x-pack/filebeat/docs to contents

This patch adds the x-pack/filebeat/docs to the list of
directories to look for docs in Filebeat. This is needed so that
we can include x-pack specific docs.

* Set exclude_branches
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants