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

chore: adjust generator for the docs site #639

Merged
merged 8 commits into from
Nov 24, 2022
Merged

chore: adjust generator for the docs site #639

merged 8 commits into from
Nov 24, 2022

Conversation

mdelapenya
Copy link
Member

@mdelapenya mdelapenya commented Nov 24, 2022 •
edited
Loading

What does this PR do?

This PR is doing a few things to modify how the docs site is generated:

  • it uses the current latest version of Testcontainer for Go, taken from the mkdocs.yml file (see extra.latest_version field)
  • updates the instructions on how to run the generator, as it included an old version
  • fixes the generator to make sure the index.md file is the first element in the examples nav bar. The rest of examples will be alphabetically sorted
  • makes a restriction on examples name: only alphabetical chars are allowed

Why is it important?

Improve the experience of generating examples for the latest release

How to test this PR

Run the tests :)

@mdelapenya mdelapenya requested a review from a team as a code owner November 24, 2022 15:40
@mdelapenya mdelapenya added the chore Changes that do not impact the existing functionality label Nov 24, 2022
@mdelapenya mdelapenya self-assigned this Nov 24, 2022
@mdelapenya mdelapenya requested a review from a team November 24, 2022 15:40
mdelapenya
mdelapenya commented Nov 24, 2022
View reviewed changes
examples/main.go Outdated Show resolved Hide resolved
@mdelapenya mdelapenya merged commit 57e54b3 into testcontainers:main Nov 24, 2022
@mdelapenya mdelapenya deleted the fix-latest-version-in-template branch November 25, 2022 12:52
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Nov 29, 2022
@mdelapenya
Merge branch 'main' into pre-creation-hook
35849bb 
* 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 (#637)
  fix: avoid panics when checking container state and container.raw is nil (#635)
  feat: provide a tool to generate examples from code (#618)
  chore: bump version in mkdocs (#630)
  docs: remove code snippets from main README (#631)
  docs: document replace directive for Docker Compose (#632)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@eddumelendez eddumelendez eddumelendez approved these changes

Assignees

@mdelapenya mdelapenya

Labels
chore Changes that do not impact the existing functionality
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@mdelapenya @eddumelendez