Skip to content

[Enhancement]: Add build status badges for multilingual documentation versions #474

@Adrija-verse

Description

@Adrija-verse

Type of Enhancement

Adding/improving 'Further Reading' resources

Relevant Page(s) URL (if applicable)

NIL

Current Content Snippet (Optional, but helpful)

The DISCOVER Cookbook now supports multiple versions (v1.0, v2.0+) and multiple languages (English, Spanish, etc.) through a sophisticated CI/CD pipeline. However, there is currently no visual indicator showing:

  • Whether the latest builds succeeded or failed
  • Which language versions are building successfully
  • The status of deployment previews

This creates several issues:

[ ] Maintainers cannot quickly identify build failures without checking Actions tab
[ ] Contributors don't know if their PR broke the build for specific language versions
[ ] Users have no confidence indicator for documentation stability

Proposed Enhancement / Suggestion

Add automated build status badges to the repository README and documentation site that display real-time deployment health for the multi-version, multi-lingual documentation pipeline.
Specific Changes:

Add GitHub Actions workflow status badge to README.md
Add Netlify deployment status badge
Optional: Create build matrix table showing per-version/per-language build status
Optional: Add "last successful build" timestamp to documentation footer

Rationale & Expected Impact

Problem Being Solved:
The DISCOVER Cookbook now has a sophisticated CI/CD pipeline (implemented during GSoC 2025) that handles:

Multiple documentation versions (v1.0, v2.0+)
Multiple languages (English, Spanish, extensible to more)
Automated deployments with concurrency control
Netlify preview deployments for PRs

However, there's currently no visual indicator of system health. Stakeholders must manually navigate to the Actions tab to verify build status, creating several pain points:

Maintainer friction: Manual checking required to verify deployments
Contributor uncertainty: No immediate feedback if their PR broke builds
User confidence: No trust signal that documentation is actively maintained
Debugging delays: Build failures not immediately visible

Why This Matters:

The infrastructure investment from GSoC 2025 is significant—badges make that investment visible
Professional open-source projects use status badges as quality signals
Reduces cognitive load on maintainers who must verify deployment status
Enables faster incident response when builds fail

Why Now:

Infrastructure is stable and mature
Low implementation cost with high visibility gain
No dependencies on other features
Can be implemented independently by a single contributor

Additional Resources / Further Reading

This idea is given by me. If the maintainers assign me to do this enhancement then i may proceed with PR for adding enhancement. Please let me know if i can proceed or not

Contribution

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions