Skip to content
Snippets Groups Projects
Commit dce354cf authored by Christian Meeßen's avatar Christian Meeßen Committed by Uwe Jandt (DESY, HIFIS)
Browse files

Removes spotlight instructions

parent 4546976e
Branches
No related tags found
1 merge request!856Removes spotlight instructions
......@@ -301,47 +301,3 @@ 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
Before you start, please make sure to add only one Spotlight per Merge Request.
1. If you are not a member of the [hifis.net repository](https://codebase.helmholtz.cloud/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://codebase.helmholtz.cloud/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://codebase.helmholtz.cloud/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://codebase.helmholtz.cloud/hifis/overall/hifis.net)).
11. Create a new Merge Request. Below the title of the merge request, you will see a drop down list title "Description". Please choose `add_new_software_spotlight` as a template. The text field below will fill with some text and instructions that will help you creating the merge request.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment