Quick start guides¶
Role-specific guides to help you get productive with VDC quickly. Choose the path that best matches your responsibilities and goals.
Choose Your Role¶
- Validation Engineers - Find and use ingredients for validation activities
- Developers - Create and manage ingredient releases
- DevOps Teams - Automate with workflows and CLI integration
- Team Leads - Plan and organize team projects
Validation Engineers¶
Goal: Find and use existing ingredients for validation activities, testing, and platform integration.
Prerequisites¶
- VDC-USERS AGS group membership
- Access to VDC Portal
- Project User access (if you plan to run workflows)
Quick Start Steps¶
Step 1: Learn to Find Ingredients¶
- Visit VDC Portal
- Try ingredient search: Click "VDC Ingredients" in top navigation
- Search for common components: Try "BIOS", "IFWI", or "unified-patch"
- Explore results: Click ingredient names to see details and releases
- Understand dependencies: Check what each ingredient depends on
Step 2: Master Download Process¶
- Find a release you need through ingredient search, or using the release search by ID at the top navigation
- Navigate to Ingredient View by clicking the ingredient name
- Browse releases table to find the version you want
- Download packages using the download icon
- Check release details by clicking on release rows
Step 3: Set Up Basic CLI (Optional)¶
- Install VDC CLI: Follow CLI installation guide
- Set up authentication: Request token and store as environment variable
- Explore CLI commands
Key Resources¶
- Global search - Finding ingredients and releases
- Ingredient view - Understanding ingredient details
- CLI ingredient commands - Automation basics
Pro Tips¶
- Use dependency trees to understand component relationships
- Check Used-By tabs to see what might be affected by changes
- Bookmark frequently used ingredients for quick access
- Set up CLI for batch downloads if you work with many components
Developers¶
Goal: Create and manage your own ingredients, submit releases with proper versioning and dependency tracking.
Prerequisites¶
- VDC-USERS AGS group membership
- Access to VDC Portal
- Project User access to relevant project (contact project admin)
- Understanding of your ingredient's dependencies and validation requirements
Quick Start Steps¶
Step 1: Create Your First Ingredient¶
- Navigate to your project's feed in VDC Portal
- Follow Creating a new Ingredient instruction
Step 2: Submit Your First Release¶
- Follow submission instruction
Step 3: Set Up CLI for automation¶
- Install and authenticate: Follow CLI getting started
- Practice Release commands
- Integrate with builds: Add CLI commands to your build scripts
Key Resources¶
- What is an Ingredient - Core concepts
- Ingredient view - Get familiar with Ingredient view
- Creating a new Ingredient - Detailed creation process
- Ingredient submission - Release process
- CLI Release commands- Automation for releases
Pro Tips¶
- Plan your versioning strategy before creating ingredients
- Use meaningful descriptions in releases for better traceability
- Set up dependencies carefully to enable impact analysis
- Automate submissions through CI/CD pipelines for consistency
DevOps Teams¶
Goal: Automate ingredient management, set up workflows, and integrate VDC into CI/CD pipelines.
Prerequisites¶
- VDC-USERS AGS group membership
- Project Admin access (for workflow creation) or Project User access (for workflow execution)
- Experience with CI/CD tools and automation scripting
Quick Start Steps¶
Step 1: Master VDC CLI¶
- Install CLI on automation systems: Use CLI installation guide
- Set up secure authentication: Generate tokens and store in CI/CD secrets
- Practice essential commands: Ingredient commands , Release commands
Step 2: Create Your First Workflow (if Project Admin)¶
- Plan workflow structure: Identify build stages, dependencies, and triggers
- Create workflow through VDC web interface
- Configure build steps: Define ingredients to build and their baselines
- Set up triggers: Ingredient triggers for automatic execution
- Test execution: Run workflow manually first, then with triggers
Step 3: Integrate with CI/CD¶
- Choose integration pattern:
- Submit releases: Build artifacts and submit to VDC
- Download dependencies: Get components for builds
- Monitor workflows: Track VDC workflow execution
- Implement in pipeline: Add VDC CLI commands to your existing pipelines
- Handle errors: Add proper error handling and retry logic
Key Resources¶
- CLI overview - Complete CLI capabilities
- CLI authentication - Secure automation setup
- Workflow Requirements- Understanding VDC workflows
Team Leads¶
Goal: Plan VDC adoption, understand capabilities, organize team access, and drive successful implementation.
Prerequisites¶
- VDC-USERS AGS group membership
- Understanding of team's validation processes and pain points
Quick Start Steps¶
Step 1: Understand VDC Capabilities¶
- Read platform overview: Review VDC getting started to understand full capabilities
- Explore existing projects: Browse other teams' ingredients and workflows for inspiration
- Assess current processes: Identify where VDC could add value to your team's work
- Plan adoption strategy: Determine phased approach for team onboarding
Step 2: Plan Project Structure¶
- Decide on project needs:
- Single project for entire team vs. multiple focused projects
- Feed organization strategy (by product, by validation type, etc.)
- User access levels and role assignments
- Create project: Follow creating your first project guide
- Set up AGS groups: Plan admin hierarchy and user management
Step 3: Drive Team Adoption¶
- Identify champions: Find team members excited about VDC adoption
- Start with high-value use cases: Focus on areas with immediate benefits
- Provide training: Help team members learn VDC concepts and tools
- Establish processes: Create team guidelines for VDC usage
Key Resources¶
- VDC getting started - Platform capabilities and architecture
- User roles and permissions - Access control planning
- Creating your first project - Project setup process
Pro Tips¶
- Start small and iterate - begin with core use cases and expand
- Get buy-in early - involve team in planning and decision making
- Measure success - track metrics like time saved, error reduction, etc.
- Connect with other teams - learn from successful VDC implementations
- Be patient - adoption takes time and requires cultural change
Common next steps¶
After Quick Start Success¶
- Explore advanced features relevant to your role
- **Join VDC community** discussions and best practice sharing
- Provide feedback to help improve the platform
- Mentor others in your organization who are adopting VDC
Getting Help¶
- Technical Issues: Contact VDC support team
- Access Problems: Review user roles and persmission
- Process Questions: Consult VDC glossary or detailed documentation
- Training Needs: Consider team training sessions or workshops