testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

Open

#1.158 aberto em 19 de jan. de 2019

Ver no GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1.588 forks)batch import
help wantedresolution/acknowledgedtype/docs

Métricas do repositório

Stars
 (7.535 stars)
Métricas de merge de PR
 (Mesclagem média 2d 17h) (2 fundiu PRs em 30d)

Description

Improvement for the new mkdocs-based documentation.

Aim to replace the majority of inline code blocks in the docs with codeinclude macros, so that our examples are compiled and tested as part of the build.

This doesn't need to all be done in one PR - it probably ought to be split.

Pages that would benefit from this (in no particular order):

  • docs/features/container_logs.md
  • docs/features/commands.md
  • docs/features/creating_container.md
  • docs/features/creating_images.md
  • docs/features/files.md
  • docs/modules/docker_compose.md
  • docs/modules/elasticsearch.md
  • docs/modules/kafka.md
  • docs/modules/vault.md
  • docs/modules/webdriver_containers.md
  • docs/test_framework_integration/junit_4.md
  • docs/test_framework_integration/junit_5.md
  • docs/test_framework_integration/spock.md
  • docs/supported_docker_environment/logging_config.md

Guia do colaborador

Direção de pesquisa
Estude a documentação do mkdocs sobre a macro codeinclude, depois escolha uma página não marcada e substitua os blocos de código inline por referências codeinclude para os arquivos de origem apropriados.
Pilha de tecnologia
java
Domain
documentation
Tipo Issue
Documentação
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
Gitmkdocs
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
65