From 7456da9746382249e3d8aed237f8ab3168b770d3 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Holcroft Date: Jul 15 2020 11:15:49 +0000 Subject: [PATCH 1/2] docs were moved to a dedicated repository it's here now: https://pagure.io/fedora-badges/docs --- diff --git a/docs/README.md b/docs/README.md deleted file mode 100644 index 383403a..0000000 --- a/docs/README.md +++ /dev/null @@ -1,120 +0,0 @@ -# Fedora Docs Template - -This repository contains a minimal source structure for a new Fedora Docs source. - -## Structure - -``` -|-- README.md -|-- antora.yml ....................... 1. -|-- build.sh ......................... 2. -|-- preview.sh ....................... 3. -|-- site.yml ......................... 4. -`-- modules - `-- ROOT ......................... 5. - |-- assets - | `-- images ............... 6. - | `-- pizza.png - |-- nav.adoc ................. 7. - `-- pages .................... 8. - |-- architecture.adoc - |-- community.adoc - |-- faq.adoc - |-- index.adoc - |-- pizza-dough.adoc - `-- pizza-owen.adoc -``` - -1. Metadata definition. -2. A script that does a local build. Uses docker. -3. A script that shows a preview of the site in a web browser by running a local web server. Uses docker. -4. A definition file for the build script. -5. A "root module of this documentation component". Please read below for an explanation. -6. **Images** to be used on any page. -7. **Menu definition.** Also defines the hierarchy of all the pages. -8. **Pages with the actual content.** They can be also organised into subdirectories if desired. - -## Components and Modules - -Antora introduces two new terms: - -* **Component** — Simply put, a component is a part of the documentation website with its own menu. Components can also be versioned. In the Fedora Docs, we use separate components for user documentation, the Fedora Poject, Fedora council, Mindshare, FESCO, but also subprojects such as CommOps or Modulartity. -* **Module** — A component can be broken down into multiple modules. Modules still share a single menu on the site, but their sources can be stored in different git repositories, even owned by different groups. The default module is called "ROOT" (that's what is in this example). If you don't want to use multiple modules, only use "ROOT". But to define more modules, simply duplicate the "ROOT" directory and name it anything you want. You can store modules in one or more git repositories. - -## Local preview - -This repo includes scripts to build and preview the contents of this repository. - -**NOTE**: Please note that if you reference pages from other repositoreis, such links will be broken in this local preview as it only builds this repository. If you want to rebuild the whole Fedora Docs site, please see [the Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o/) for instructions. - -Both scripts use docker, so please make sure you have it installed on your system. Please see below for instructions. - -To build and preview the site, run: - -``` -$ ./build.sh && ./preview.sh -``` - -The result will be available at http://localhost:8080 - -### Installing docker on Fedora - -``` -$ sudo dnf install docker -$ sudo systemctl start docker && sudo systemctl enable docker -``` - -### Preview as a part of the whole Fedora Docs site - -You can also build the whole Fedora Docs site locally to see your changes in the whole context. -This is especially useful for checking if your `xref` links work properly. - -To do this, you need to clone the main [Fedora Docs build repository](https://pagure.io/fedora-docs/docs-fp-o), modify the `site.yml` file to reference a repo with your changes, and build it. -Steps: - -Clone the main repository and cd into it: - -``` -$ git clone https://pagure.io/fedora-docs/docs-fp-o.git -$ cd docs-fp-o -``` - -Find a reference to the repository you're changing in the `site.yml` file, and change it so it points to your change. -So for example, if I made a modification to the Modularity docs, I would find: - -``` -... - - url: https://pagure.io/fedora-docs/modularity.git - branches: - - master -... -``` - -And replaced it with a pointer to my fork: -``` -... - - url: https://pagure.io/forks/asamalik/fedora-docs/modularity.git - branches: - - master -... -``` - -I could also point to a local repository, using `HEAD` as a branch to preview the what's changed without the need of making a commit. - -**Note:** I would need to move the repository under the `docs-fp-o` directory, because the builder won't see anything above. -So I would need to create a `repositories` directory in `docs-fp-o` and copy my repository into it. - -``` -... - - url: ./repositories/modularity - branches: - - HEAD -... -``` - -To build the whole site, I would run the following in the `docs-fp-o` directory. - -``` -$ ./build.sh && ./preview.sh -``` - diff --git a/docs/antora.yml b/docs/antora.yml deleted file mode 100644 index 1afff35..0000000 --- a/docs/antora.yml +++ /dev/null @@ -1,16 +0,0 @@ -# Name will be mostly visible in the URL. Treat it as an indentifier. -# 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: badges - -# Title will be visible on the page. -title: Fedora Badges - -# 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. -start_page: ROOT:index - -# This lists all the menu definitions of your component. -nav: -- modules/ROOT/nav.adoc diff --git a/docs/modules/ROOT/assets/attachments/content/backgrounds.svg b/docs/modules/ROOT/assets/attachments/content/backgrounds.svg deleted file mode 100644 index 8f961a2..0000000 --- a/docs/modules/ROOT/assets/attachments/content/backgrounds.svg +++ /dev/null @@ -1,5244 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - R I P - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/content/badge_graphics.svg b/docs/modules/ROOT/assets/attachments/content/badge_graphics.svg deleted file mode 100644 index 5f8dc9f..0000000 --- a/docs/modules/ROOT/assets/attachments/content/badge_graphics.svg +++ /dev/null @@ -1,9941 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - st - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - K - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 10x - - - - - - - - - - - - - - - - - - - - - - - - - - HI, FEDORA. - - - - - - - - - - - - - - - - - - - - 1 - st - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ****** - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - # - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - R I P - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - GSoC - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/content/badgers.svg b/docs/modules/ROOT/assets/attachments/content/badgers.svg deleted file mode 100644 index 5b285e3..0000000 --- a/docs/modules/ROOT/assets/attachments/content/badgers.svg +++ /dev/null @@ -1,3540 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/content/pandas.svg b/docs/modules/ROOT/assets/attachments/content/pandas.svg deleted file mode 100644 index 03704dc..0000000 --- a/docs/modules/ROOT/assets/attachments/content/pandas.svg +++ /dev/null @@ -1,2862 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/fedora-badges-style-guide.pdf b/docs/modules/ROOT/assets/attachments/fedora-badges-style-guide.pdf deleted file mode 100644 index 0320480..0000000 Binary files a/docs/modules/ROOT/assets/attachments/fedora-badges-style-guide.pdf and /dev/null differ diff --git a/docs/modules/ROOT/assets/attachments/palettes/badges_extended_palette.gpl b/docs/modules/ROOT/assets/attachments/palettes/badges_extended_palette.gpl deleted file mode 100644 index 8e6a702..0000000 --- a/docs/modules/ROOT/assets/attachments/palettes/badges_extended_palette.gpl +++ /dev/null @@ -1,28 +0,0 @@ -GIMP Palette -Name: badges_extended_palette -# - 0 6 255 #0006FF - 15 116 178 #0F74B2 - 30 221 30 #1EDD1E - 41 65 114 #294172 - 60 110 180 #3C6EB4 - 72 55 41 #483729 - 76 93 12 #4C5D0C - 78 154 6 #4E9A06 - 93 56 122 #5D387A -100 162 142 #64A28E -117 142 19 #758E13 -120 103 33 #786721 -124 95 71 #7C5F47 -126 192 170 #7EC0AA -137 45 197 #892DC5 -158 41 43 #9E292B -160 206 220 #A0CEDC -190 121 23 #BE7917 -197 166 43 #C5A62B -227 229 153 #E3E599 -233 221 175 #E9DDAF -247 225 193 #F7E1C1 -255 0 0 #FF0000 -255 139 0 #FF8B00 -255 255 0 #FFFF00 diff --git a/docs/modules/ROOT/assets/attachments/palettes/badges_fedora_palette.gpl b/docs/modules/ROOT/assets/attachments/palettes/badges_fedora_palette.gpl deleted file mode 100644 index aa6fde1..0000000 --- a/docs/modules/ROOT/assets/attachments/palettes/badges_fedora_palette.gpl +++ /dev/null @@ -1,27 +0,0 @@ -GIMP Palette -Name: badges_fedora_palette -# - 41 65 114 #294172 - 60 110 180 #3C6EB4 - 83 89 97 #535961 -111 129 166 #6F81A6 -121 129 139 #79818B -121 219 50 #79DB32 -143 174 217 #8FAED9 -154 159 166 #9A9FA6 -160 124 188 #A07CBC -187 237 151 #BBED97 -196 199 204 #C4C7CC -207 189 221 #CFBDDD -216 225 238 #D8E1EE -219 50 121 #DB3279 -223 224 227 #DFE0E3 -229 151 40 #E59728 -232 239 248 #E8EFF8 -233 249 221 #E9F9DD -236 229 241 #ECE5F1 -237 151 187 #ED97BB -239 240 241 #EFF0F1 -242 202 146 #F2CA92 -249 221 233 #F9DDE9 -251 238 219 #FBEEDB diff --git a/docs/modules/ROOT/assets/attachments/templates/community-template.svg b/docs/modules/ROOT/assets/attachments/templates/community-template.svg deleted file mode 100644 index 953e04c..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/community-template.svg +++ /dev/null @@ -1,1763 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/templates/content-learning-template.svg b/docs/modules/ROOT/assets/attachments/templates/content-learning-template.svg deleted file mode 100644 index 569b2d2..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/content-learning-template.svg +++ /dev/null @@ -1,1578 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/templates/development-template.svg b/docs/modules/ROOT/assets/attachments/templates/development-template.svg deleted file mode 100644 index 66e8a49..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/development-template.svg +++ /dev/null @@ -1,2183 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/templates/events-template.svg b/docs/modules/ROOT/assets/attachments/templates/events-template.svg deleted file mode 100644 index 5cc3cb5..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/events-template.svg +++ /dev/null @@ -1,1578 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/templates/miscellaneous-template.svg b/docs/modules/ROOT/assets/attachments/templates/miscellaneous-template.svg deleted file mode 100644 index 3adcba5..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/miscellaneous-template.svg +++ /dev/null @@ -1,1578 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/templates/quality-template.svg b/docs/modules/ROOT/assets/attachments/templates/quality-template.svg deleted file mode 100644 index 3230714..0000000 --- a/docs/modules/ROOT/assets/attachments/templates/quality-template.svg +++ /dev/null @@ -1,1578 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/tutorial-content/bike.svg b/docs/modules/ROOT/assets/attachments/tutorial-content/bike.svg deleted file mode 100644 index c4eef96..0000000 --- a/docs/modules/ROOT/assets/attachments/tutorial-content/bike.svg +++ /dev/null @@ -1,10189 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/tutorial-content/hatchling.svg b/docs/modules/ROOT/assets/attachments/tutorial-content/hatchling.svg deleted file mode 100644 index b521151..0000000 --- a/docs/modules/ROOT/assets/attachments/tutorial-content/hatchling.svg +++ /dev/null @@ -1,17958 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/tutorial-content/package.svg b/docs/modules/ROOT/assets/attachments/tutorial-content/package.svg deleted file mode 100644 index a79b751..0000000 --- a/docs/modules/ROOT/assets/attachments/tutorial-content/package.svg +++ /dev/null @@ -1,10030 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/tutorial-content/panda.svg b/docs/modules/ROOT/assets/attachments/tutorial-content/panda.svg deleted file mode 100644 index 01774ef..0000000 --- a/docs/modules/ROOT/assets/attachments/tutorial-content/panda.svg +++ /dev/null @@ -1,9900 +0,0 @@ - - - - - - - - image/svg+xml - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/modules/ROOT/assets/attachments/typeface/comfortaa.zip b/docs/modules/ROOT/assets/attachments/typeface/comfortaa.zip deleted file mode 100644 index 232a17b..0000000 Binary files a/docs/modules/ROOT/assets/attachments/typeface/comfortaa.zip and /dev/null differ diff --git a/docs/modules/ROOT/assets/images/README.md b/docs/modules/ROOT/assets/images/README.md deleted file mode 100644 index 0ba0cd7..0000000 --- a/docs/modules/ROOT/assets/images/README.md +++ /dev/null @@ -1,4 +0,0 @@ -Images -====== - -Add static images used across documents in this directory. diff --git a/docs/modules/ROOT/nav.adoc b/docs/modules/ROOT/nav.adoc deleted file mode 100644 index aeb98c7..0000000 --- a/docs/modules/ROOT/nav.adoc +++ /dev/null @@ -1,3 +0,0 @@ -* xref:join.adoc[Join Badges community] -* xref:design-badges.adoc[How to design Fedora Badges] -* xref:push-badges.adoc[How to push Fedora Badges] diff --git a/docs/modules/ROOT/pages/_partials/attributes.adoc b/docs/modules/ROOT/pages/_partials/attributes.adoc deleted file mode 100644 index 80f9545..0000000 --- a/docs/modules/ROOT/pages/_partials/attributes.adoc +++ /dev/null @@ -1,6 +0,0 @@ -:BADGES-HOME: https://badges.fedoraproject.org/ -:BADGES-USER: https://badges.fedoraproject.org/user -:COMMBLOG: https://communityblog.fedoraproject.org -:FEDMSG: http://www.fedmsg.com/ -:FWIKI: https://fedoraproject.org/wiki -:YEAR: 2020 diff --git a/docs/modules/ROOT/pages/design-badges.adoc b/docs/modules/ROOT/pages/design-badges.adoc deleted file mode 100644 index 6ed4491..0000000 --- a/docs/modules/ROOT/pages/design-badges.adoc +++ /dev/null @@ -1,114 +0,0 @@ -include::{partialsdir}/attributes.adoc[] - -= How to design a Fedora Badge - -This page explains how to design and create new Fedora Badges. -This guide walks through the following: - -* Review guidelines for creating a Badge -* Set up Inkscape for Fedora Badges -* Get badge template files - - -[[style-guide]] -== Review Badges style guide - -Refer to the Fedora Badges style guide for how Badges are designed. -The style guide provides explanations and suggestions for shapes, colors, and other requirements to design good badges. -Refer to this often while designing new badges. -Following this guide makes new badge submissions easier to review and less time reworking a badge from feedback. - -link:{attachmentsdir}/fedora-badges-style-guide.pdf[Fedora Badges Style Guide] (_last revised_: January 2014) - - -[[set-up-inkscape]] -== Set up Inkscape - -Inkscape is recommended for designing Fedora Badges. -Other Badge designers use Inkscape. -Providing help and support is easier if you use the same tools. - -[[install-inkscape]] -=== Install Inkscape - -Using Fedora? -Reference the Fedora Magazine's https://fedoramagazine.org/getting-started-inkscape-fedora/[Getting started with Inkscape on Fedora] article for help. -For other operating systems, see Inkscape's https://inkscape.org/release/[downloads portal] for help installing it. - -[[install-color-palettes]] -=== Download and install color palettes - -Common color schemes are recommended for Fedora Badges. -The following palettes provide the recommended colors for Inkscape. -With these palettes, common colors will appear in the color toolbar of Inkscape. -These palettes may work with other design programs, but they are not officially supported. - -* link:{attachmentsdir}/palettes/badges_fedora_palette.gpl[Basic color palette]: Required -* link:{attachmentsdir}/palettes/badges_extended_palette.gpl[Extended color palette]: Optional (gives you extra choices to work with) - -To install, move the downloaded palette files to ~/.config/inkscape/palettes -To access the newly installed palettes, in Inkscape, find the palette bar at the bottom of the screen and click triangle at the right end and select your desired palette. - -[[install-typeface]] -=== Install Comfortaa typeface - -Badges with text use the Comfortaa typeface. -The Comfortaa typeface is used across the Fedora community. -Install the typeface so it is available in your design program. -_Note_: If you use Fedora, the font may already be installed. - -* link:{attachmentsdir}/typeface/comfortaa.zip[Comfortaa typeface] - - -[[badge-template-assets]] -== Download Badge template assets - -Different Fedora Badges templates are available to choose from. -Templates are organized in different categories below. - -[[badge-shapes]] -=== Badge shapes - -All Fedora Badges have a common shape. -Some have different color rings depending on the type of badge (see link:{attachmentsdir}/fedora-badges-style-guide.pdf[Fedora Badges Style Guide]). -Not sure what template to use? -Ask for help in a Fedora Badges ticket and a designer will help you choose. - -* link:{attachmentsdir}/templates/community-template.svg[Community template] -* link:{attachmentsdir}/templates/content-learning-template.svg[Content template] -* link:{attachmentsdir}/templates/development-template.svg[Development template] -* link:{attachmentsdir}/templates/events-template.svg[Events template] -* link:{attachmentsdir}/templates/miscellaneous-template.svg[Miscellaneous template] -* link:{attachmentsdir}/templates/quality-template.svg[Quality Assurance template] - -[[content-templates]] -=== Content templates - -Content templates are common patterns or content used across many badges. -The Badges team encourages using these templates where possible. -It helps maintain a consistent theme across the Badges site. - -* link:{attachmentsdir}/content/backgrounds.svg[Backgrounds template]: Different backgrounds to use for badge designs -* link:{attachmentsdir}/content/badge_graphics.svg[Misc. graphics]: Random icons and patterns -* link:{attachmentsdir}/content/badgers.svg[Badger templates]: Example badgers to reuse -* link:{attachmentsdir}/content/pandas.svg[Panda templates]: Example pandas to reuse - -[[tutorial-content]] -=== Tutorial content - -Tutorial content are pre-created, individual designs to help you design a Fedora Badge. -Tutorial content was created for other badges, but can be reused in future designs. -If you want to try out a new design, try using these to create your ideas! - -* link:{attachmentsdir}/tutorial-content/bike.svg[Bicycle] (with no rider) -* link:{attachmentsdir}/tutorial-content/hatchling.svg[Package hatching from egg] -* link:{attachmentsdir}/tutorial-content/package.svg[Package icon] -* link:{attachmentsdir}/tutorial-content/panda.svg[Full-sized panda] (from panda riding bike) - -[[Further reading]] -=== Further reading - -More information about the way that Fedora badges are created, added to Pagure and distributed to the community are available. - -* https://fedora-infra-docs.readthedocs.io/en/latest/sysadmin-guide/sops/badges.html[badges SOP] -* https://github.com/fedora-infra/fedbadges[Fedbadges repository at Github] diff --git a/docs/modules/ROOT/pages/index.adoc b/docs/modules/ROOT/pages/index.adoc deleted file mode 100644 index a5a44f5..0000000 --- a/docs/modules/ROOT/pages/index.adoc +++ /dev/null @@ -1,21 +0,0 @@ -include::{partialsdir}/attributes.adoc[] - -= Fedora Badges - -{BADGES-HOME}[Fedora Badges] is a fun website built to recognize contributors to the Fedora Project, help new and existing Fedora contributors find different ways to get involved, and encourage the improvement of Fedora's infrastructure. - -== How does Badges work? - -It's really easy! -Sign into Badges with your Fedora account, and you'll see you have at least one badge right away. -Congratulations - you're a Badger! -If you participate in Fedora in any way, you'll probably notice Badges popping up on your profile as you go about your business, though sadly we don't cover every area of Fedora yet - we're doing our best to make sure we reward as many forms of participation as we can! - -Want to see how your badge collection compares with others? -Check the Leaderboard. -Jonesing for more badges? -You can check the Badge index to see all the badges and get to work on your collection! -Click on a badge to see how to get it - but we intentionally didn't spell it all out exactly. -Part of the fun is figuring it out! - -Another cool thing: the Badges site is mobile-optimized, so you can easily keep track of your badges on the go! diff --git a/docs/modules/ROOT/pages/join.adoc b/docs/modules/ROOT/pages/join.adoc deleted file mode 100644 index 897cdd0..0000000 --- a/docs/modules/ROOT/pages/join.adoc +++ /dev/null @@ -1,147 +0,0 @@ -include::{partialsdir}/attributes.adoc[] - -= Join Fedora Badges community - -Become a member of Fedora Badges community by following these steps. - - -[[fas]] -== Create a FAS account - -Create a {FWIKI}/Account_System[Fedora Account System account] and sign the {FWIKI}/Legal:Fedora_Project_Contributor_Agreement[Fedora Project Contributor Agreement]. -Do this through the https://admin.fedoraproject.org/accounts/[Fedora Account System]. - - -[[discourse]] -== Subscribe to Fedora Badges mailing list - -Log into the Fedora mailing lists site at https://lists.fedoraproject.org/accounts/login/?next=/admin/lists/badges.lists.fedoraproject.org/[lists.fedoraproject.org] using your FAS account credentials. -Then, find the https://lists.fedoraproject.org/admin/lists/badges.lists.fedoraproject.org/[Fedora Badges mailing list] and subscribe using your personal email address. -Do not use the `@fedoraproject.org` alias, as you are unable to send email from the address. - -News, updates, and discussion are shared through on the mailing list. -It is a *key part* to how we communicate. -It receives low to medium traffic. - - -[[introduction]] -== Post a self-introduction - -Say hello and introduce yourself to the team! -Post a self-introduction to the mailing list and tell us a little about yourself. - -Not sure what to say? -Answer these questions to start: - -* Why are you interested in contributing to Fedora? -* Why are you interested in contributing to Badges? -* If you're involved with other things in Fedora, what are/were you working on? -* Do you have any experience in open source or online communities? - If so, what? -* What parts of the Badges project are interesting to you? -* Do you have any questions for us? - How can we help _you_ get started? - - -[[community-blog]] -== Register on Community Blog - -The Fedora {COMMBLOG}[Community Blog] is an important place for sharing news in the Fedora community. -An account gives permissions to view article drafts and previews before they are published. -If you ever write an article, you need an account. -To register, log in at the {COMMBLOG}/wp-login.php[login page] with your Fedora Account System (FAS) credentials. - -Need more help logging in? -Read the {COMMBLOG}/how-to-log-in/[help page] for more detailed instructions. - - -[[irc-telegram]] -== Join our IRC/Telegram chat - -Fedora uses the https://freenode.net[Freenode IRC network] and https://telegram.org/[Telegram] for instant messaging and communication. -You can use the messaging client of your choice, as the IRC channel and Telegram group are bridged together. -Short discussions and planning happen in our group chat. - -Never used IRC before? -See the https://fedoramagazine.org/beginners-guide-irc/[Beginner's Guide to IRC] on the Fedora Magazine. -Additionally, you can connect temporarily in a chat session in your browser via https://webchat.freenode.net/?channels=fedora-badges[Freenode web chat]. -However, if you want to stay connected even when you are not online, consider https://opensource.com/article/17/5/introducing-riot-IRC[using Riot] as your IRC client. - -The IRC channel is also bridged to a Telegram group, https://t.me/fedorabadges[@fedorabadges]. -Join the group at https://t.me/fedorabadges[t.me/fedorabadges]. - - -[[first-steps]] -== Make your first steps - -See xref:commops:ROOT:contribute/first-steps.adoc[Make your first steps in Fedora] for more info. - - -[[start-task]] -== Start on a task - -There are three ways to contribute to Fedora Badges: - -* As a designer -* As a developer -* As a system administrator - -Before you begin any of the following tasks, https://lists.fedoraproject.org/admin/lists/badges.lists.fedoraproject.org/[introduce yourself on the mailing list]! - -=== As a designer - -The Fedora Badges community accepts requests for new badges in a public issue tracker on https://pagure.io/fedora-badges/issues[pagure.io/fedora-badges]. -The community opens an issue there when they have a new idea for a badge. -To get started with badge design, follow these steps: - -. Review xref::design-badges.adoc[How to design a Fedora Badge] documentation -. Set up Inkscape with Badges color palettes, fonts, and templates (provided in documentation) -. Review Badge tickets tagged as https://pagure.io/fedora-badges/issues?status=Open&tags=artwork+-+needed[artwork - needed] -. If nobody is assigned to the issue, leave a comment that you want to work on the Badge artwork -. A Badges contributor will reply to confirm the Badge is possible and ready to be worked on (we don't want you to make a design for a Badge that isn't technically possible!) -. Begin designing the badge, post SVGs/PNGs of your artwork to the issue for review - -=== As a developer - -_NOTE_: This section is specific to Outreachy Summer 2020 applicants. - -You can also contribute code to the Fedora Badges project. -There are two git repositories to contribute code: - -* *Upstream*: https://github.com/concentricsky/badgr-server[github.com/concentricsky/badgr-server] -* *Our fork*: https://github.com/fedora-infra/badgr-server[github.com/fedora-infra/badgr-server] - -Tasks, problems, and goals are filed as tickets in the issue trackers. -The upstream repository is where we submit patches and improvements to the *badgr-server* project that Fedora Badges uses. -Our forked repository is where we keep track of development tasks and goals specific to the Fedora Badges implementation. - -==== Complete mini projects - -This Outreachy project is different from many other Outreachy projects. -The Fedora Badges project involves moving from a legacy framework to a new platform for the Fedora Badges web app. -It might sound scary, but there is a team of people ready to help! -So, part of the work for development includes *research tasks* before we begin writing a lot of new code. - -Before you write code, you need to set up a development environment and learn about Fedora infrastructure tooling. -The Fedora Badges team identified a few "mini projects" for applicants to work on. -These help you learn about the tools we will work with and get more experience with other parts of Fedora's infrastructure. -Check out these issues to get started: - -. https://github.com/fedora-infra/badgr-server/issues/3[fedora-infra/badgr-server#3]: Deploy a simple django application on Openshift Online -. https://github.com/fedora-infra/badgr-server/issues/4[fedora-infra/badgr-server#4]: Deploy a local badgr instance and see if features we want are here -. https://github.com/fedora-infra/badgr-server/issues/1[fedora-infra/badgr-server#1]: Install fedora-messaging locally and publish a test message - -==== Submit code patches - -_NOTE_: We advise waiting until Monday, 16 March 2020 to start on code patches! -The recommended development environment will have major changes starting that day. - -Fedora Badges is partnering with the upstream *concentricsky/badgr-server* project to submit code and documentation improvements. -The Concentric Sky team https://github.com/concentricsky/badgr-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22[tagged issues as "help wanted"] for where to start with contributing. -The Fedora Badges mentor team is also participating there. -If you are interested in working on a code patch for *concentricsky/badgr-server*, comment on the GitHub issue that you would like to work on the task. -If someone else has not already started, you can begin working on your pull request. - -=== As a system administrator - -Coming soon… diff --git a/docs/modules/ROOT/pages/push-badges.adoc b/docs/modules/ROOT/pages/push-badges.adoc deleted file mode 100644 index 5787006..0000000 --- a/docs/modules/ROOT/pages/push-badges.adoc +++ /dev/null @@ -1,283 +0,0 @@ -= How to push Fedora Badges -:toc: - -== Architecture - -The badge-awarding back-end daemon, https://github.com/fedora-infra/fedbadges[fedbadges], wakes up when it receives a http://fedmsg.com/en/stable/[fedmsg] event. -It compares that message and the history in https://github.com/fedora-infra/datanommer[datanommer] against a series of rules. -If a contributor matches the criteria described in one of those rules, then they are awarded a badge. - -The front-end is a web application called https://github.com/fedora-infra/tahrir[Tahrir]. -It mostly is just an interface for users to look at their badges. -However, it also has an admin interface for manually adding new badges, awarding badges, and creating "invitations" (QR codes) for badges. - -The badge-awarding back-end daemon, https://github.com/fedora-infra/fedbadges[fedbadges], runs on the `badges-backend01` node. -The process is `fedmsg-hub` and logs are in `/var/log/fedmsg/fedmsg-hub.log`. - -The front-end runs under `apache/mod_wsgi` on `badges-web0{1,2}` nodes. - -=== Upstream documentation - -* For a detailed description of how the fedbadges daemon works, see the https://github.com/fedora-infra/fedbadges/blob/develop/README.rst[fedbadges README]. -* For a diagram of the interacting pieces in the Fedora Badges system, see the https://github.com/fedora-infra/fedbadges/blob/develop/diagrams/[fedbadges diagrams]. - - -== Sysadmin process: How to push a Badge - -Pushing badges consists of two operations: - -. Push badge assets (`.png`, `.svg`, `.yaml`) to https://pagure.io/fedora-badges[fedora-badges] repository -. Add badge to https://badges.fedoraproject.org/[badges.fedoraproject.org] - -Anyone with write permissions to https://pagure.io/fedora-badges[fedora-badges] can push badges. -Pull requests can also be used. -Only members of the `sysadmin-badges` FAS group _and_ xref:add-tahrir-admins[admins of the web interface] can add badges. - -Badge artists and badge developers should push design assets (`png` and `svg` art) and rules (`yaml`) to the https://pagure.io/fedora-badges[fedora-badges] repository. - -=== Preparing to create a badge - -Once a badge is approved by the Design Team and has the https://pagure.io/fedora-badges/issues?status=Open&tags=ready+to+push[ready to push] tag, they are ready to be pushed. -Follow this checklist to push a new badge: - -. Ensure artwork is *approved* by Design Team -. Ensure name and description of badge are clear -. Ensure one of these requirements is met: -** _Manually awarded badges_: What FAS accounts receive permissions to award badge -** _Awarded via fedmsg rule_: YAML file with rules is present - -If you are confused or something is missing, comment on the issue and remove the *ready to push* tag. - -=== Add badge assets to Pagure - -. Download artwork and rule file (if applicable): -** Double-check the artwork is actually the final version from ticket -** Open / view both art files to check they are not corrupt (in the past, corrupt images were accidentally pushed) -. Give both art and rule files the *same name*, place into https://pagure.io/fedora-badges/blob/master/f/pngs[pngs/], https://pagure.io/fedora-badges/blob/master/f/svgs[svg/], https://pagure.io/fedora-badges/blob/master/f/rules[rules/] directories -. _On request only_: Generate a STL file for 3D-printing a badge: -** Change directories into `bin/` and run `export.sh`. - This creates a STL file for the badge and moves it to the correct place. -** Check the `README` file in `bin/` for more info about the script. -. Commit all files and push to https://pagure.io/fedora-badges[fedora-badges] (or make a PR) - -Make sure files have a reasonable name (e.g. `all-lowercase-dashes-only.png`). -Some types of badges follow a naming convention, like FAS group membership badges (i.e. `fas-badge-name.png`) or Koji build badges (i.e. `koji-badge-name.png`). -Follow past precedent where possible. -Later, the file name is used for the file on the front-end server (e.g. `https://badges.fedoraproject.org/pngs/all-lowercase-dashes-only.png`). - -=== Push assets to back-end server via Ansible - -_Note_: All assets must be in the `master` branch of https://pagure.io/fedora-badges[fedora-badges] before proceeding. -You must also be a member of `sysadmin-badges` in FAS for this to work. - -Next, you need to move all assets from the Pagure repository to the back-end server. -This is done via an https://infrastructure.fedoraproject.org/cgit/ansible.git/tree/playbooks/manual/push-badges.yml[Ansible playbook] from the `batcave` server. -Follow these steps to push the assets to production. - -. SSH into `batcave01.phx2.fedoraproject.org` -. Run the playbook: `sudo rbac-playbook manual/push-badges.yml` -. Enter FAS password and https://docs.pagure.org/infra-docs/sysadmin-guide/sops/2-factor.html[2FA token] -. Once finished, ensure badge is now publicly visible (i.e. `https://badges.fedoraproject.org/pngs/.png`) - -=== Add automatically-awarded badges - -_Note_: Pay close attention when following these steps. -It is easy to create a badge, but much harder to edit it later. -Double-check information is entered correctly in the YAML file on first go, or else you have to write SQL statements to fix it later. - -Automatically awarded badges are created by the YAML rule file. -Once the Ansible playbook finishes, the badge is created and placed in the https://badges.fedoraproject.org/explore/badges[badges index]. -The only part _not_ created automatically are tags (see xref:badge-metadata[Badge metadata] below for info about tags). -To add new tags, find the badge on https://badges.fedoraproject.org/[badges.fedoraproject.org]. -If you are logged in as an admin, there is a text field to enter in new tags. - -=== Add manually-awarded badges - -_Note_: Pay close attention when following these steps. -It is easy to create a badge, but much harder to edit it later. -Double-check information is entered correctly on first go, or else you have to write SQL statements to fix it later. - -Once the badge assets are pushed to the back-end, add the badge to the front-end, [.title-ref]#Tahrir#. -The front-end is hosted at https://badges.fedoraproject.org/[badges.fedoraproject.org]. -Follow these steps to add the badge in Tahrir. - -. Open _Admin_ interface on https://badges.fedoraproject.org/[badges.fedoraproject.org] -. Go to the _Add badge_ section. -. Enter in all information as provided in the badge ticket (see xref:badge-metadata[Badge metadata] below.) -. Double-check all entered information is *correct and accurate* -. Click _Create badge_ to create new badge - -The badge is now created. -You should be able to find in the https://badges.fedoraproject.org/explore/badges[badges index]. - -==== Grant authorizations - -Manually-awarded badges require authorized users to issue a badge. -You can do this at the bottom of the _Admin_ interface, near _Create Authorizations_. -Add the person to receive awarding privileges into the _Person Email_ field. -*This must be formatted as their fedoraproject.org email address* (e.g. FASuser [at] fedoraproject [dot] org). -For badge name, use the slug (or badge name) from the URL of the badge (e.g. for https://badges.fedoraproject.org/badge/commops-superstar[badges.fedoraproject.org/badge/commops-superstar], this is `commops-superstar`). - -To add multiple users, repeat this process for each user. - -[[badge-metadata]] -=== Badge metadata - -* *Name*: name of the badge – this determines URL of badge, so triple-check for typos -* *Image*: full link to the PNG (e.g. `https://badges.fedoraproject.org/pngs/all-lowercase-dashes-only.png`) -* *Description*: badge description text (ensure there is _no_ hanging whitespace) -* *Criteria*: link to the issue in https://pagure.io/fedora-badges[fedora-badges] -* *Issuer*: keep the default -* *Tags*: comma-delimited list of tags: -** *Review other similar badges to ensure tags are correct.* - Some tags are special and function as categories. -** *Follow past precedent* for tags. - Avoid creating new tags if at all possible. -** Removing tags _is not_ easy. - Adding them later _is_ easy. - -==== Close out the ticket - -After pushing the badge, do some last checks to make sure the badge pushed correctly. -Make sure the page is viewable and double-check that it is categorized correctly in the https://badges.fedoraproject.org/explore/badges[badges index]. - -Return to the Pagure issue for the badge. -Post a link to the pushed badge. -If you granted authorizations, list the FAS usernames you granted authorizations to. -After commenting, closing the issue as *pushed*. - -Congratulations, you just pushed your very own Fedora Badge! - - -== How to manually award a badge - -To perform this, you must be in the `sysadmin-badges` FAS group. - -There is a script installed on `badges-backend01` in `/usr/local/bin/award-badge`. -It has help options that you can pull up with `award-badge -h`. -It takes a required `--user FAS_USERNAME` and a required `--badge BADGE_ID` option. -For example, the following invocation would award the "Associate Editor" badge to "ralph": - -[source,bash] ----- -sudo /usr/local/bin/award-badge --user ralph --badge associate-editor ----- - -The `BADGE_ID` for a badge can be found by visiting its page on the web UI. -That badge can be found at `https://badges.fedoraproject.org/badge/associate-editor`. - -The `award-badge` script and source code is managed by ansible.git. -The source code is in https://infrastructure.fedoraproject.org/cgit/ansible.git/tree/roles/badges/backend/files/award-badge[roles/badges/backend/files/award-badge]. - -Often enough, there is need for a workflow to batch award a badge to a number of people. -For instance, the _Keepin' Fedora Beautiful_ badge comes from a member of the Design Team posting a ticket with a list of FAS usernames (i.e. https://pagure.io/fedora-badges/issue/129[fedora-badges#129]). - -For cases, like that you can `wget` the file with the list of FAS usernames on `badges-backend01` and run something like: - -[source,bash] ----- -$ for i in $(cat keepingbeautiful-list ) ; do - sudo /usr/local/bin/award-badge --user $i --badge keepin-fedora-beautiful-f20; -done ----- - - -[[manually-revoke-badge]] -== How to manually revoke a badge or authorization - -You may revoke badge or badge authorizations in a similar fashion to the `award-badges` script. -You may chain the invocation of the `revoke-badge` or `revoke-authorization` script in the same manner as the `award-badges` script. - -.Revoking a badge: -[source,bash] ----- -sudo /usr/local/bin/revoke-badge --user ralph --badge associate-editor ----- - -.Revoking an authorization: -[source,bash] ----- -sudo /usr/local/bin/revoke-authorization --user ralph --badge associate-editor ----- - - -[[add-tahrir-admins]] -== How to add admins to Tahrir - -It would be nice if we could automatically grant admin access in the web interface to members of the `sysadmin-badges` FAS group. -We currently do not have this feature and must maintain the list of web UI admins separately. - -The configuration file for the badges front-end web app is managed by ansible.git. -The source code is in https://infrastructure.fedoraproject.org/cgit/ansible.git/tree/roles/badges/frontend/templates/tahrir.ini[roles/badges/frontend/templates/tahrir.ini]. - -In that file, find the `tahrir.admin` option. -It is a comma-separated list of email addresses that, when logged in, should be granted rights to access the admin panels at https://badges.fedoraproject.org/[badges.fedoraproject.org]. - -To add a new admin, add their `FAS_USERNAME@fedoraproject.org` email to that line, commit, and push. -Use Ansible to run the `groups/badges-web.yml` playbook to push the config change out to the web front-end nodes. - - -== How to create an invitation and QR code - -This is done through the admin panel of the web interface (although we can probably write a script for it to be used on the back-end node). - -Invitations / QR codes are typically created for Fedora events. -For instance at the Flock 2013 Fedora Contributors conference, we created a badge to award attendees. -We followed the procedure below to generate an invitation and a QR code. -Next, the QR code was distributed to conference organizers. -They added the QR code to the program brochure that each attendee was given. -Then, any attendee that scanned the code was redirected on their phone to the badges app, where they were awarded the badge. - -=== Create an invitation - -. Make sure you are an admin in the web interface and logged into https://badges.fedoraproject.org/[badges.fedoraproject.org] -. Click the _Admin_ link in the UI -. Under the _Invitations_ section, add this information: -** *Creation Date*: Optional. - It defaults to the current date. -** *Expiration Date*: Optional, but you probably want to specify one. - It defaults to 2 hours from the current time. - For instance, at the Flock 2013 conference, we set the expiration date at the end of the conference. - Anyone who tried to claim the badge with the QR code after that time would be denied, with the message _this invitation is expired_. -** *Badge ID*: "ID" of the badge you want to award. - See the xref:manually-revoke-badge[section above] for how to find a badge ID. -** *Person email*: Email of a person in the badges database. - In our case, use their Fedora email (e.g. `FAS_USERNAME@fedoraproject.org`). - -Now, the user you specified will have a link to the QR code and invite link on their profile page. -They can take initiative to distribute and share the badge as they wish. - - -== Useful scripts for manual work - -See `ansible/roles/badges/backend/files/` for the motherload. -These all get deployed to `/usr/local/bin/` on `badges-backend01` where you can login to execute them. - -*edit-badge*:: - Update the description and the criteria link for a badge. - Useful in the event you created it incorrectly, or if feedback from other stakeholders requires us to change something. -*award-badge*:: - Award a badge to a specific user. -*revoke-badge*:: - Removes a badge from a user to whom it has been awarded erroneously. - *Remember!* If you revoke a badge award from a user, you should also give them the `consolation-prize` badge as a token of apology. -*grant-authorization*:: - Grant authorization rights on a badge to a privileged user. - They can then create invitation links and QR codes for that badge as well as award it directly to other users from the web interface. -*revoke-authorization*:: - Revoke those authorization rights for a user on a given badge. - - -== Contact information - -Owner::: - Fedora Badges community - -Contact::: - #fedora-badges - -Servers::: - badges-web0*, badges-backend0* - -Purpose::: - Award "badges" to Fedora Contributors From 8b9e44fec5c09b79215184885fd6dfbb420b8c16 Mon Sep 17 00:00:00 2001 From: Jean-Baptiste Holcroft Date: Jul 15 2020 11:16:21 +0000 Subject: [PATCH 2/2] tell where is the new git repository for docs --- diff --git a/README.md b/README.md index b59b753..5c6f5c9 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Here, you can… * Submit new badge ideas * Contribute badge designs and artwork -* Add or change documentation on [docs.fedoraproject.org/en-US/badges/](https://docs.fedoraproject.org/en-US/badges/ "Fedora Badges :: Fedora Docs") +* To change documentation on [docs.fedoraproject.org/en-US/badges/](https://docs.fedoraproject.org/en-US/badges/ "Fedora Badges :: Fedora Docs"), open https://pagure.io/fedora-badges/docs ### How do I get involved with the Fedora Badges community?