docs: have common options in a common markdown file #1648
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It will be included using a mkdocs plugin
✅ Deploy Preview for testcontainers-go ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
Merging, as this PR does not impact the core or the modules, just the docs |
mdelapenya
added a commit
to mdelapenya/testcontainers-go
that referenced
this pull request
Sep 20, 2023
* main: docs: have common options in a common markdown file (testcontainers#1648) feat: add functional option for startup commands (testcontainers#1647) fix: support running the semver Docker image interactively (testcontainers#1646) fix: proper next version chore: prepare for next minor development cycle () chore: use new version (v0.24.1) in modules and examples fix: avoid deadlocks when Docker is not available (testcontainers#1645)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
What does this PR do?
This PR adds support for including markdown files into others, leveraging the
mkdocs-include-markdown-pluginplugin: https://github.com/mondeja/mkdocs-include-markdown-pluginWe will define a shared markdown file for all the available and common functional options, and will include that file into all existing modules and template.
Why is it important?
When a new functional option appears, then just adding it to the file will work without having to add it to all the existing modules.