-
-
Notifications
You must be signed in to change notification settings - Fork 515
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 a basic layout for wait strategies in docs #536
Conversation
Still in draft to validate the initial layout. Will add more commits documenting all the wait strategies, and once there, will mark it as ready for review |
Codecov Report
@@ Coverage Diff @@
## main #536 +/- ##
==========================================
- Coverage 68.85% 68.61% -0.24%
==========================================
Files 22 22
Lines 2148 2154 +6
==========================================
- Hits 1479 1478 -1
- Misses 530 537 +7
Partials 139 139
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Apply suggestions as you see fit. Topics that require a deeper discussion can be discussed outside of this PR.
Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>
Co-authored-by: Kevin Wittek <kiview@users.noreply.github.com>
* main: Add system requirements parent docs page for podman and colima (#562) Support for cap-add/cap-drop (#555) fix container NetworkMode usage (#560) chore: use hashed versions of test-summary action (#556) chore: use container.State() function in tests (#543) Log docker server info (#548) docs: add docs regarding Colima usage (#547) chore: add emoji to breaking changes in release drafter (#542) chore: add CONTRIBUTING file (#539) issue #537 Rename the wait/multi.go file to wait/all.go (#541) docs: add a basic layout for wait strategies in docs (#536) docs: improve consistency and fix typos (#534) chore: do not skip test (#528) chore: include test flakiness in the release drafter (#535) chore: retire old versions of Go (#530)
What does this PR do?
It creates a basic layout for the wait strategies in the docs
For that:
host_port.go
: it's possible now to set the poll internal, as in any other wait strategysql.go
: the WithTimeout function now calls aWithStartupTimeout
function, which is consistent with the rest of the wait strategiesRegarding the website, it's important to notice that the
golang
blocks are automatically pygmented by the existing libraries, so no need to add mkdocs plugins for that.Why is it important?
It serves as the baseline for adding new docs for the wait strategies (will come in follow-up commits)It documents the wait strategies, which was missing.
How to test this PR?
Start the local documentation site using the instructions in the docs/contributing_docs.md file
Related issues
Follow ups
Automate the local deployment of the docs, using Docker, instead of polluting the local system