Skip to content
This repository has been archived by the owner on Jan 29, 2024. It is now read-only.

Style guide: formatting of the name Aiven Console #1461

Open
staceysalamon-aiven opened this issue Oct 17, 2022 · 2 comments
Open

Style guide: formatting of the name Aiven Console #1461

staceysalamon-aiven opened this issue Oct 17, 2022 · 2 comments
Labels
linting Changes to the vale setup we use for linting our docs

Comments

@staceysalamon-aiven
Copy link
Contributor

What can we help you with?

Our internal guidelines for the console indicate that the console should ideally be referred to as Aiven Console, or the Aiven Console (both using title case). In the docs, it is sometimes referred to as Aiven console or the Aiven web console.

Do we want to standardize this across all docs and, if so, which format should we use?

@TibsAtWork
Copy link
Contributor

Note: once (if) we decide on exact terminology, we can write a couple of linting rules to help catch cases of the wrong term and the wrong capitalisation, and they will help find places we need to fix.

@lornajane
Copy link
Contributor

Thanks for raising this! I think we should aim for Aiven Console if we're using that elsewhere.

@TibsAtWork TibsAtWork added the linting Changes to the vale setup we use for linting our docs label Nov 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
linting Changes to the vale setup we use for linting our docs
Projects
None yet
Development

No branches or pull requests

3 participants