testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

Open

#1,158 opened on Jan 19, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Java (1,588 forks)batch import
help wantedresolution/acknowledgedtype/docs

Repository metrics

Stars
 (7,535 stars)
PR merge metrics
 (Avg merge 2d 17h) (2 merged PRs in 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

Contributor guide

Research direction
Study the mkdocs documentation for codeinclude macro, then pick one unchecked page and replace inline code blocks with codeinclude references to the appropriate source files.
Tech stack
java
Domain
documentation
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Gitmkdocs
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
65