apache / apache/texera

Sync in-repo docs/ folder with Hugo website docs

Open
#5,001 2 comments 0 reactions 1 assignee Claimed by @Ma77Ball View on GitHub
Dominant language
Scala
Stars
314
Forks
187
Avg merge
1d 21h
Merged PRs (30d)
214

Description

### Feature Summary

The Hugo website still builds from its own copy of the docs, separate from the `docs/` folder in this repo. Every doc change has to be made twice, and the two will drift. We need one source of truth.

### Proposed Solution or Design

Make the `docs/` folder in this repo the source the Hugo website builds from, pulled in by a scheduled job on the website side.

1. Reconcile content so that `docs/` matches the website, taking the newer version where they differ.
2. Add a cron job in the website repo that periodically pulls the latest `docs/` from this repo and commits/rebuilds the site.
3. Remove the duplicate docs from the website repo once the scheduled sync is working, so this repo stays the single source of truth.

### Affected Area

Other

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.