forked from kubernetes-sigs/external-dns
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Revert "Revert "Workflow for automatic documentation creation and pub…
…lishing""
- Loading branch information
Showing
9 changed files
with
243 additions
and
40 deletions.
There are no files selected for viewing
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| name: Release Docs | ||
|
|
||
| on: | ||
| push: | ||
| tags: | ||
| - "v*" | ||
|
|
||
| jobs: | ||
| release_docs: | ||
| name: Release Docs | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v2 | ||
| with: | ||
| fetch-depth: 0 | ||
|
|
||
| - uses: actions/setup-python@v2 | ||
| with: | ||
| python-version: "3.10" | ||
| cache: "pip" | ||
| cache-dependency-path: "./docs/scripts/requirements.txt" | ||
|
|
||
| - uses: actions/setup-go@v2 | ||
| with: | ||
| go-version: ^1.17 | ||
|
|
||
| - 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" | ||
| git config --local user.name "github-actions[bot]" | ||
| - name: build and push | ||
| run: | | ||
| mike deploy ${{ github.ref_name }} latest --push --update-aliases | ||
| mike set-default --push latest |
This file contains 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
This file contains 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
File renamed without changes
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| #!/bin/bash | ||
|
|
||
| set -eo pipefail | ||
|
|
||
| cp CONTRIBUTING.md code-of-conduct.md ./docs/ | ||
|
|
||
| cp LICENSE ./docs/LICENSE.md | ||
|
|
||
| cp README.md ./docs/index.md |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| /* | ||
| Copyright 2017 The Kubernetes Authors. | ||
| Licensed under the Apache License, Version 2.0 (the "License"); | ||
| you may not use this file except in compliance with the License. | ||
| You may obtain a copy of the License at | ||
| http://www.apache.org/licenses/LICENSE-2.0 | ||
| Unless required by applicable law or agreed to in writing, software | ||
| distributed under the License is distributed on an "AS IS" BASIS, | ||
| WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. | ||
| See the License for the specific language governing permissions and | ||
| limitations under the License. | ||
| */ | ||
|
|
||
| package main | ||
|
|
||
| import ( | ||
| "log" | ||
| "os" | ||
| "strings" | ||
| ) | ||
|
|
||
| func removeLinkPrefixInIndex() { | ||
| content, err := os.ReadFile("./docs/index.md") | ||
| if err != nil { | ||
| log.Fatalf("Could not read index.md file. Make sure to run copy_docs.sh script first. Original error: %s", err) | ||
| } | ||
|
|
||
| updatedContent := strings.ReplaceAll(string(content), "](./docs/", "](") | ||
| updatedContent = strings.ReplaceAll(updatedContent, "](docs/", "](") | ||
|
|
||
| f, err := os.OpenFile("./docs/index.md", os.O_RDWR, 0644) | ||
| if err != nil { | ||
| log.Fatalf("Could not open index.md file to update content. Original error: %s", err) | ||
| } | ||
| defer f.Close() | ||
|
|
||
| if _, err := f.WriteString(updatedContent); err != nil { | ||
| log.Fatalf("Failed writing links update to index.md. Original error: %s", err) | ||
| } | ||
| } | ||
|
|
||
| func main() { | ||
| removeLinkPrefixInIndex() | ||
| } |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,3 @@ | ||
| <head> | ||
| <meta http-equiv="Refresh" content="0; url='/external-dns/{{.}}/'" /> | ||
| </head> |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| mkdocs-git-revision-date-localized-plugin == 1.0.0 | ||
| mkdocs == 1.3.0 | ||
| mkdocs-material == 8.2.8 | ||
| mkdocs-literate-nav == 0.4.0 | ||
| mike == 1.1.2 |
This file contains 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,86 @@ | ||
| site_name: external-dns | ||
| site_author: external-dns maintainers | ||
|
|
||
| repo_name: kubernetes-sigs/external-dns | ||
| repo_url: https://github.com/kubernetes-sigs/external-dns/ | ||
|
|
||
| nav: | ||
| - index.md | ||
| - Tutorials: tutorials/ | ||
| - Advanced Topics: | ||
| - Initial Design: initial-design.md | ||
| - TTL: ttl.md | ||
| - Contributing: | ||
| - Kubernetes Contributions: CONTRIBUTING.md | ||
| - Release: release.md | ||
| - contributing/* | ||
| - About: | ||
| - FAQ: faq.md | ||
| - Out of Incubator: 20190708-external-dns-incubator.md | ||
| - Code of Conduct: code-of-conduct.md | ||
| - License: LICENSE.md | ||
|
|
||
| theme: | ||
| name: material | ||
| features: | ||
| - content.code.annotate | ||
| - navigation.top | ||
| - navigation.tracking | ||
| - navigation.indexes | ||
| - navigation.instant | ||
| - navigation.tabs | ||
| - navigation.tabs.sticky | ||
|
|
||
| extra: | ||
| version: | ||
| provider: mike | ||
|
|
||
| markdown_extensions: | ||
| - meta | ||
| - tables | ||
| - toc: | ||
| permalink: true | ||
| - abbr | ||
| - extra | ||
| - admonition | ||
| - smarty | ||
| - sane_lists | ||
| - nl2br | ||
| - attr_list | ||
| - def_list | ||
| - footnotes | ||
| - md_in_html | ||
| - pymdownx.arithmatex: | ||
| generic: true | ||
| - pymdownx.betterem: | ||
| smart_enable: all | ||
| - pymdownx.caret | ||
| - pymdownx.details | ||
| - pymdownx.emoji: | ||
| emoji_index: !!python/name:materialx.emoji.twemoji | ||
| emoji_generator: !!python/name:materialx.emoji.to_svg | ||
| - pymdownx.highlight: | ||
| use_pygments: true | ||
| anchor_linenums: true | ||
| - pymdownx.inlinehilite | ||
| - pymdownx.keys | ||
| - pymdownx.mark | ||
| - pymdownx.smartsymbols | ||
| - pymdownx.snippets | ||
| - pymdownx.superfences: | ||
| custom_fences: | ||
| - name: mermaid | ||
| class: mermaid | ||
| format: !!python/name:pymdownx.superfences.fence_code_format | ||
| - pymdownx.tabbed: | ||
| alternate_style: true | ||
| - pymdownx.tilde | ||
| - pymdownx.tasklist: | ||
| custom_checkbox: true | ||
|
|
||
| plugins: | ||
| - search | ||
| - literate-nav | ||
| - git-revision-date-localized: | ||
| type: date | ||
| fallback_to_build_date: true |