Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

New docs: Convert inline example code to use codeinclude macro #1158

Open
2 of 14 tasks
rnorth opened this issue Jan 19, 2019 · 2 comments
Open
2 of 14 tasks

New docs: Convert inline example code to use codeinclude macro #1158

rnorth opened this issue Jan 19, 2019 · 2 comments
Labels
help wanted resolution/acknowledged type/docs

Comments

@rnorth
Copy link
Member

rnorth commented Jan 19, 2019 •
edited by kiview
Loading

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
@stale
Copy link

stale bot commented Apr 19, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. If you believe this is a mistake, please reply to this comment to keep it open. If there isn't one already, a PR to fix or at least reproduce the problem in a test case will always help us get back on track to tackle this.

@stale stale bot added the stale label Apr 19, 2019
raynigon referenced this issue in raynigon/testcontainers-java Jun 2, 2020
@raynigon
Use codeinclude #1158
28d910b 
use codeinclude for the elasticsearch module documentation
@raynigon raynigon mentioned this issue Jun 2, 2020
Merged
raynigon referenced this issue in raynigon/testcontainers-java Jun 2, 2020
@raynigon
Use codeinclude #1158
e12fe56 
use codeinclude for the elasticsearch module documentation
raynigon referenced this issue in raynigon/testcontainers-java Jun 3, 2020
@raynigon
merge documentation to container tests #1158
27a7130 
modify container tests to reflect the code previously embedded in the documentation
raynigon referenced this issue in raynigon/testcontainers-java Jun 23, 2020
@raynigon
Convert Docs for Kafka Module #1158
382f60b 
Convert inline example code to use codeinclude macro for the kafka module documentation.
@raynigon raynigon mentioned this issue Jun 23, 2020
Merged
raynigon referenced this issue in raynigon/testcontainers-java Jun 23, 2020
@raynigon
Convert Docs for Webdriver Containers
6a1edde 
Convert inline example code to use codeinclude macro for the Webdriver Containers documentation.
See #1158 for more details.
@raynigon raynigon mentioned this issue Jun 23, 2020
Merged
raynigon referenced this issue in raynigon/testcontainers-java Jun 23, 2020
@raynigon
Convert Docs for Webdriver Containers
bf5bcbc 
Convert inline example code to use codeinclude macro for the Webdriver Containers documentation.
See #1158 for more details.

Fixed ChromeRecordingWebDriverContainerTest which was crashed by previous commit.
raynigon referenced this issue in raynigon/testcontainers-java Jun 23, 2020
@raynigon
Convert Docs for Webdriver Containers
0842999 
Convert inline example code to use codeinclude macro for the Webdriver Containers documentation.
See #1158 for more details.

Fixed ChromeRecordingWebDriverContainerTest which was crashed by previous commit.
Fix Labels for RECORD_ALL, RECORD_FAILING enum values.
raynigon referenced this issue in raynigon/testcontainers-java Jun 23, 2020
@raynigon
Convert Docs for the Spock Testframework
e0ac6e1 
Convert inline example code to use codeinclude macro for the Spock Testframework documentation.
See #1158 for more details.
@raynigon raynigon mentioned this issue Jun 23, 2020
Merged
@raynigon
Copy link
Contributor

raynigon commented Jun 23, 2020 •
edited
Loading

Current State:

  • docs/modules/elasticsearch.md
  • docs/modules/kafka.md
  • docs/modules/webdriver_containers.md
  • docs/test_framework_integration/spock.md
  • docs/test_framework_integration/junit_5.md
  • docs/test_framework_integration/junit_4.md
  • 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/vault.md
  • docs/supported_docker_environment/logging_config.md

kiview pushed a commit that referenced this issue Jun 23, 2020
@raynigon
Convert Docs for the Spock Testframework (#2928)
3f64d0c 
Convert inline example code to use codeinclude macro for the Spock Testframework documentation
See #1158 for more details.
rnorth pushed a commit that referenced this issue Jun 29, 2020
@raynigon
Convert Docs for Kafka Module #1158 (#2925)
d03768b
raynigon referenced this issue in raynigon/testcontainers-java Jul 6, 2020
@raynigon
Fix #1158 for junit5
f4fe9e6 
Implement the codeinclude plugin for the junit5 docs
@raynigon raynigon mentioned this issue Jul 6, 2020
Merged
raynigon referenced this issue in raynigon/testcontainers-java Jul 27, 2020
@raynigon
Add codeinclude to commands #1158
871d2ad
@raynigon raynigon mentioned this issue Jul 27, 2020
Closed
raynigon referenced this issue in raynigon/testcontainers-java Jul 27, 2020
@raynigon
Add codeinclude to creating_container.md #1158
17112af
raynigon referenced this issue in raynigon/testcontainers-java Jul 27, 2020
@raynigon
Add codeinclude to creating_images.md #1158
71e9c62
raynigon referenced this issue in raynigon/testcontainers-java Jul 27, 2020
@raynigon
Add codeinclude to creating_images.md #1158
1d70f8e
@RamazanYapparov RamazanYapparov mentioned this issue Jan 13, 2021
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
help wanted resolution/acknowledged type/docs
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@rnorth @bsideup @raynigon