diff --git a/docs/Gemfile b/docs/Gemfile deleted file mode 100644 index 1ffd2a02..00000000 --- a/docs/Gemfile +++ /dev/null @@ -1,14 +0,0 @@ -# Bundler setup for jekyll to be deployed on github pages. - -source "https://rubygems.org" - -# Note that we're using the github-pages gem to mimic the GitHub pages -# automated setup. That installs jekyll, a default set of jekyll -# plugins, and a modified jekyll configuration. -group :jekyll_plugins do - gem "github-pages" - gem "jekyll-remote-theme" -end - -# Prefer the GitHub flavored markdown version of kramdown. -gem "kramdown-parser-gfm" diff --git a/docs/_config.yml b/docs/_config.yml deleted file mode 100644 index ae417ed3..00000000 --- a/docs/_config.yml +++ /dev/null @@ -1,58 +0,0 @@ -title: centos/centos-bootc -description: centos-bootc documentation -baseurl: "/centos-bootc" -url: "https://centos.github.io" -# Comment above and use below for local development -# url: "http://localhost:4000" -permalink: /:title/ -markdown: kramdown -kramdown: - typographic_symbols: - ndash: "--" - mdash: "---" - -# Exclude the README and the bundler files that would normally be -# ignored by default. -exclude: - - README.md - - Gemfile - - Gemfile.lock - - prep-docs.sh - - vendor/ - -# These are copies of the apidoc/html and man/html directories. Run -# prep-docs.sh before jekyll to put it in place. -include: [reference, man] - -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: - "centos-bootc on GitHub": - - "https://github.com/centos/centos-bootc" - -footer_content: 'Copyright © Red Hat, Inc. and others.' - -# 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/centos/centos-bootc" -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 diff --git a/docs/_sass/color_schemes/coreos.scss b/docs/_sass/color_schemes/coreos.scss deleted file mode 100644 index a4554be8..00000000 --- a/docs/_sass/color_schemes/coreos.scss +++ /dev/null @@ -1 +0,0 @@ -$link-color: #53a3da; diff --git a/docs/builds.md b/docs/builds.md deleted file mode 100644 index 49e90a12..00000000 --- a/docs/builds.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -nav_order: 3 ---- - -# This document has moved - -Please see the **[Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/)** for build instructions. diff --git a/docs/cloud-agents.md b/docs/cloud-agents.md deleted file mode 100644 index 744789c4..00000000 --- a/docs/cloud-agents.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -nav_order: 5 ---- - -# Project CentOS boot tier-1 and cloud agents - -The tier-0 and tier-1 images today do not contain any special -hypervisor-specific agents. The following specifically are not included -for example: - -- cloud-init -- vmware-guest-agent -- google-guest-agent -- qemu-guest-agent -- ignition -- afterburn - -etc. - -## Unnecessary on bare metal - -For deployment to bare metal using e.g. Anaconda or `bootc install`, none of -these are necessary. - -## Unnecessary for "immutable infrastructure" on hypervisors - -A model we aim to emphasize is having the container image define the -"source of truth" for system state. This conflicts with using e.g. `cloud-init` -and having it fetch instance metadata and raises questions around changes to the -instance metadata and when they apply. - -Related to this, `vmware-guest-agent` includes a full "backdoor" mechanism to -log into the OS. - -## Should be containerized anyways - -In general particularly for e.g. `vmware-guest-agent`, it makes more sense to -containerize it. - -## Easy to install afterward - -Many of these (particularly the first ones mentioned) are easy to install in a -custom image. - -You can build your own derived image that includes e.g. vmware-guest-agent if -required alongside all other desired customizations. - -## Fully supported if installed - -It is supported to include these agents in your image if desired (whether as -part of the base image or containerized). - -## What about Ignition - -Ignition as shipped by CoreOS Container Linux derivatives has a lot of -advantages in providing a model that works smoothly across both bare metal and -virtualized scenarios. - -It also has some compelling advantages over cloud-init at a technical level. - -However, there is also significant overlap between a container-focused model of -the world and an Ignition-focused model. - -For more information, see the [Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/). diff --git a/docs/index.html b/docs/index.html new file mode 100644 index 00000000..a631177f --- /dev/null +++ b/docs/index.html @@ -0,0 +1,15 @@ + + + + + + + Redirecting to Fedora bootc documentation + + + +

centos-bootc documentation has moved

+

This documentation has moved to the Fedora bootc documentation.

+

If you are not redirected automatically, click here.

+ + diff --git a/docs/index.md b/docs/index.md deleted file mode 100644 index c70c55aa..00000000 --- a/docs/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -nav_order: 1 ---- - -# Goals - -This project's toplevel goal is to maintain default definitions for -base *bootable* container images, locked with Fedora ELN and CentOS Stream 9. - -## Documentation - -For comprehensive documentation on bootc, please see the **[Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/)**. - -## Status - -This repository is archived. Development has moved to [gitlab.com/redhat/centos-stream/containers/bootc](https://gitlab.com/redhat/centos-stream/containers/bootc). - -## Container images - -The primary output of this project is container images. The current -main development targets are [Fedora ELN](https://docs.fedoraproject.org/en-US/eln/) -and CentOS Stream 9. - -### Distribution locked images - -These images are intended to exactly match the content of the underlying distribution. - -- `quay.io/centos-bootc/fedora-bootc:eln` -- `quay.io/centos-bootc/centos-bootc:stream9` - -### Layered images - -There are also layered images; for more information on these, see -[the centos-bootc-layered repository](https://gitlab.com/bootc-org/centos-bootc-layered). - -## Badges - -| Badge | Description | Service | -| ----------------------- | -------------------- | ------------ | -| [![Renovate][1]][2] | Dependencies | Renovate | -| [![Pre-commit][3]][4] | Static quality gates | pre-commit | - -[1]: https://img.shields.io/badge/renovate-enabled-brightgreen?logo=renovate -[2]: https://renovatebot.com -[3]: https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit -[4]: https://pre-commit.com/ diff --git a/docs/install.md b/docs/install.md deleted file mode 100644 index 2bb5efee..00000000 --- a/docs/install.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -nav_order: 2 ---- - -# This document has moved - -Please see the **[Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/)** for installation instructions. diff --git a/docs/related.md b/docs/related.md deleted file mode 100644 index f3c63737..00000000 --- a/docs/related.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -nav_order: 6 ---- - -# This document has moved - -Please see the **[Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/)** for related resources. diff --git a/docs/usage.md b/docs/usage.md deleted file mode 100644 index 3fc6ea41..00000000 --- a/docs/usage.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -nav_order: 4 ---- - -# This document has moved - -Please see the **[Fedora bootc documentation](https://docs.fedoraproject.org/en-US/bootc/)** for usage instructions.