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

Add global testcontainers header to docs #1308

Merged

Conversation

leocross
Copy link
Contributor

What does this PR do?

Adds a global navigation to the documentation that mirrors the navigation on https://testcontainers.com

Why is it important?

Testcontainers is a cross-language project and many resources like the getting started article, guides and the modules library that are not specific to a language implementation are hosted one testcontainers.com. Adding a global header with consistent navigation between the project site and the language documentation will help new and existing users discover these resources.

@leocross leocross requested a review from a team as a code owner June 30, 2023 13:49
@netlify
Copy link

netlify bot commented Jun 30, 2023

Deploy Preview for testcontainers-go ready!

Name Link
🔨 Latest commit 2f9ea0c
🔍 Latest deploy log https://app.netlify.com/sites/testcontainers-go/deploys/64d36b9ab7dcfc00082fcc14
😎 Deploy Preview https://deploy-preview-1308--testcontainers-go.netlify.app/
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@sonarcloud
Copy link

sonarcloud bot commented Jun 30, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

eddumelendez
eddumelendez previously approved these changes Jun 30, 2023
Copy link
Member

@eddumelendez eddumelendez left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks so cool!

cristianrgreco
cristianrgreco previously approved these changes Jul 3, 2023
@mdelapenya mdelapenya self-assigned this Aug 4, 2023
@mdelapenya mdelapenya added the documentation Docs, docs, docs. label Aug 4, 2023
docs/css/extra.css Outdated Show resolved Hide resolved
docs/css/extra.css Outdated Show resolved Hide resolved
Copy link
Collaborator

@mdelapenya mdelapenya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM although I saw a CSS class being removed but still used across all the module pages. I think once that's restored, we can merge.

Thanks!

leocross and others added 4 commits August 8, 2023 15:15
Co-authored-by: Manuel de la Peña <social.mdelapenya@gmail.com>
docs/index.md Outdated Show resolved Hide resolved
mdelapenya
mdelapenya previously approved these changes Aug 8, 2023
Copy link
Collaborator

@mdelapenya mdelapenya left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Thanks!!

@leocross let's talk about improving the CSS for the tc-version block 🙏

@sonarcloud
Copy link

sonarcloud bot commented Aug 9, 2023

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot A 0 Security Hotspots
Code Smell A 0 Code Smells

No Coverage information No Coverage information
0.0% 0.0% Duplication

@mdelapenya mdelapenya merged commit 13d6344 into testcontainers:main Aug 9, 2023
8 checks passed
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Aug 9, 2023
* main:
  chore(deps): bump github.com/tidwall/gjson from 1.14.4 to 1.15.0 in /modules/vault (testcontainers#1428)
  chore: add a GH action for release drafter (testcontainers#1470)
  chore(deps): bump mkdocs-material from 3.2.0 to 8.2.7 (testcontainers#1468)
  Add global testcontainers header to docs (testcontainers#1308)
mdelapenya added a commit to mdelapenya/testcontainers-go that referenced this pull request Aug 10, 2023
* main: (29 commits)
  Add support for MongoDB testing module (testcontainers#1447)
  Support groups in dependabot updates (testcontainers#1459)
  chore: run modulegen tests on Windows (testcontainers#1478)
  Add default labels when Ryuk is disabled (testcontainers#1339)
  feat: add clickhouse module (testcontainers#1372)
  chore: increase timeout for go test and GH action steps (testcontainers#1475)
  chore: triple max timeout for the workflow run, which takes +10m (testcontainers#1474)
  chore(deps): bump github.com/aws dependencies in /modules/localstack (testcontainers#1472)
  chore(deps): bump Google emulators dependencies in /examples (testcontainers#1471)
  all: fix goroutine leaks (testcontainers#1358)
  chore(deps): bump github.com/neo4j/neo4j-go-driver/v5 in /modules/neo4j (testcontainers#1427)
  chore(deps): bump github.com/tidwall/gjson from 1.14.4 to 1.15.0 in /modules/vault (testcontainers#1428)
  chore: add a GH action for release drafter (testcontainers#1470)
  chore(deps): bump mkdocs-material from 3.2.0 to 8.2.7 (testcontainers#1468)
  Add global testcontainers header to docs (testcontainers#1308)
  Simplify dependabot updates sorting (testcontainers#1460)
  feat: use credential helper in docker config, even if auth is empty in .docker/config.json (testcontainers#1079)
  chore(deps): bump github.com/aws/aws-sdk-go-v2/service/s3 (testcontainers#1457)
  Revert "chore: run Windows tests on a Linux container (testcontainers#1456)"
  chore: run Windows tests on a Linux container (testcontainers#1456)
  ...
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

4 participants