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

Proposed changes to https://oui.opensearch.org/1.2/#/ #975

Open
natebower opened this issue Aug 17, 2023 · 1 comment
Open

Proposed changes to https://oui.opensearch.org/1.2/#/ #975

natebower opened this issue Aug 17, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request OUIDocs

Comments

@natebower
Copy link

natebower commented Aug 17, 2023

My proposed changes are as follows:

Table headings

  1. Delete this:

Delete2

And replace it with this (but make it pretty 😄):

Replace

Source: https://github.com/opensearch-project/documentation-website/blob/main/STYLE_GUIDE.md#ui-text

  1. Delete this, which I think is unnecessary. Instead, I would add a note here that, as an exception, proper nouns should always use title case and that our naming conventions should be followed in all cases:

Delete

  1. Add our UI text guidelines to the page, where UX deems appropriate. Links to the UI text section of the style guide are fine where we feel that something is too in the weeds. For example, a link to the Mechanics section may be sufficient.
@BSFishy BSFishy added documentation Improvements or additions to documentation enhancement New feature or request and removed untriaged labels Aug 17, 2023
@BSFishy
Copy link
Contributor

BSFishy commented Aug 17, 2023

revert #503

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request OUIDocs
Projects
None yet
Development

No branches or pull requests

3 participants