Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  1. The first level should be restricted to high level concepts like APIs and Environments

  2. The second level is limited to one entity of a high level concept, i.e. a specific API. It can be grouped to give more structure to the options and allow for a quick scan of available options

  3. The third level is limited to sub-entities of an entity, i.e. a specific version of an API

View Naming

Views for a specific entity are named <Entity><View>.vue. There are two special views. The first is the list of all entities of this type (called <Entity>List.vue>) and the second is the view shell that displays the second level nav and hosts the detail pages (called <Entity>Details.vue).

Info

This convention replaces the Index<Entity> and Edit<Entity> naming.

Example for environments

Code Block
EnvironmentList
EnvironmentDetails
-----
EnvironmentOverview
EnvironmentSettings
EnvironmentDeployedAPIs

While this convention feels overly complex, it fulfills the requirement of the vue.js style guide that component names always have to consist of multiple words.