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.

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

chore: bump version in mkdocs #630

Merged
merged 1 commit into from Nov 22, 2022

Conversation

mdelapenya
Copy link
Collaborator

What does this PR do?

It bumps the version in mkdocs to the latest_version

Why is it important?

TBH I'm not sure if this extra value is used by mkdocs to render the docs site. According to their docs: https://www.mkdocs.org/user-guide/configuration/#extra

A set of key-value pairs, where the values can be any valid YAML construct, that will be passed to the template. This allows for great flexibility when creating custom themes.

For example, if you are using a theme that supports displaying the project version, you can pass it to the theme like this:

extra:
    version: 1.0

But I cannot see any occurrence of the latest_version key.

@mdelapenya mdelapenya requested a review from a team as a code owner November 21, 2022 16:43
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Nov 21, 2022
@mdelapenya mdelapenya self-assigned this Nov 21, 2022
@mdelapenya mdelapenya requested a review from a team November 21, 2022 16:43
@kiview
Copy link
Member

kiview commented Nov 21, 2022

In the case of testcontainers-java, we use the latest_version variable to template a couple of strings in the documentation, what's why it makes sense there.

@mdelapenya
Copy link
Collaborator Author

In the case of testcontainers-java, we use the latest_version variable to template a couple of strings in the documentation, what's why it makes sense there.

Ok then, I'll keep it here in the case we need it for the future of the examples. Thanks for confirming!

@mdelapenya mdelapenya merged commit ebc3dec into testcontainers:main Nov 22, 2022
@mdelapenya mdelapenya deleted the update-versions branch November 22, 2022 16:04
mdelapenya referenced this pull request in mdelapenya/testcontainers-go Nov 23, 2022
* main:
  chore: bump version in mkdocs (#630)
  docs: remove code snippets from main README (testcontainers#631)
  docs: document replace directive for Docker Compose (testcontainers#632)
mdelapenya referenced this pull request in mdelapenya/testcontainers-go Nov 29, 2022
* main:
  Add toxiproxy example (testcontainers#643)
  Add spanner example (testcontainers#642)
  chore: sync governance files (testcontainers#641)
  Add pubsub example (testcontainers#640)
  chore: adjust generator for the docs site (testcontainers#639)
  Add datastore example (testcontainers#638)
  Add firestore example (testcontainers#637)
  fix: avoid panics when checking container state and container.raw is nil (testcontainers#635)
  feat: provide a tool to generate examples from code (#618)
  chore: bump version in mkdocs (#630)
  docs: remove code snippets from main README (testcontainers#631)
  docs: document replace directive for Docker Compose (testcontainers#632)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Docs, docs, docs.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants