testcontainers / testcontainers/testcontainers-java

New docs: Convert inline example code to use codeinclude macro

Open
#1,158 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

help wanted resolution/acknowledged type/docs
Dominant language
Java
Stars
8.7k
Forks
1.9k
Avg merge
2d 17h
Merged PRs (30d)
9

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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with one unchecked page, such as docs/features/container_logs.md, and compare it with the completed conversions in docs/modules/elasticsearch.md or docs/test_framework_integration/spock.md. Replace suitable inline examples with the codeinclude macro, then run the documentation build to confirm the examples compile and are tested.

Written by the indexing model from the issue text.

Assessment

Tech stack
docker, java
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.