opensearch-project / opensearch-project/.github

[Question] Are we allowed to use third-party documentation platforms like Mintlify?

Open
#484 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

github-request
Dominant language
No language data
Stars
41
Forks
74
Avg merge
3d 19h
Merged PRs (30d)
1

Description

Summary

We are exploring options to improve the documentation for observability.opensearch.org. One option is Mintlify, which has an OSS Program offering their Pro plan for free to open source projects. From initial communications, they are willing to accept OpenSearch into the program. Before proceeding, we need to understand: are we allowed to use third-party hosted documentation platforms for OpenSearch projects?

How Mintlify Works (Important Context)

Mintlify is not a build tool or static site generator. It is a hosted commercial platform that owns the deployment pipeline:

  1. You write Markdown/MDX docs in a GitHub repo with a mint.json config
  2. You connect the repo to your Mintlify account (via their dashboard, not GitHub CI)
  3. Mintlify pulls changes from the repo, builds, and hosts the site on their infrastructure
  4. Your custom domain (e.g., observability.opensearch.org) points via DNS CNAME to Mintlify's servers (see Mintlify Custom Domain docs)
GitHub repo (docs source) → Mintlify account pulls & builds → Hosted on Mintlify servers
                                                                        ↓
                                                        observability.opensearch.org
                                                        (DNS CNAME → Mintlify infrastructure)

Key point: There is no GitHub Actions / CI involved in deployment. The build and hosting are entirely controlled by Mintlify through their account/dashboard. This means:

  • Mintlify controls the hosting — if access is revoked or terms change, the site goes down
  • The Mintlify account owner controls deployment, not the GitHub repo
  • This is a dependency on a third-party commercial service for project infrastructure
Current Status
  • From initial communications, Mintlify is willing to accept OpenSearch into their OSS Program (free Pro plan).
  • No account has been created and no action has been taken — waiting for guidance before proceeding.
Questions
  1. Are we allowed to use hosted commercial platforms (like Mintlify) for OpenSearch project documentation, even if offered free under an OSS program?
  2. What is the approval process if we want to use such a service? Does LF need to review terms, own the account, etc.?
  3. Should we stick to open source self-hosted alternatives? Options that deploy via GitHub CI to GitHub Pages (no third-party hosting dependency):
  4. Is there precedent? Other LF projects use Mintlify (e.g., Agent Communication Protocol). How did they get approval?
Concerns
  • No GitHub CI control: Deployment is through Mintlify's platform, not our CI/CD. We lose control over the build and deploy pipeline.
  • Hosting dependency: If Mintlify changes terms or revokes access, the site goes down (similar to past issues with HuggingFace OSS program).
  • Account ownership: If approved, the account must be LF-controlled, not individual.
  • Portability: The docs source (Markdown) is portable, but the mint.json config and Mintlify-specific components are not.
References

/cc @peternied

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the issue's questions, Mintlify OSS Program and custom-domain references, and the listed Read the Docs, Docusaurus, and MkDocs Material alternatives. The work is done when the approval requirements, account ownership, hosting decision, and precedent for OpenSearch documentation are documented by the responsible project or LF contacts.

Written by the indexing model from the issue text.

Assessment

Tech stack
markdown
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Quiet
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.