7.9 KiB
Estrutura do arquivo do currículo
Nosso conteúdo principal de instrução está localizado dentro de um diretório convenientemente chamado de curriculum
. Esta página descreverá como esses arquivos estão organizados.
Terminologia
Existem alguns termos que usamos quando discutimos o conteúdo do nosso currículo.
certification
: Quando nos referimos a uma certificação neste caso, estamos falando de um certificado factual que os usuários podem solicitar. Não estamos falando do nome do superBlock específico.superBlock
: Um superbloco é a coleção de desafios em nível superior. Cada superbloco corresponde a uma certificação no currículo (por exemplo, Design responsivo para a web).block
: Um bloco é uma seção dentro de um superbloco. Um bloco corresponde a um grupo de desafios em uma certificação determinada (por exemplo, HTML e HTML5 básicos)challenge
: Um desafio é uma lição única dentro do currículo (por exemplo, Conhecer os elementos HTML)
Árvore de arquivos
Ao usarmos esses termos, é assim que a estrutura de arquivos deve ser definida:
curriculum/
├─ _meta/
│ ├─ {block}/
│ │ ├─ meta.json
├─ {language}/
│ ├─ {superBlock}/
│ │ ├─ {block}/
│ │ │ ├─ {challenge}.md
O diretório _meta
O diretório _meta
é um diretório especial que contém arquivos .json
. Esses arquivos correspondem a cada bloco do currículo. Eles são usados para determinar a qual superbloco um bloco pertence, além da ordem dos desafios dentro daquele bloco.
Renomear arquivos
Pode haver situações em que você precise renomear um certificado, superbloco, bloco ou desafio. Esta seção delineará os passos necessários para evitar erros na build ao fazer isso.
[!ATTENTION] Renomear arquivos dentro da estrutura do currículo geralmente mudará o caminho (ou o URL) do conteúdo na página principal da web. Isso deve ser feito com cuidado, já que os redirecionamentos precisam ser configurados para cada mudança que é realizada.
Renomear uma certificação
Ao renomear uma certificação, você provavelmente vai querer renomear o superbloco associado a ela. Faça o seguinte para renomear somente o certificado:
- Renomeie a pasta
curriculum/challenges/_meta/{superBlock}-certficate
com o novo nome. - No arquivo
meta.json
daquela pasta, renomeie os valores emname
,dashedName
echallengeOrder
para o novo nome do certificado. - Em
curriculum/challenges/english/12-certificate
, renomeie a pasta{superBlock}-certificate
e o arquivo YAML dentro dela com o novo nome. - No arquivo YAML, altere o
title
para o novo nome. - Renomeie o arquivo e a pasta da etapa 3 para o resto dos idiomas do currículo.
- Atualize
client/src/redux/index.ts
para que ele use otitle
correto. - Optionally, update the
certSlug
for the superblock in the same file. Note that renaming acertSlug
will change the URL for certifications and should only be done with careful consideration. - Update the
title
inclient/src/resources/cert-and-project-map.ts
to the new value. Note that changing thetitle
here will break the superBlock page for the associated certification. It relies on the superBlock title to match the certification title. You will likely want to rename the superBlock at the same time. - Se você renomeou o
certSlug
na etapa 7, altere aqui para o cert e para todos os valores deprojects
aninhados. - Em
config/certification-settings.js
, atualize o valor decertTypeTitleMap
para o novo nome. - Se você renomeou o
certSlug
na etapa 7, atualize a chave decertSlugTypeMap
no mesmo arquivo. - Atualize o nome do certificado no array
legacyCerts
declient/src/client-only-routes/show-project-links.tsx
, se necessário. - Atualize o arquivo
README.md
principal com o novo nome.
Renomear um superbloco
[!NOTE] Ao renomear um superbloco, o novo nome de pasta é usado como o caminho e deve ser considerado o nome "correto". Todos os outros valores deverão ser atualizados para refletir essa mudança.
Além disso, você provavelmente vai querer renomear o certificado e o bloco {superBlock}-projects
quando renomear um superbloco, já que todos compartilham um mesmo nome. Para renomear somente um superbloco, você precisa:
- Renomear a pasta do superbloco no diretório
curriculum/challenges/english
. - Renomear a pasta do superbloco em todos os outros diretórios
curriculum/challenges/{language}
. - Para cada bloco naquele superbloco, atualize o valor de
superBlock
no arquivometa.json
até seu dashedName. Você não precisa renomear as pastas aqui. Faça isso ao renomear um bloco. - Renomeie a pasta do superbloco em
client/src/pages/learn
. - Atualize o arquivo
index.md
na pasta acima, alterando os valores detitle
esuperBlock
com o novo nome. - Para cada pasta de bloco que estiver dentro daquela citada acima, atualize o
index.md
para que use o valorsuperBlock
correto. - In the
client/src/resources/cert-and-project-map.ts
file, update the path for the cert at the top of the file, and thetitle
value for that superBlock. Note that changing thetitle
here will break the ability to view the actual certification for this superBlock. It relies on the superBlock title to match the certification title. You will likely want to rename the certification at the same time. - Atualize a chave
superBlockCertTypeMap
emconfig/certification-settings.js
para o novo nome do superbloco. - Atualize o valor do caminho em
client/src/assets/icons/index.tsx
. - For each language in
client/i18n/locales
, update theintro.json
file to use the new superBlockdashedName
. In the English file, also update thetitle
. - Verifique o arquivo
config/i18n/all-langs.js
para ver se o superbloco está habilitado para as builds do i18n. Atualize todos os valores onde ele for utilizado. - Atualize o arquivo
README.md
principal com o novo nome.
Renomear um bloco
Ao renomear um bloco do currículo, você precisa:
- Mudar o nome da pasta do bloco no diretório
curriculum/challenges/english/{superBlock}
. - Mudar o nome da mesma pasta do bloco em todos os outros diretórios de idioma para que correspondam. Eles devem ter a mesma estrutura que a do inglês ou haverá um erro na build.
- Mudar o nome da pasta do bloco no diretório
_meta
. - Atualizar as propriedades
name
edashedName
para aquele arquivometa.json
do bloco. - Atualizar
client/utils/help-category-map.json
para que use o novo nome do bloco como chave. - Atualizar a pasta do bloco em
client/src/pages/learn/{superBlock}
. - No arquivo
index.md
da pasta acima, atualize o valor deblock
no frontmatter. - In the
client/i18n/locales/{language}/intro.json
files, update the block name to the new name for all the languages. In the Englishintro.json
file, update thetitle
as well. - Atualize o arquivo
README.md
principal com o novo nome.
Renomear um desafio
Ao renomear um único arquivo de desafio, você precisa:
- Mudar o nome do arquivo do desafio no diretório
curriculum/challenges/english/
. - Mudar o nome de
title
e dedashedName
naquele arquivo. - Mudar o
dashedName
naqueles arquivos para todos os outros diretórios de idiomas para que correspondam. - Atualizar o nome do desafio no arquivo
meta.json
relevante. Os nomes dos desafios não são usados na build, mas fornecem uma alternativa mais fácil de identificar a ordem dos desafios. - Se o desafio for um projeto de certificado, atualize o arquivo YAML em
curriculum/english/12-certificates/<superBlock>
para o novo nome. - Se o desafio for um projeto de certificado, atualize o arquivo
README.md
principal com o novo nome.
A propriedade dashedName
The dashedName
property is used to generate the URL path for the superblock, block, or challenge. These should generally match what the /utils/dasherize.js
helper would output for the file name.