🚚 Update paths and configs for new source repository

This commit is a bulk change to all files from the original state in
Pagure. Notably, this commit brings in updated versions of the build/
preview scripts, removes unnecessary files, and removes the starting
path for the documentation. Since this repository will only be used for
Mindshare docs and no other purpose, the docs will build from the root
directory.

No content was changed or edited, only moved.

Signed-off-by: Justin W. Flory (he/him) <jwf@redhat.com>
This commit is contained in:
Justin Wheeler 2023-04-11 16:42:12 -04:00
commit a752cc6919
Signed by: jflory7
GPG key ID: 7748B15FA8FA4C7E
34 changed files with 36 additions and 39 deletions

6
.gitignore vendored
View file

@ -1,3 +1,9 @@
# Documentation artifacts
# Antora-specific rules for preview documentation
_package/
_preview/
# Miscellaneous artifacts
build
cache
public

View file

@ -2,13 +2,13 @@
# Tip: If you want to use the local preview scripts that come with this repository, please change this value in the site.yml file as well. (under site/start_page)
name: mindshare-committee
# Title will be visible on the page.
title: Mindshare Committee
# Title will be visible on the page.
title: Fedora Mindshare Committee
# If you don't plan to have multiple versions of the docs (for example, to document multiple versions of some software), you can ignore this field. Otherwise, change "master" to a specific version.
version: master
# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.
# We encourage you to name the index page as "index.adoc". If you absolutely have to use a different name, please reflect it here. You can ignore this field otherwise.
start_page: ROOT:index
# This lists all the menu definitions of your component.

View file

@ -1,27 +1,32 @@
#!/bin/sh
image="docker.io/antora/antora"
cmd="--html-url-extension-style=indexify site.yml"
cmd="site.yml"
if [ "$(uname)" = "Darwin" ]; then
if uname | grep -iwq darwin; then
# Running on macOS.
# Let's assume that the user has the Docker CE installed
# which doesn't require a root password.
echo ""
echo "This build script is using Docker container runtime to run the build in an isolated environment."
echo ""
docker run --rm -it -v "$(pwd):/antora" $image $cmd
docker run --rm -it -v "$(pwd):/antora" "${image}" ${cmd}
elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then
elif uname | grep -iq linux; then
# Running on Linux.
# there isn't an antora/aarch64 container, antora can be installed locally
# Check whether podman is available, else faill back to docker
# which requires root.
if [ -f /usr/bin/podman ]; then
if [ -f /usr/local/bin/antora ]; then
/usr/local/bin/antora ${cmd}
elif uname -m | grep -iwq aarch64; then
echo "no antora/aarch64 container try just \`npm install -g @antora/cli @antora/site-generator-default\`"
elif [ -f /usr/bin/podman ]; then
echo ""
echo "This build script is using Podman to run the build in an isolated environment."
echo ""
podman run --rm -it -v "$(pwd):/antora:z" $image $cmd
podman run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
elif [ -f /usr/bin/docker ]; then
echo ""
@ -29,18 +34,19 @@ elif [ "$(expr substr "$(uname -s)" 1 5)" = "Linux" ]; then
echo ""
if groups | grep -wq "docker"; then
docker run --rm -it -v "$(pwd):/antora:z" $image $cmd
else
docker run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
else
echo "You might be asked for your password."
echo "You can avoid this by adding your user to the 'docker' group,"
echo "but be aware of the security implications."
echo "See https://docs.docker.com/install/linux/linux-postinstall/"
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 docker run --rm -it -v "$(pwd):/antora:z" $image $cmd
fi
sudo docker run --rm -it -v "$(pwd):/antora:z" "${image}" ${cmd}
fi
else
echo ""
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
echo "Error: Container runtime haven't been found on your system. Fix it by:"
echo "$ sudo dnf install podman"
exit 1
fi
fi

View file

Before

Width:  |  Height:  |  Size: 77 KiB

After

Width:  |  Height:  |  Size: 77 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 255 KiB

After

Width:  |  Height:  |  Size: 255 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 17 KiB

After

Width:  |  Height:  |  Size: 17 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 21 KiB

After

Width:  |  Height:  |  Size: 21 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 103 KiB

After

Width:  |  Height:  |  Size: 103 KiB

Before After
Before After

View file

Before

Width:  |  Height:  |  Size: 30 KiB

After

Width:  |  Height:  |  Size: 30 KiB

Before After
Before After

View file

@ -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;
}
}

View file

@ -1,21 +1,20 @@
site:
title: Mindshare Local Preview
start_page: mindshare-committee::index
title: (Local Preview) Fedora Mindshare Committee
start_page: mindshare-committee::index.adoc
content:
sources:
- url: .
branches: HEAD
start_path: website
ui:
bundle:
url: https://asamalik.fedorapeople.org/ui-bundle.zip
url: https://gitlab.com/fedora/docs/docs-website/ui-bundle/-/jobs/artifacts/HEAD/raw/build/ui-bundle.zip?job=bundle-stable
snapshot: true
default_layout: with_menu
output:
clean: true
dir: ./public
destinations:
- provider: archive
runtime:
fetch: true
cache_dir: ./cache
urls:
html_extension_style: indexify