devportal icon indicating copy to clipboard operation
devportal copied to clipboard

Style guide: formatting of the name Aiven Console

Open staceysalamon-aiven opened this issue 2 years ago • 2 comments

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?

staceysalamon-aiven avatar Oct 17 '22 09:10 staceysalamon-aiven

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.

TibsAtWork avatar Oct 17 '22 12:10 TibsAtWork

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

lornajane avatar Nov 09 '22 19:11 lornajane