From 3aa8879d64b10f489f3469e725dcdf04deed4b36 Mon Sep 17 00:00:00 2001 From: "Uwe Jandt (DESY)" <uwe.jandt@desy.de> Date: Thu, 3 Dec 2020 16:52:25 +0100 Subject: [PATCH] reshuffle 4 buttons --- .gitlab/ci/a11y.gitlab-ci.yml | 2 +- _includes/frontpage/title-content.html | 14 +- .../index.md | 0 services/consulting.html | 121 ++++++++++++++++++ services/index.md | 18 +++ services/training.md | 78 +++++++++++ 6 files changed, 225 insertions(+), 8 deletions(-) rename {you-and-hifis => hifis-services-for-you}/index.md (100%) create mode 100644 services/consulting.html create mode 100644 services/index.md create mode 100644 services/training.md diff --git a/.gitlab/ci/a11y.gitlab-ci.yml b/.gitlab/ci/a11y.gitlab-ci.yml index 7aaa14a84..f7de8ca3c 100644 --- a/.gitlab/ci/a11y.gitlab-ci.yml +++ b/.gitlab/ci/a11y.gitlab-ci.yml @@ -8,7 +8,7 @@ variables: https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/partners https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/team https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/cloud-platform - https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/you-and-hifis + https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/hifis-services-for-you https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/contact https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/publications https://$APPS_DOMAIN/review-apps/$CI_PROJECT_PATH_SLUG/$CI_COMMIT_REF_SLUG/faq diff --git a/_includes/frontpage/title-content.html b/_includes/frontpage/title-content.html index a73ff1748..6145f0c18 100644 --- a/_includes/frontpage/title-content.html +++ b/_includes/frontpage/title-content.html @@ -4,17 +4,17 @@ </div> <div class="services-box"> <div class="services-title-buttons"> - <a href="{{ '/cloud-platform.html' | relative_url }}" class="btn btn-light btn-lg text-dark"> - <i class="fas fa-cloud"></i> Helmholtz Cloud + <a href="{{ '/hifis-services-for-you' | relative_url }}" class="btn btn-light btn-lg text-dark"> + <i class="fas fa-user-plus"></i> HIFIS Services for you </a> - <a href="https://software.hifis.net" class="btn btn-light btn-lg text-dark"> - <i class="fas fa-laptop-code"></i> Helmholtz Software + <a href="{{ '/services/training' | relative_url }}" class="btn btn-light btn-lg text-dark"> + <i class="fas fa-university"></i> Education & Training </a> - <a href="{{ '/you-and-hifis' | relative_url }}" class="btn btn-light btn-lg text-dark"> - <i class="fas fa-user-plus"></i> HIFIS for you + <a href="https://login.helmholtz.de/oauth2-as/oauth2-authz-web-entry" class="btn btn-light btn-lg text-dark"> + <i class="fas fa-cloud"></i> Helmholtz Cloud (login) </a> <a href="{{ '/contact.html' | relative_url }}" class="btn btn-light btn-lg text-dark"> - <i class="fas fa-question"></i> Support + Contact + <i class="fas fa-question"></i> Consulting, Support & Contact </a> </div> </div> diff --git a/you-and-hifis/index.md b/hifis-services-for-you/index.md similarity index 100% rename from you-and-hifis/index.md rename to hifis-services-for-you/index.md diff --git a/services/consulting.html b/services/consulting.html new file mode 100644 index 000000000..9a724075d --- /dev/null +++ b/services/consulting.html @@ -0,0 +1,121 @@ +--- +title: Consulting +title_image: jamie-street-_94HLr_QXo8-unsplash.jpg +layout: services/default +author: none +additional_css: + - services/consulting-iframe.css + - services/consulting-help-images.css +excerpt: >- + HIFIS offers free-of-charge consulting as a service + to research groups under the Helmholtz umbrella. + We can help you to deal with specific licensing issues, + pointing out solutions on how to improve your software or + setting up a new projects. We are also very happy to discuss + other software engineering topics such as software engineering + process in general. +--- + +<p> + HIFIS offers free-of-charge consulting as a service + to research groups under the Helmholtz umbrella. + We can help you to deal with specific licensing issues, + pointing out solutions on how to improve your software or + setting up a new projects. We are also very happy to discuss + other software engineering topics such as software engineering + process in general. + + Be aware that we are a small team that tries to help as + many researchers and research groups as possible. + Therefore we have to limit our total work time on each + request to one week with a maximum of up to two weeks. + Depending on the request type the processing might take + a bit longer. We try to setup an initial meeting as early + as possible. +</p> + +<h1>The Consultation Process</h1> + +<div class="image-block"> + <img + class="help-image left" + alt="Someone holding out a form having filled out the first part" + src="{{ site.directory.images | relative_url }}/services/undraw_fill_forms_yltj.svg" + /> + <div> + <h3>1. First Contact</h3> + <p> + Step one: talk to us! + Fill out the form at the bottom of this page — + our dedicated team will direct that request to a consultant with knowledge and expertise in the areas related to your project. + </p> + </div> +</div> + +<div class="image-block"> + <img + class="help-image right" + alt="A group of people sitting in a conference call" + src="{{ site.directory.images | relative_url }}/services/undraw_conference_call_b0w6.svg" + /> + <div> + <h3>2. Let's Talk!</h3> + <p> + Our consultant will work with you and your team to help specify the problem, + and identify a plan of action that you can take to solve the issue. + We work with your research expertise and understanding of the project, + and our wealth of software engineering experience + to find the best solution for you to be able to maintain throughout your project's lifespan. + </p> + </div> +</div> + +<div class="image-block"> + <img + class="help-image left" + alt="Two people standing either side of a board containing goals to be completed" + src="{{ site.directory.images | relative_url }}/services/undraw_team_goals_hrii.svg" + /> + <div> + <h3>3. Let's Go!</h3> + <p> + Our consultations don't end after the first meeting — + we provide ongoing support to help you with your project. + We can provide tool and software recommendations, + run training sessions, + setup template projects, + and much more. + </p> + </div> +</div> + +<div class="image-block"> + <img + class="help-image right" + alt="Two people shaking hands in an office" + src="{{ site.directory.images | relative_url }}/services/undraw_finish_line_katerina_limpitsouni_xy20.svg" + /> + <div> + <h3>4. Conclusion</h3> + <p> + All good things must come to an end, + but our aim is to leave you more equipped and prepared at the end of the consultation process, + so that you can maintain and support your project for as long as you need to. + </p> + </div> +</div> + +<div class="image-attrib">Images by Katerina Limpitsouni via <a href="https://undraw.co/">undraw.co</a></div> + +<h1>Getting Started</h1> + +<p> + You can request a new consultation by using the link below. + Alternatively, if you want to discuss using other services that the HIFIS team offers, feel free to email + <a href="mailto:{{site.contact_mail}}">{{site.contact_mail}}</a> + directly. +</p> + +<p id="consultation-request-form"> + {% include contact_us/mini-form.html %} +</p> diff --git a/services/index.md b/services/index.md new file mode 100644 index 000000000..c6c3bdc0d --- /dev/null +++ b/services/index.md @@ -0,0 +1,18 @@ +--- +title: Services +title_image: default +layout: services/index +author: none +additional_css: + - services/custom.css + - title/service-title-buttons.css +excerpt: + "The service portfolio of HIFIS Software is structured into 4 different + components that seamlessly interoperate with each other: Education & + Training, Technology, Consulting and Community Services." +--- +{% comment %} + This markdown file triggers the generation of the services page. + Only the frontmatter is required by Jekyll. + The contents section does not get rendered into HTML on purpose. +{% endcomment %} diff --git a/services/training.md b/services/training.md new file mode 100644 index 000000000..fe768aa35 --- /dev/null +++ b/services/training.md @@ -0,0 +1,78 @@ +--- +title: Education & Training +title_image: default +layout: services/default +author: none +additional_css: + - title/service-title-buttons.css +excerpt: + "The service portfolio of HIFIS Software is structured into 4 different + components that seamlessly interoperate with each other: Education & + Training, Technology, Consulting and Community Services." +--- + +The purpose of the Education & Training component is to offer courses, materials, and workshops to help you in getting started, or to boost your engineering practices. +On this page, you can find upcoming workshops on a range of topics, as well as external resources to help you get started. + +Can't find exactly what you're looking for? Talk to us directly: +{% include contact_us/mini.html %} +{% include helpdesk/mini.html %} + +# Upcoming Workshops + +{% assign events = site.events | where: "type", "workshop" %} +{% include events/upcoming_events_list.html events=events limit=3 %} + +Looking for something more specific? +Request a workshop or talk to us: +{% include contact_us/mini.html %} +{% include helpdesk/mini.html %} + +# External Resources + +These articles are written by third party organisations, and they aren't necessarily focussed on research software development, but they represent a set of industry best practices for writing software, sharing code, and building software communities. +We've brought these together here to try and answer some common questions that researchers often ask us. + +### How Do I Share My Project? + +* **Licensing** - + Open source projects need an open source license - but how do I do that, and what license should I use? + For a simple way to get started, try [Choose A License][choose-a-license], and for a more in-depth guide to creating open source projects, try [The Open Source Guide][open-source-guide/legal]. +* **Citations** - + It's important to prepare software projects for citation as part of sustainable research software development. + Simple ways to both prepare for citation, and cite other researchers' software, are described at this [Research Software Citation][research-software/citation] guide. +* **Documentation** - + Writing good documentation can be hard, but Write the Docs have put together a [Beginner's Guide to Writing Documentation][write-the-docs/beginners-guide], starting with a single README file. + +If you're just starting out with this topic, and you have some code you want to make ready for publication/open source sharing, we run regular workshops where we can help you with all of these topics. +Click to [**see all our workshops**][internal/events] and find out more. + +[choose-a-license]: <https://choosealicense.com/> +[open-source-guide/legal]: <https://opensource.guide/legal/> +[research-software/citation]: <https://research-software.org/citation> +[write-the-docs/beginners-guide]: <https://www.writethedocs.org/guide/writing/beginners-guide-to-docs/> +[internal/events]: {% link events.md %} + +### What Are Best Practices for Research Software? + +* **Ethical Software** - + Ethical research practices should also be visible in how we write research software. + [The Turing Way][turing-way] is a guide to these best practices in data science, particularly reproducibility. +* **Software Layout** - + Common patterns for software aim to make it as easy as possible for reviewers or new team members to understand how a project works. + One pattern is using common project folder layouts. The [Cookiecutter Data Science][cookiecutter-data-science] project provides a way to get started quickly on new data science projects in a manner that other people will be able to recognise and understand. +* **Committing** - + Reading through commits in a shared project can be a valuable way of understanding changes that you or other people have made, and figuring out when a bug appeared. + [How to Write a Git Commit Message][git-commit-message] explains how to describe the contents of a commit in a clean and readable way. + Also, as a deep read, try [My favourite Git commit][my-favourite-commit]. + +[turing-way]: <https://the-turing-way.netlify.app/> +[cookiecutter-data-science]: <https://drivendata.github.io/cookiecutter-data-science/> +[git-commit-message]: <https://chris.beams.io/posts/git-commit/> +[my-favourite-commit]: <https://dhwthompson.com/2019/my-favourite-git-commit> + +### Still Got Questions? + +Let us know where you feel you need more support, what other questions you want answered, and what articles you'd find helpful: +{% include contact_us/mini.html %} +{% include helpdesk/mini.html %} -- GitLab