diff --git a/README.md b/README.md index 7382b1a5..75a8b658 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,18 @@ # Pulp 3 Containers The [pulp-oci-images](https://github.com/pulp/pulp-oci-images) repository is used to provide container images for running Pulp. -These images represent one of several officially supported [Pulp installation methods](https://docs.pulpproject.org/pulpcore/installation/instructions.html). +These images represent one of the officially supported Pulp installation methods. The available images can be divided into two types: - [Multi-Process Images](multi-process-images) - Images for running a [Pulp](https://github.com/pulp/pulpcore) or [Ansible Galaxy](https://github.com/ansible/galaxy_ng), as well as its [third-party services](#third-party-services), in a single Docker/Podman container. -- [Single-Process Images](single-process-images) - Images containing a single Pulp service each, which collectively make up a Pulp instance. They can be used via docker-compose or podman-compose, example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). These images are also used by [pulp operator](https://docs.pulpproject.org/pulp_operator/). +- [Single-Process Images](single-process-images) - Images containing a single Pulp service each, which collectively make up a Pulp instance. They can be used via docker-compose or podman-compose, example [here](https://github.com/pulp/pulp-oci-images/tree/latest/images/compose). These images are also used by [pulp operator](https://pulpproject.org/pulp-operator/). Note that OCI stands for "Open Container Initiative", see [here](https://opencontainers.org/). ## Quickstart -See the [quickstart guide for deploying](quickstart). +See the [quickstart guide for deploying](https://pulpproject.org/pulp-oci-images/docs/admin/tutorials/quickstart/). ## Available Images @@ -45,7 +45,7 @@ both pulp-api and pulp-content into one service. ## Get Help -Documentation: [https://docs.pulpproject.org/pulp_oci_images/](https://docs.pulpproject.org/pulp_oci_images/) +Documentation: [https://pulpproject.org/pulp-oci-images/](https://pulpproject.org/pulp-oci-images/) Issue Tracker: [https://github.com/pulp/pulp-oci-images/issues](https://github.com/pulp/pulp-oci-images/issues) diff --git a/mkdocs.yml b/mkdocs.yml deleted file mode 100644 index 396897bd..00000000 --- a/mkdocs.yml +++ /dev/null @@ -1,50 +0,0 @@ ---- -site_name: Pulp OCI Images -site_description: Pulp Containers -site_author: Pulp Team -site_url: https://docs.pulpproject.org/pulp_oci_images/ -repo_name: pulp/pulp-oci-images -repo_url: https://github.com/pulp/pulp-oci-images -edit_uri: edit/main/docs -theme: - features: - - search.suggest - - search.highlight - - search.share - name: material - custom_dir: "docs/overrides" - logo: images/pulp_logo_big.png - palette: - - scheme: default - media: "(prefers-color-scheme: light)" - primary: white - toggle: - icon: material/toggle-switch-off-outline - name: Switch to dark mode - - scheme: slate - media: "(prefers-color-scheme: dark)" - primary: white - toggle: - icon: material/toggle-switch - name: Switch to light mode -nav: - - Home: index.md - - Multi-Process Images: multi-process-images.md - - Single-Process Images: single-process-images.md - - Migrating from pulp_installer to a multi-process container: migration-pulp-installer-to-multi-process.md - - Developer Instructions: developer-instructions.md - - Changelog: CHANGES.md -markdown_extensions: - - toc: - permalink: "#" - - pymdownx.superfences - - admonition -extra: - version: - provider: mike - default: latest -plugins: - - git-revision-date - - search: - lang: en - prebuild_index: true diff --git a/pulp_oci_images/doc_requirements.txt b/pulp_oci_images/doc_requirements.txt deleted file mode 100644 index db02e3f0..00000000 --- a/pulp_oci_images/doc_requirements.txt +++ /dev/null @@ -1,5 +0,0 @@ -mkdocs -mike -mkdocs-git-revision-date-plugin -mkdocs-material -Jinja2<3.1