Skip to content

Commit

Permalink
Merge pull request #145 from travier/docs
Browse files Browse the repository at this point in the history
Add 'docs' configuration for projects websites
  • Loading branch information
travier authored Jun 21, 2023
2 parents 29646d2 + c0c8fe5 commit 0935854
Show file tree
Hide file tree
Showing 5 changed files with 110 additions and 0 deletions.
19 changes: 19 additions & 0 deletions config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ repos:
fedora_package: rust-afterburn
rhel8_package: rust-afterburn
rhel9_package: rust-afterburn
pretty_name: Afterburn

bootupd:
url: https://github.com/coreos/bootupd
Expand All @@ -48,6 +49,7 @@ repos:
fedora_package: butane
rhel8_package: butane
rhel9_package: butane
pretty_name: Butane

cap-std-ext:
url: https://github.com/coreos/cap-std-ext
Expand All @@ -60,6 +62,12 @@ repos:
vars:
git_repo: console-login-helper-messages

coreos-assembler:
url: https://github.com/coreos/coreos-assembler
vars:
git_repo: coreos-assembler
pretty_name: CoreOS Assembler

coreos-installer:
url: https://github.com/coreos/coreos-installer
vars:
Expand All @@ -70,6 +78,7 @@ repos:
fedora_package: rust-coreos-installer
rhel8_package: coreos-installer
rhel9_package: rust-coreos-installer
pretty_name: CoreOS Installer

coreos-installer-dracut:
url: https://github.com/coreos/coreos-installer-dracut
Expand Down Expand Up @@ -138,6 +147,7 @@ repos:
fedora_package: ignition
rhel8_package: ignition
rhel9_package: ignition
pretty_name: Ignition

ignition-config-rs:
url: https://github.com/coreos/ignition-config-rs
Expand Down Expand Up @@ -186,6 +196,12 @@ repos:
container_arches: [amd64]
containers: [quay.io/coreos/rhcosbot]

rpm-ostree:
url: https://github.com/coreos/rpm-ostree
vars:
git_repo: rpm-ostree
pretty_name: rpm-ostree

ssh-key-dir:
url: https://github.com/coreos/ssh-key-dir
vars:
Expand Down Expand Up @@ -231,12 +247,15 @@ repos:
git_repo: zincati
crate: zincati
fedora_package: rust-zincati
pretty_name: Zincati

templates:
- container/container.yml
- container/container-rebuild.yml
- copr/Makefile
- dependabot/dependabot.yml
- docs/_config.yml
- docs/coreos.scss
- fcos/release-checklist.md
- go/release-checklist.md
- go/signing-ticket.sh
Expand Down
21 changes: 21 additions & 0 deletions docs/_config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
files:
- repo: afterburn
path: docs/_config.yml

- repo: butane
path: docs/_config.yml

- repo: coreos-assembler
path: docs/_config.yml

- repo: coreos-installer
path: docs/_config.yml

- repo: ignition
path: docs/_config.yml

- repo: rpm-ostree
path: docs/_config.yml

- repo: zincati
path: docs/_config.yml
48 changes: 48 additions & 0 deletions docs/_config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Template generated by https://github.com/coreos/repo-templates; do not edit downstream

# To test documentation changes locally or using GitHub Pages, see:
# https://github.com/coreos/fedora-coreos-tracker/blob/main/docs/testing-project-documentation-changes.md

title: {{ pretty_name }}
description: {{ pretty_name }} documentation
baseurl: "/{{ git_repo }}"
url: "https://coreos.github.io"
permalink: /:title/
markdown: kramdown
kramdown:
typographic_symbols:
ndash: "--"
mdash: "---"

remote_theme: just-the-docs/just-the-docs@v0.4.1
plugins:
- jekyll-remote-theme

color_scheme: coreos

# Aux links for the upper right navigation
aux_links:
"{{ pretty_name }} on GitHub":
- "https://github.com/coreos/{{ git_repo }}"

footer_content: "Copyright &copy; <a href=\"https://www.redhat.com\">Red Hat, Inc.</a> and <a href=\"https://github.com/coreos\">others</a>."

# Footer last edited timestamp
last_edit_timestamp: true
last_edit_time_format: "%b %e %Y at %I:%M %p"

# Footer "Edit this page on GitHub" link text
gh_edit_link: true
gh_edit_link_text: "Edit this page on GitHub"
gh_edit_repository: "https://github.com/coreos/{{ git_repo }}"
gh_edit_branch: "main"
gh_edit_source: docs
gh_edit_view_mode: "tree"

compress_html:
clippings: all
comments: all
endings: all
startings: []
blanklines: false
profile: false
1 change: 1 addition & 0 deletions docs/coreos.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
$link-color: #53a3da;
21 changes: 21 additions & 0 deletions docs/coreos.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
files:
- repo: afterburn
path: docs/_sass/color_schemes/coreos.scss

- repo: butane
path: docs/_sass/color_schemes/coreos.scss

- repo: coreos-assembler
path: docs/_sass/color_schemes/coreos.scss

- repo: coreos-installer
path: docs/_sass/color_schemes/coreos.scss

- repo: ignition
path: docs/_sass/color_schemes/coreos.scss

- repo: rpm-ostree
path: docs/_sass/color_schemes/coreos.scss

- repo: zincati
path: docs/_sass/color_schemes/coreos.scss

0 comments on commit 0935854

Please sign in to comment.