traefik/mixtus repository overview

⁠Lasius Mixtus - Publish Documentation to a GitHub Repository From Another

⁠Description

Lasius Mixtus is a cross-ci tool (GitHub Actions, SemaphoreCI 1 and 2, TravisCI, ...) uses to aggregate documentation from different projects into one repository.

He is useful when you try to build an aggregated documentation from different sources.

He creates PRs instead of commits to avoid conflicts and be able to validate the whole documentation before the merge.

Lasius Mixtus

Flags:
  -debug
        Debug mode
  -dst-doc-path string
        Path to put the documentation. (default "./traefik")
  -dst-owner string
        Owner of the targeted doc repo. (default "traefik")
  -dst-repo-name string
        Name of the targeted doc repo. (default "doc")
  -git-user-email string
        Email used to commit the documentation. [GIT_USER_EMAIL]
  -git-user-name string
        UserName used to commit the documentation. [GIT_USER_NAME]
  -h    Show this help.
  -src-doc-path string
        Path to the documentation. (default "./docs/site")
  -src-owner string
        Owner of the source repository. (default "traefik")
  -src-repo-name string
        Name of the source repo. (default "traefik")
  -token string
        GitHub Token [GITHUB_TOKEN]

⁠Workflow Example

This workflow also uses:

• structor⁠: creates multiple versions of a Mkdocs documentation
• mixtus⁠: creates PRs with documentation changes
• lobicornis⁠: rebases and merges PRs automatically

The result is here: https://doc.traefik.io/⁠

⁠Examples

GITHUB_TOKEN=xxx ./mixtus \
--src-owner=containous \
--src-repo-name=traefik \
--src-doc-path="./docs/site/" \
--dst-repo-name=doc \
--dst-doc-path="./traefik" \
--git-user-name=botname \
[email protected]

⁠The Mymirca colony

• Myrmica Lobicornis⁠ 🐜: Update and merge pull requests.
• Myrmica Aloba⁠ 🐜: Add labels and milestone on pull requests and issues.
• Messor Structor⁠ 🐜: Manage multiple documentation versions with Mkdocs.
• Lasius Mixtus⁠ 🐜: Publish documentation to a GitHub repository from another.
• Myrmica Bibikoffi⁠ 🐜: Closes stale issues
• Chalepoxenus Kutteri⁠ 🐜: Track a GitHub repository and publish on Slack.
• Myrmica Gallienii⁠ 🐜: Keep Forks Synchronized

⁠What does Lasius Mixtus mean?