Commit f3d952cc authored by Christian Meeßen's avatar Christian Meeßen Committed by Uwe Jandt (DESY, HIFIS)
Browse files

Adds instructions how to add a Software Spotlight

parent 3de05462
......@@ -17,9 +17,9 @@ and get feedback regarding how to improve its appearance and content.
Note:
In case you are just interested to know how to contribute with a
blog post to _HIFIS Software_ web-page you can find a
blog post to _HIFIS Software_ web-page you can find a
[blog post]({% post_url 2019/11/2019-11-22-How-to-Create-a-new-Blog-Post %} "How to Create a New Blog Post?")
explaining the suggested workflow in the blog post section
explaining the suggested workflow in the blog post section
of the web-page.
## Contribution Workflow
......@@ -79,17 +79,17 @@ so the others know you want to have it reviewed.
Please feel free to use GitLab's _Review Apps_ functionality to
view and test your branch.
It is an easy way to inspect your changes in a test / staging
It is an easy way to inspect your changes in a test / staging
environment as well as involve external reviewers into the project.
When pushing your branch onto the remote repository your branch is
automatically deployed to _Review Apps_.
You can preview your latest deployments of your branch
by clicking the button _View app_ in the User-Interface of your
by clicking the button _View app_ in the User-Interface of your
Merge Request.
Alternatively, for branch _master_ you can open the _External URL_
in your browser by yourself:
`https://hifis-review-app.hzdr.de/review-apps/hifis-software-hifis-net/`.
(The automatically generated _External URLs_ for all other
(The automatically generated _External URLs_ for all other
branches contain an additional sequence of numbers, lower case
letters and dashes as an URL-friendly replacement of the branch
name given.)
......@@ -104,8 +104,8 @@ successfully after pushing your changes to the remote repository,
otherwise the changes to your branch will not yet be deployed to
_Review Apps_ as a new version.
After opening a _Merge Request_ discuss the changes suggested by your
reviewers in dedicated discussion threads in GitLab and agree upon
After opening a _Merge Request_ discuss the changes suggested by your
reviewers in dedicated discussion threads in GitLab and agree upon
how to integrate these suggestions into your code to improve your
developments.
......@@ -167,12 +167,12 @@ checking for you.
Here comes the time saving into play.
| Static Code Analysis Tool | Language to Check |
|---|---|
| markdownlint | Markdown |
| HTML-Proofer | HTML|
| CSSLint | CSS |
| JSHint | JavaScript |
| Rubocop | Ruby |
| ------------------------- | ----------------- |
| markdownlint | Markdown |
| HTML-Proofer | HTML |
| CSSLint | CSS |
| JSHint | JavaScript |
| Rubocop | Ruby |
#### markdownlint
......@@ -297,7 +297,50 @@ instead of
```HTML
<html>
<!-- This is an HTML comment. It will be preserved and show up in the
<!-- This is an HTML comment. It will be preserved and show up in the
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.
......@@ -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>
......
......@@ -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)
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment