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

[UI] Labelling the interface #206

Open
wants to merge 12 commits into
base: 5.x
Choose a base branch
from

Conversation

andersonjeccel
Copy link
Contributor

This PR adds documentation for better interface labels.

Copy link
Member

@RCheesley RCheesley left a comment

Choose a reason for hiding this comment

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

This looks great, a really good start! I have made a few comments but also I'd request we use quotation marks (" and ") only when indicating actual speech. For all others, use a single quote (' ') instead.

I agree in principle with the recommendations to remove all of the many ways that we use in the UI to indicate the same actions, and instead bring some consistency. This will, of course, have an impact on the translations so we might need to alert the translation teams to this when we merge the PR. It'll be quite a lot of work for them, I think.

docs/design/labelling.rst Outdated Show resolved Hide resolved
docs/design/labelling.rst Outdated Show resolved Hide resolved
docs/design/labelling.rst Outdated Show resolved Hide resolved
docs/design/labelling.rst Outdated Show resolved Hide resolved
docs/design/labelling.rst Outdated Show resolved Hide resolved
**Avoid:** You can use a Global Policy to apply changes to all Users


Simple writing
Copy link
Member

Choose a reason for hiding this comment

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

I think we should avoid using the word Simple - is there something else we can use instead? Perhaps 'Concise'?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Simple is different of Concise
The goal here is to convey the opposite of complex

Copy link
Member

Choose a reason for hiding this comment

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

Then we should use 'Clear', I think?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yeah, it works

docs/design/labelling.rst Outdated Show resolved Hide resolved

Saves changes without closing the dialog. These properties often affect subsequent system behavior.

Use instead of Save changes. Compare Save and Save as.
Copy link
Member

Choose a reason for hiding this comment

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

Could we use anchor links to the headings here? Makes it easier for the user to move around.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I guess I added everywhere

docs/design/labelling.rst Outdated Show resolved Hide resolved
docs/design/labelling.rst Outdated Show resolved Hide resolved
@RCheesley
Copy link
Member

Still outstanding comments here, plus conflicts to look at. Hopefully quick fixes though!

@RCheesley RCheesley added documentation Improvements or additions to documentation pending-feedback labels Oct 24, 2024
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 pending-feedback
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants