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

[TT-1717] add docs for lib #1503

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Conversation

Tofel
Copy link
Contributor

@Tofel Tofel commented Dec 18, 2024

  • added docs for:
    ** Docker
    ** Clients
    ** Grafana
    ** Logging

Renamed Lib (deprecated) to CTFv1 (Discouraged).


Below is a summarization created by an LLM (gpt-4-0125-preview). Be mindful of hallucinations and verify accuracy.

Why

The changes ensure the documentation and configurations for building and testing blockchain networks are updated, corrected, and expanded. These updates include clarifications in the Ethereum network configuration validation, expansion of the supported blockchain and Chainlink ecosystem docker containers, and introduction of new client support documentation. These adjustments are made to offer clearer guidance, correct a validation error, and broaden the utility and integration capabilities of the testing framework, enhancing its usefulness for developers working on blockchain and Chainlink projects.

What

  • book/src/SUMMARY.md
    • Fixed formatting and added new sections for enhanced clarity and additional resources.
    • Introduced documentation for new client support and clarified existing sections.
  • book/src/k8s-test-runner/k8s-test-runner.md
    • Updated command for creating a Docker image to include --image-name for specificity.
  • book/src/lib/client.md and related client files
    • Added a new documentation section and detailed files for various clients (Anvil, AWS Secrets Manager, Github, Grafana, Kafka, Loki, MockServer, Postgres, Prometheus) to guide in their setup and usage.
  • book/src/lib/concurrency.md
    • Introduced documentation for a library that aids in parallelizing tasks with specific payloads and configurations.
  • book/src/lib/docker/blockchain_nodes.md
    • Added comprehensive documentation for setting up blockchain nodes with Docker, including Ethereum 1.0 and 2.0 configurations, custom Docker image usage, and advanced networking options.
  • book/src/lib/docker/chainlink_ecosystem.md
    • Provided details on setting up the Chainlink Job Distributor within the ecosystem.
  • book/src/lib/docker/overview.md, test_helpers.md
    • Outlined the Docker package's scope within the testing framework, including supported Chainlink-related containers and test helper containers.
  • book/src/lib/logging.md
    • Explained the logging library's purpose, configuration, and usage within the testing framework.
  • lib/config/private_ethereum_network.go
    • Corrected a validation message for slots per epoch to accurately reflect the minimum required value, ensuring clearer error feedback during configuration validation.

@Tofel Tofel marked this pull request as ready for review December 18, 2024 16:19
@Tofel Tofel requested review from sebawo and a team as code owners December 18, 2024 16:19
* Killgrave
* Mockserver

Both represent HTTP mocking solutions, with Mockserver used in k8s and Killgrave outside of it. Since both will soon
Copy link

Choose a reason for hiding this comment

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

If there is a ticket, PR etc - that will help here

@cl-sonarqube-production
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants