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

docs: add scaffolding for testcontainers docs system #624

Merged
merged 3 commits into from
May 20, 2024

Conversation

mdelapenya
Copy link
Member

@mdelapenya mdelapenya commented May 4, 2024

What does this PR do?

It adds the base Mkdocs project for the testcontainers docs system.

It uses tc-go as reference, removing all the go-specific content but the general one.

Why is it important?

Homogeneous and consistent docs system across testcontainers projects.

How to test this PR

As described in the docs/contributing_docs.md file in this PR:

  • Ensure that you have Python 3.8.0 or higher.
  • Create a Python virtualenv. E.g. python3 -m venv tc-venv.
  • Activate the virtualenv. E.g. source tc-venv/bin/activate.
  • Run pip3 install -r requirements.txt && ./tc-venv/bin/mkdocs serve from the testcontainers-rs root directory. It will start a local auto-updating MkDocs server.

Follow-ups

  • Add features
  • Add modules
  • Create rust.testcontainers.org domain
  • Enable netlify deployments and previews in PRs

@mdelapenya mdelapenya marked this pull request as ready for review May 7, 2024 07:46
@mdelapenya
Copy link
Member Author

As a follow-up I'd like to to simplify the experience, as in testcontainers/testcontainers-go#2545

@DDtKey DDtKey merged commit cddf066 into testcontainers:main May 20, 2024
8 checks passed
@DDtKey
Copy link
Collaborator

DDtKey commented May 20, 2024

Thank you 🙏

@mdelapenya mdelapenya self-assigned this May 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants