apache / apache/airflow

Add a precommit to detect when docs have been moved

Open
#49,565 6 comments 0 reactions 0 assignees View on GitHub
area:dev-env kind:meta
Dominant language
Python
Stars
46.9k
Forks
17.8k
Avg merge
2d 10h
Merged PRs (30d)
483

Description

### Body

This is useful when we move over / rename docs and miss adding those in redirects.txt leading to trouble later for external links.

Adding a precommit will catch hold of a good chunk of those.

### Committer

- [x] I acknowledge that I am a maintainer/committer of the Apache Airflow project.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting redirects.txt and the repository's pre-commit configuration. The check should identify moved or renamed documentation that lacks a corresponding redirect entry, and the work is done when the pre-commit catches those omissions.

Written by the indexing model from the issue text.

Assessment

Domain
documentation, tooling
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.