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

Change format of exported fields reference #12523

Closed
dedemorton opened this issue Jun 12, 2019 · 1 comment
Closed

Change format of exported fields reference #12523

dedemorton opened this issue Jun 12, 2019 · 1 comment
Labels

Comments

@dedemorton
Copy link
Contributor

dedemorton commented Jun 12, 2019

As a follow up to #12242, we want to make additional changes to the layout of the exported fields docs (for example, https://www.elastic.co/guide/en/beats/metricbeat/current/exported-fields.html).

Phase 1:

  • Remove sections that do not add value.
  • Improve fields descriptions where needed.
  • Replace each removed section with an entry that describes the group. For example, instead of having the hierarchy Apache fields > apache > status, we would remove the sections and instead have something that looks like this:

image

Phase 2:

  • As soon our doc layout supports having columns that contain long field names, format the field descriptions in tables rather than definition lists. (Right now, the right-hand navigation severely restricts the allowed width of columns, and the asciidoc settings that control column width are not available with our current doc tool chain.)
  • It might also be nice to revisit which info is important to users and how we present that info. For example, showing type: keyword takes up a lot of space. Could we present this info in a better way? Maybe in text in parentheses? In gray text? Another col in the table?

@ruflin FYI.

@dedemorton
Copy link
Contributor Author

With future plans in mind, I don't think it makes sense to move forward with these changes, so I'm closing this issue.

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

No branches or pull requests

1 participant