Merge branch 'contributing_spotlights' into 'master'

Adds instructions how to add a Software Spotlight

See merge request !432

CONTRIBUTING.md

@@ -167,7 +167,7 @@ checking for you.
 Here comes the time saving into play.
 
 | Static Code Analysis Tool | Language to Check |
-|---|---|
+| ------------------------- | ----------------- |
 | markdownlint              | Markdown          |
 | HTML-Proofer              | HTML              |
 | CSSLint                   | CSS               |
@@ -301,3 +301,46 @@ instead of
     rendered page, cluttering and bloating the delivered code. -->
 </html>
 ```
+
+## Adding Software Spotlights
+
+If you want to add a Software Spotlight, you need to prepare the following
+content:
+
+* A preview image, preferrably a logo
+* An excerpt that will be shown in the list, between about 150 to 300
+  characters long
+* An explanatory paragraph that briefly explains what the software is made for,
+  who made it, who are the users, etc.
+
+### Workflow
+
+1. If you are not a member of the [hifis.net repository](https://gitlab.hzdr.de/hifis/overall/hifis.net), create a fork of it in your own space.
+2. Clone the repository to your local computer and follow the instructions
+   in the [README.md](https://gitlab.hzdr.de/hifis/overall/hifis.net/-/blob/master/README.md)
+   to get your local instance up and running.
+3. Create a branch for your spotlight.
+4. Navigate to `/_spotlights`.
+5. Create a copy of [`_template.md`](https://gitlab.hzdr.de/hifis/overall/hifis.net/-/blob/master/_spotlights/_template.md)
+   and name it after your software. The markdown file consists of two sections.
+   It has a yaml header which is used to configure the list view on
+   [hifis.net/spotlights](https://hifis.net/spotlights) as well as the green
+   info box on the spotlight's page. The second section is pure markdown, and
+   this is where the descriptive text goes. **If you insert images into the
+   paragraph section, please make sure to use the example code from the
+   template**.
+7. Follow the instructions inside the markdown file and add as much information
+   as possible.
+8. Please use the official [SPDX identifier](https://spdx.org/licenses/) for
+   licenses.
+9. Please use the following paths for different images:
+
+   | Image Type                 | Path                                          |
+   | -------------------------- | --------------------------------------------- |
+   | Preview image              | `/assets/img/spotlights/<name_of_spotlight>/` |
+   | Jumbotron                  | `/assets/img/jumbotrons/`                     |
+   | Any image in the paragraph | `/assets/img/spotlights/<name_of_spotlight>/` |
+
+10. Push your changes to GitLab (either your repo, or a [branch in hifis.net](https://gitlab.hzdr.de/hifis/overall/hifis.net)).
+11. Create a Merge Request and mention @frust45, @konrad, @christian.meessen and
+   @jandt-desy.

_includes/footer.html

@@ -16,7 +16,7 @@
         </a>
 
         <nav>
-            <a href="{{ site.gitlab.project_url }}/blob/master/CONTRIBUTING.md" class="btn btn-primary">
+            <a href="{% link CONTRIBUTING.md %}" class="btn btn-primary">
                 Contribute&nbsp;on&nbsp;
                 <i class="fab fa-gitlab" aria-hidden="true"></i>
             </a>

_spotlights/_template.md

@@ -70,7 +70,7 @@ platforms:
     - type:
       link_as:
 
-# The software license (optional)
+# The software license, please use an SPDX Identifier (https://spdx.org/licenses/) if possible (optional)
 license:
 
 # Is the software pricey or free? (optional)