Documentation for numeral pattern formatting #57616
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
wylieconlon
added
Team:Docs
v8.0.0
Team:AppArch
release_note:skip
|
Pinging @elastic/kibana-docs (Team:Docs) |
|
Pinging @elastic/kibana-app-arch (Team:AppArch) |
gchaps
reviewed
Feb 13, 2020
docs/management/numeral.asciidoc
Outdated
|
|
||
| The `o` pattern will display a locale-specific positional value like `1st` or `2nd`. | ||
| This pattern has limited support for localization, especially in languages | ||
| with multiple forms such as German. |
There was a problem hiding this comment.
Suggested change
| with multiple forms such as German. | |
| with multiple forms, such as German. |
| @@ -131,6 +131,8 @@ include::{kib-repo-dir}/management/managing-licenses.asciidoc[] | |||
|
|
|||
| include::{kib-repo-dir}/management/managing-remote-clusters.asciidoc[] | |||
|
|
|||
| include::{kib-repo-dir}/management/numeral.asciidoc[] | |||
There was a problem hiding this comment.
Not sure about the location of the doc here. The top-level items are related to UIs in the Management app. Can it go under Index Patters and Fields, so it is closer to Numeric Field Formatters.
If you decided to keep this as a top-level item under Management, move the item up so it is in alphabetical order like the rest of the topics in this section.
There was a problem hiding this comment.
@gchaps This is the one I think I need help with. The formatting options here are used in multiple places in Management, but also in TSVB and Canvas. It could even be a separate page at the top level, similar to the Limitations page, because it's used across Kibana. Thoughts?
There was a problem hiding this comment.
@wylieconlon GIven what you said, I think Management is the best place. I would move it so it appears between License Management and Remote Clusters.
Also, do you think it's worth mentioning in the doc the different places where numeral formatting is used?
wylieconlon
changed the title
spalger
reviewed
Feb 21, 2020
cqliu1
approved these changes
Feb 21, 2020
| @@ -9,24 +9,22 @@ import { formatnumber } from '../../../canvas_plugin_src/functions/common/format | |||
| import { FunctionHelp } from '../function_help'; | |||
| import { FunctionFactory } from '../../../types'; | |||
| import { NUMERALJS } from '../../constants'; | |||
| // import { getDocumentationLinks } from '../../../public/lib/documentation_links'; | |||
There was a problem hiding this comment.
It looks like we can't access doc links from our i18n strings since they don't live in /public, but I think we should still figure out a way to insert a link into the help text here. This isn't a blocker for this PR. I'll file an issue to solve this later.
| @@ -9,6 +9,7 @@ import { metric } from '../../../canvas_plugin_src/functions/common/metric'; | |||
| import { FunctionHelp } from '../function_help'; | |||
| import { FunctionFactory } from '../../../types'; | |||
| import { FONT_FAMILY, FONT_WEIGHT, CSS, NUMERALJS } from '../../constants'; | |||
| // import { getDocumentationLinks } from '../../../public/lib/documentation_links'; | |||
|
@elasticmachine merge upstream |
lizozom
reviewed
Feb 22, 2020
| `format:number:defaultLocale`:: The http://numeraljs.com/[numeral language] locale. | ||
| `format:number:defaultPattern`:: The default http://numeraljs.com/[numeral format] for the "number" format. | ||
| `format:percent:defaultPattern`:: The default http://numeraljs.com/[numeral format] for the "percent" format. | ||
| `format:number:defaultLocale`:: The <<numeral, numeral patteern>> locale. |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
|
@elasticmachine merge upstream |
💛 Build succeeded, but was flaky
Test FailuresKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "before each" hook for "should return 404 when not overwriting, without references"Standard OutStack TraceKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "before each" hook for "should return 404 when not overwriting, without references"Standard OutStack TraceKibana Pipeline / kibana-xpack-agent / X-Pack Spaces API Integration Tests -- security_and_spaces.x-pack/test/spaces_api_integration/security_and_spaces/apis/resolve_copy_to_space_conflicts·ts.spaces api with security resolve copy to spaces conflicts user with no access from the default space "after each" hook for "should return 404 when not overwriting, without references"Standard OutStack TraceHistory
To update your PR or re-run it, just comment with: |
|
Flakiness is unrelated to my change. Merging. |
wylieconlon
pushed a commit
that referenced
this pull request
Feb 26, 2020
* Documentation for Elastic Numeral formatting * Tweaks from feedback * Updates from feedback * Fix and update examples * Add TODOs * Fix typo Co-authored-by: Elastic Machine <[email protected]> Co-authored-by: Elastic Machine <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
As part of our effort to move away from numeral, we are no longer relying on third-party docs. This PR creates a docs in
Management > Numeral Formattingand links to that docs page instead of the third-party docs.Closes #57363
Checklist
Delete any items that are not applicable to this PR.