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.

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

Restructuring: Cleanup and reconcile shared attribute definitions used in the docs #6144

Closed
dedemorton opened this issue Jan 23, 2018 · 3 comments
Assignees

Comments

@dedemorton
Copy link
Contributor

We currently have all the global Beats attributes defined in a shared file here.

Some of these attributes are essentially duplicates of the shared attributes here.

Since the shared attributes were created after the Beats documentation, there's a mismatch with the names.

Any attributes that are common to ALL docs (and not just Beats) should be moved to the shared file and the names should be reconciled (and replaced throughout the Beats docs).

I'm waiting for a resolution on the following issue before proceeding with these changes: elastic/docs#220

@dedemorton
Copy link
Contributor Author

Also look at branch and doc-branch in the version file. The x-pack topics included in beats require the branch attribute. If the usage of branch is identical to doc-branch, we should standardize on branch.

@dedemorton dedemorton changed the title Cleanup and reconcile shared attribute definitions used in the docs Restructuring: Cleanup and reconcile shared attribute definitions used in the docs Sep 28, 2018
@dedemorton
Copy link
Contributor Author

@bmorelli25 FYI in case you notice some weirdness in the way we've defined asciidoc attributes. I was hoping to have unresolved attribute handling added to the doc build before proceeding with this change because right now unresolved attributes fail silently. Might have to go ahead, though, because I've been waiting on this for a very long time.

@dedemorton
Copy link
Contributor Author

Closed by #10956

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant