Documentation Coming Soon Tasks
This document lists the planned future documentation files that are currently referenced in the documentation as "coming soon". These should be created as part of the ongoing documentation improvement process.
Integration Section
File Path |
Description |
integration/platforms/jenkins.md |
Jenkins integration guide |
integration/platforms/azure-devops.md |
Azure DevOps integration guide |
integration/platforms/custom-platforms.md |
Custom platform integration guide |
Examples
File Path |
Description |
integration/examples/gitlab-services-examples.md |
GitLab Services examples |
integration/examples/custom-examples.md |
Custom integration examples |
Approaches Section
Debug Container Approach
File Path |
Description |
approaches/debug-container/future-work.md |
Future work for debug container approach |
approaches/debug-container/security.md |
Security considerations for debug container approach |
Sidecar Container Approach
File Path |
Description |
approaches/sidecar-container/future-work.md |
Future work for sidecar container approach |
approaches/sidecar-container/pod-configuration.md |
Pod configuration details for sidecar approach |
approaches/sidecar-container/retrieving-results.md |
Results retrieval for sidecar approach |
Kubernetes API Approach
File Path |
Description |
approaches/kubernetes-api/future-work.md |
Future work for Kubernetes API approach |
Implementation Notes
When implementing these documents:
- Follow the established structure: Use the same structure as existing documents in the respective sections
- Update inventory files: Update relevant inventory.md files when adding new documents
- Update navigation: Ensure new documents are added to the MkDocs navigation in mkdocs.yml
- Fix cross-references: Update any links pointing to the "coming soon" placeholders
- Follow the process documentation: Use the scripts described in
docs/project/warning-resolution-scripts.md
to validate and fix any new issues
Priority Order (Suggested)
- Approaches section documents - these are core functionality documents
- Integration platforms - these are important for CI/CD integrations
- Examples - these are useful reference materials but less critical
The above priority order is a suggestion based on the likely user journey through the documentation, focusing on core concepts first, then integration, and finally examples.