From 2ddd8c0f2a5ecd32b04634efc28ad127a583ee07 Mon Sep 17 00:00:00 2001 From: Justin W. Flory (he/him) Date: Jul 25 2023 12:08:11 +0000 Subject: Remove remnants of Fedora Badges docs and point to the new home This commit cleans up leftover files from the Fedora Badges Antora docs and updates the README to now point to the GitLab repository used for managing and maintaining the documentation. This is being done to better unify content and information about Badges into one singular place. This commit will correspond with others in related repositories: 1. https://gitlab.com/fedora/websites-apps/fedora-badges/docs/-/merge_requests/1 2. https://gitlab.com/fedora/websites-apps/documentation/-/merge_requests/2 3. https://pagure.io/fedora-badges 4. https://pagure.io/fedora-badges/docs/pull-request/7 5. https://gitlab.com/fedora/docs/docs-website/docs-fp-o/-/merge_requests/8 Signed-off-by: Justin W. Flory (he/him) --- diff --git a/README.md b/README.md index 4c5db26..a27ffd6 100644 --- a/README.md +++ b/README.md @@ -11,10 +11,16 @@ This Pagure project is used for the following: * Discussion / planning (via issue tickets) * Requesting / working on new badges * Storing assets for created badges (PNGs, SVGs, STLs) -* Documentation ([docs.fedoraproject.org/en-US/badges/](https://docs.fedoraproject.org/en-US/badges/ "Fedora Badges :: Fedora Docs")) Learn more about Fedora Badges (high-level overview) on the [About page](https://badges.fedoraproject.org/about "About Fedora Badges"). +### What is this NOT? + +Documentation about Fedora Badges is no longer stored and maintained here. +Find the new repository on GitLab: + +https://gitlab.com/fedora/websites-apps/fedora-badges/docs + ## What can I do here? diff --git a/build.sh b/build.sh deleted file mode 100755 index 083da18..0000000 --- a/build.sh +++ /dev/null @@ -1,35 +0,0 @@ -#!/bin/sh - -image="antora/antora" -cmd="--html-url-extension-style=indexify site.yml" - -if [ "$(uname)" == "Darwin" ]; then - # Running on macOS. - # Let's assume that the user has the Docker CE installed - # which doesn't require a root password. - docker run --rm -it -v $(pwd):/antora $image $cmd - -elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then - # Running on Linux. - # Check whether podman is available, else faill back to docker - # which requires root. - if [ -f /usr/bin/podman ]; then - runtime="podman" - else - runtime="docker" - fi - if groups | grep -wq "docker"; then - # Check if the current user is in the "docker" group. If true, no sudo is needed. - echo "" - echo "This build script is using $runtime to run the build in an isolated environment." - echo "" - $runtime run --rm -it -v $(pwd):/antora:z $image $cmd - else - # User isn't in the docker group; run the command with sudo. - echo "" - echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password." - echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/." - echo "" - sudo $runtime run --rm -it -v $(pwd):/antora:z $image $cmd - fi -fi diff --git a/nginx.conf b/nginx.conf deleted file mode 100644 index f7093b3..0000000 --- a/nginx.conf +++ /dev/null @@ -1,14 +0,0 @@ -server { - listen 80; - server_name localhost; - - location / { - root /antora/public; - index index.html index.htm; - } - - error_page 500 502 503 504 /50x.html; - location = /50x.html { - root /usr/share/nginx/html; - } -} diff --git a/oh-wait.png b/oh-wait.png deleted file mode 100644 index 1889e57..0000000 Binary files a/oh-wait.png and /dev/null differ diff --git a/oh-wait.svg b/oh-wait.svg deleted file mode 100644 index 7f60066..0000000 --- a/oh-wait.svg +++ /dev/null @@ -1,2628 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/preview.sh b/preview.sh deleted file mode 100755 index 16d02d8..0000000 --- a/preview.sh +++ /dev/null @@ -1,36 +0,0 @@ -#!/bin/sh - -if [ "$(uname)" == "Darwin" ]; then - # Running on macOS. - # Let's assume that the user has the Docker CE installed - # which doesn't require a root password. - echo "The preview will be available at http://localhost:8080/" - docker run --rm -v $(pwd):/antora:ro -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro -p 8080:80 nginx - -elif [ "$(expr substr $(uname -s) 1 5)" == "Linux" ]; then - # Running on Linux. - # Check whether podman is available, else faill back to docker - # which requires root. - if [ -f /usr/bin/podman ]; then - runtime="podman" - else - runtime="docker" - fi - if groups | grep -wq "docker"; then - # Check if the current user is in the "docker" group. If true, no sudo is needed. - echo "" - echo "This build script is using $runtime to run the build in an isolated environment." - echo "The preview will be available at http://localhost:8080/" - echo "" - $runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx - else - # User isn't in the docker group; run the command with sudo. - echo "" - echo "This build script is using $runtime to run the build in an isolated environment. You might be asked for your password." - echo "You can avoid this by adding your user to the 'docker' group, but be aware of the security implications. See https://docs.docker.com/install/linux/linux-postinstall/." - echo "" - echo "The preview will be available at http://localhost:8080/" - echo "" - sudo $runtime run --rm -v $(pwd):/antora:ro,z -v $(pwd)/nginx.conf:/etc/nginx/conf.d/default.conf:ro,z -p 8080:80 nginx - fi -fi diff --git a/site.yml b/site.yml deleted file mode 100644 index 38d1b21..0000000 --- a/site.yml +++ /dev/null @@ -1,21 +0,0 @@ -site: - title: Local Preview - start_page: badges::index -content: - sources: - - url: . - branches: HEAD - start_path: docs -ui: - bundle: - url: https://asamalik.fedorapeople.org/ui-bundle.zip - snapshot: true - default_layout: with_menu -output: - clean: true - dir: ./public - destinations: - - provider: archive -runtime: - pull: true - cache_dir: ./cache