Skip to content

Commit

Permalink
mkdocs on root level
Browse files Browse the repository at this point in the history
  • Loading branch information
mloiseleur committed Jun 7, 2024
1 parent a69bb16 commit 233c46e
Show file tree
Hide file tree
Showing 6 changed files with 24 additions and 83 deletions.
5 changes: 0 additions & 5 deletions .github/workflows/docs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -32,11 +32,6 @@ jobs:
- run: |
pip install -r docs/scripts/requirements.txt
- name: setup
run: |
./docs/scripts/copy_docs.sh
go run ./docs/scripts/docs.go
- name: Configure Git user
run: |
git config --local user.email "github-actions[bot]@users.noreply.github.com"
Expand Down
File renamed without changes.
11 changes: 0 additions & 11 deletions docs/scripts/copy_docs.sh

This file was deleted.

48 changes: 0 additions & 48 deletions docs/scripts/docs.go

This file was deleted.

1 change: 1 addition & 0 deletions docs/scripts/requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -2,4 +2,5 @@ mkdocs-git-revision-date-localized-plugin == 1.2.4
mkdocs == 1.5.3
mkdocs-material == 9.5.17
mkdocs-literate-nav == 0.6.1
mkdocs-same-dir == 0.1.3
mike == 2.0.0
42 changes: 23 additions & 19 deletions mkdocs.yml
Original file line number Diff line number Diff line change
@@ -1,38 +1,41 @@
site_name: external-dns
site_author: external-dns maintainers

repo_name: kubernetes-sigs/external-dns
repo_url: https://github.com/kubernetes-sigs/external-dns/

trademark: https://www.linuxfoundation.org/legal/trademark-usage

docs_dir: .

nav:
- index.md
- README.md
- Chart:
- About: charts/external-dns/README.md
- Changelog: charts/external-dns/CHANGELOG.md
- About:
- FAQ: faq.md
- Out of Incubator: 20190708-external-dns-incubator.md
- FAQ: docs/faq.md
- Out of Incubator: docs/20190708-external-dns-incubator.md
- Code of Conduct: code-of-conduct.md
- License: LICENSE.md
- Tutorials: tutorials/
- Tutorials: docs/tutorials/*
- Annotations:
- About: annotations/annotations.md
- About: docs/annotations/annotations.md
- Sources:
- About: sources/sources.md
- Gateway: sources/gateway.md
- Ingress: sources/ingress.md
- Service: sources/service.md
- About: docs/sources/sources.md
- Gateway: docs/sources/gateway.md
- Ingress: docs/sources/ingress.md
- Service: docs/sources/service.md
- Registries:
- About: registry/registry.md
- TXT: registry/txt.md
- DynamoDB: registry/dynamodb.md
- About: docs/registry/registry.md
- TXT: docs/registry/txt.md
- DynamoDB: docs/registry/dynamodb.md
- Advanced Topics:
- Initial Design: initial-design.md
- TTL: ttl.md
- MultiTarget: proposal/multi-target.md
- Initial Design: docs/initial-design.md
- TTL: docs/ttl.md
- MultiTarget: docs/proposal/multi-target.md
- Contributing:
- Kubernetes Contributions: CONTRIBUTING.md
- Release: release.md
- contributing/*
- Release: docs/release.md
- docs/contributing/*

theme:
name: material
Expand Down Expand Up @@ -94,6 +97,7 @@ markdown_extensions:
custom_checkbox: true

plugins:
- same-dir
- search
- literate-nav
- git-revision-date-localized:
Expand Down

0 comments on commit 233c46e

Please # to comment.