Consolidate GitLab AI Developer/Contributor Documentation
Everyone can contribute. Help move this issue forward while earning points, leveling up and collecting rewards.
Background
We currently have AI-related documentation spread across multiple locations, making it difficult for developers and users to find relevant information. This initiative aims to consolidate all AI documentation into a single, organized location.
This effort would encapsulate Prompt Engineering Upleveling for GitLab Engine... (#512472) • Unassigned and be a direct evolution of Gather resources and make a pathway to uplevel ... (gitlab-org/ai-powered/discussions#18 - closed) • Gosia Ksionek, Stephan Rayner • 17.4.
Current Documentation Locations
- https://docs.gitlab.com/ee/development/ai_features/ai_feature_development_playbook.html
- https://docs.gitlab.com/ee/development/ai_features/index.html
- https://gitlab.com/gitlab-org/modelops/ai-model-validation-and-research/ai-evaluation/evaluation-runner/-/tree/main/docs?ref_type=heads
- https://gitlab.com/gitlab-org/modelops/ai-model-validation-and-research/ai-evaluation/prompt-library/-/tree/main/doc?ref_type=heads
- https://gitlab.com/gitlab-org/modelops/ai-model-validation-and-research/ai-evaluation/prompt-library/-/tree/main/doc/eli5?ref_type=heads
- https://gitlab.com/gitlab-org/modelops/ai-model-validation-and-research/ai-evaluation/datasets/-/tree/main/doc?ref_type=heads
- https://docs.gitlab.com/ee/development/code_suggestions/#setup-instructions-to-use-gdk-with-the-code-suggestions-add-on
- https://docs.gitlab.com/ee/development/ai_features/#recommended-set-cloud_connector_self_sign_tokens-environment-variable
- https://gitlab.com/gitlab-com/ops-sub-department/aws-gitlab-ai-integration/integration-motion-planning/-/wikis/integration-docs
- https://internal.gitlab.com/handbook/product/ai-strategy/duo-logging/
- https://gitlab.com/gitlab-org/gitlab/-/issues/437854#how-to-rotate-vertex-ai-service-account-key
- https://gitlab-cloud-connector-nmilojevic1-fbdb8f6670974fcd8dd62f3fe91b.gitlab.io/
- https://duo-feature-list-754252.gitlab.io/
Proposed Solution
Consolidate all AI documentation under https://docs.gitlab.com/ee/development/ai_features/
with clear organization by topic:
- Evaluations
- Self-hosted setup
- Feature documentation
- Licensing requirements
- Integration guides
Goals
- Create a single source of truth for AI-related documentation
- Improve documentation findability
- Reduce duplicate content
- Establish clear documentation structure
- Simplify maintenance
Implementation Details
- Timeline: Q2?
- Primary location:
/development/ai_features/
- Organized by concerns (evals, self-hosted, features, licenses, etc.)
Next Steps
- Review current documentation structure
- Create detailed content migration plan
- Identify and remove duplicate content
- Establish new documentation hierarchy
- Begin content migration
- Review and validate new structure
Notes
- No immediate deadline
- New technical writer will be joining to support AI teams
- Coordination needed with writing team for implementation
Edited by 🤖 GitLab Bot 🤖