Slug
Nesta seção, você encontra o que são os identificadores únicos na StackSpot.
Sobre
Na StackSpot, os Slugs são identificadores únicos para as Contas, Estúdio, Stacks e Plugins e compõem as URLs da StackSpot.
O Slug é utilizado para facilitar o uso, identificação dentro da StackSpot por meio dos canais como o STK CLI e Portal. Auxilia também no compartilhamento de recursos importantes e identificação das Contas, Estúdio, Stacks e Plugins que são utilizados e compartilhados.
Quando você configurar os Slugs, as URLs dos recursos recebem o "nome" que identifica cada Conta, Estúdio, Stack e Plugin.
A URL gerada é facilmente utilizada para o uso e compartilhamento do recurso para todos os canais da StackSpot.
Confira a estrutura de cada Slug:
Conta
O Slug para a Conta fica no primeiro caminho do endereço da URL após o hostname da StackSpot (stackspot.com).
Exemplo:
# hostname / path 1
stackspot.com/account-slug
Toda Conta deve possuir um Slug como identificador único. Slugs de Account devem ser criados seguindo as regras na seção Criar Slugs e respeitando nomes reservados da StackSpot.
Estúdio
O Slug para o Estúdio fica no primeiro caminho do endereço da URL após o hostname da StackSpot (stackspot.com).
Exemplo:
# hostname / path 1 /
stackspot.com/studio-slug
Todo Estúdio precisa ter um Slug como identificador único dentro da sua Conta. Slugs de Estúdio devem ser criados sseguindo as regras na seção 'Criar Slugs' e respeitando nomes reservados da StackSpot.
Plugin
O Slug para o Plugin fica no segundo caminho do endereço da URL após o hostname da StackSpot (stackspot.com). Antes você precisa adicionar o slug do seu Estúdio.
Exemplo:
# hostname / path 1 / path 2
stackspot.com/studio-slug/plugin-slug
Stack
O Slug para a Stack fica no segundo caminho do endereço da URL após o hostname da StackSpot (stackspot.com). Antes você precisa adicionar o slug do seu Estúdio.
Exemplo:
# hostname / path 1 / path 2
stackspot.com/studio-slug/stack-slug
Toda Stack deve possuir um Slug como identificador único dentro da seu Estúdio. Slugs de Stacks devem ser criadosseguindo as regras na seção 'Criar Slugs' e respeitando nomes reservados da StackSpot.
Action
O Slug para a Action fica no segundo caminho do endereço da URL após o hostname da StackSpot (stackspot.com). Antes você precisa adicionar o slug do seu Estúdio.
Exemplo:
# hostname / path 1 / path 2
stackspot.com/studio-slug/action-slug
Toda Action deve possuir um Slug como identificador único dentro do seu Estúdio. CSlugs de Action devem ser criados seguindo as regras na seção criar Slugs e respeitando nomes reservados da StackSpot.
Criar Slug
Antes de criar os Slugs
Você precisa seguir algumas regras para que os Slugs sejam criados de forma padronizada e sem erros.
Os Slugs são criados e utilizados para compor a URL dos conteúdos, portanto devem seguir as sugestões da RFC3986, que especifica padrões para criação de URLs, evitando conflitos ao utilizá-las.
Regras de criação de Slug
Os slugs na StackSpot são únicos; você não pode usar um slug que já existe.
Para criar Slugs, para qualquer propósito (Conta, Stack, Estúdio), siga as especificações:
- Possuir no mínimo 3 caracteres;
- Possuir no máximo 30 caracteres;
- Os três primeiros caracteres não conter nenhum caractere especial (hífen);
- Seguir a convenção Kebab Case
(^[a-z0-9-]{3,30})([a-z0-9]+)*$
; - Não terminar com nenhum caractere especial;
- Todos os caracteres em caixa baixa (minúsculas);
- Respeitar os nomes reservados para uso da StackSpot.
Caracteres normais válidos:
(a-z): abcdefghijklmnopqrstuvwxyz
Caracteres especiais válidos:
(hífen): a-b-c-d-e
Nomes reservados
Alguns nomes de Slugs são de uso exclusivo da StackSpot. A lista informa os nomes que não estão disponíveis para você utilizar em Contas, Stacks e Estúdios.
Nomes de Slugs indisponíveis |
---|
login |
download |
studios |
enterprise |
workspaces |
settings |
plugins |
actions |
components |
tasks |
packages |
invite |
stackspot |
zup |
stk |