docs(docs): align config/cli/metrics docs and add drift+sync automation#424
Open
docs(docs): align config/cli/metrics docs and add drift+sync automation#424
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
mekilis
changed the title
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
mekilis
force-pushed
the
smart/docs-config-env-sync
branch
from
c01f5a8 to
4dba8e3
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Aligns public docs with Convoy server behavior for
convoy.json, environment variables, CLI, and metrics (including cross-links and consistency between configuration and metrics pages).PR checklist & contributor guidance
.github/DOCUMENTATION_SYNC.mdand updates the PR template so authors confirm config/env/CLI/metrics/Grafana updates (or mark N/A with a short reason).Drift workflow (
docs-drift.yml)docs/**, drift scripts, or related.githubpaths..github/scripts/docs-drift-check.sh: forbidden patterns underdocs/and structural consistency checks (e.g. precedence wording, shared env names across pages).Receive workflow (
convoy-docs-sync-receive.yml)repository_dispatch(convoy_docs_sync) or manualworkflow_dispatchwith optional Convoy ref.docs/generated/convoy/, and opens/updates a sync PR viacreate-pull-request.