Merge pull request #4 from research-software-directory/kin-demo

KIN demo online

CODE_OF_CONDUCT.md

@@ -0,0 +1,132 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behaviour that contributes to a positive environment for our
+community include:
+
+- Demonstrating empathy and kindness toward other people
+- Being respectful of differing opinions, viewpoints, and experiences
+- Giving and gracefully accepting constructive feedback
+- Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+- Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behaviour include:
+
+- The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+- Trolling, insulting or derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behaviour and will take appropriate and fair corrective action in
+response to any behaviour that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behaviour may be
+reported to the community leaders responsible for enforcement at
+rsd@esciencecenter.nl.
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behaviour deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behaviour was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behaviour. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behaviour.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behaviour, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

CONTRIBUTING.md

@@ -0,0 +1,74 @@
+# Contributing to the KIN Research Project Directory
+
+:+1::tada: First off, thanks for taking the time to contribute! :tada::+1:
+
+The following is a set of guidelines for contributing to the Research Project Directory (as a Service), which is hosted on [GitHub](https://github.com/research-software-directory/KIN-RPD).
+These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document.
+We welcome any kind of contribution to our software, from simple comments or questions to a full fledged [pull request](https://help.github.com/articles/about-pull-requests/).
+
+## Code of conduct
+
+Help us keep the Research Project Directory open and inclusive. Please read and follow our [Code of Conduct](https://github.com/research-software-directory/KIN-RPD/blob/main/CODE_OF_CONDUCT.md).
+
+## How to contribute
+
+A contribution can be one of the following cases:
+
+1. you have a question, suggestion, comment, etc.;
+1. you have found a bug (including unexpected behavior, errors in documentation, etc.)
+1. you want to request a feature;
+1. you want to make some kind of change to the code base yourself (e.g. to fix a bug, to add a new feature, to update documentation).
+1. you wish to contribute in some other way.
+
+The sections below outline the steps in each case.
+
+## You have a question, suggestion, comment, etc.
+
+For general questions (not directly related to the development of the software) you can send an email to rsd@esciencecenter.nl. Alternatively, you can also submit an issue:
+
+1. use the search functionality [here](https://github.com/research-software-directory/KIN-RPD/issues) to see if someone already filed the same issue;
+1. if you find a similar issue, you can add your own comments to this issue;
+1. if your issue search did not yield any relevant results, make a new issue;
+1. apply the "question" label; apply other labels when relevant.
+
+## You have found a bug
+
+If you find a bug or experience unexpected behaviour, you can submit an issue:
+
+1. use the search functionality [here](https://github.com/research-software-directory/KIN-RPD/issues) to see if someone already filed the same issue;
+1. if you find a similar issue, you can add your own comments to this issue;
+1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the cause and context of the problem. Depending on the issue and your technical expertise, you may want to include:
+   - the [SHA hashcode](https://help.github.com/articles/autolinked-references-and-urls/#commit-shas) of the commit that is causing your problem;
+   - some identifying information (name and version number) for the version you're using;
+   - information about the operating system and browser you are using;
+1. apply the "bug" label; apply other labels when relevant.
+
+## You want to request a feature
+
+To request a feature you can submit an issue on GitHub. Please keep in mind that our development resources are limited, so we may not be able to honor your request.
+
+1. use the search functionality [here](https://github.com/research-software-directory/KIN-RPD/issues) to see if someone already filed the same issue;
+1. if you find a similar issue, you can add your own comments and suggestions to this issue (having more people request the same feature may increase its priority);
+1. if your issue search did not yield any relevant results, make a new issue, making sure to provide enough information to the rest of the community to understand the feature you are requesting. We may get back to you with further questions.
+1. apply the "feature" label; apply other labels when relevant.
+
+## You want to make some kind of change to the code base youself
+
+Contributions to the code base are very welcome. Keep in mind, however, that this also requires a good interaction with the community to ensure that your contribution is adopted.
+
+1. (**important**) announce your plan to the rest of the community _before you start working_. This announcement should be in the form of a (new) issue;
+1. (**important**) wait until some kind of concensus is reached about your idea being a good idea;
+1. (**important**) we are applying the [REUSE specification](https://reuse.software/) in order to keep track of copyright and licenses in this repository. See the [section below](#license-and-copyright-information-according-to-the-reuse-specification) for an example. We run a REUSE linter job upon every pull request to make sure all files have at least license information attached. To automate the task of adding REUSE compliant headers you can optionally use our [pre-commit hook template](#automatically-updating-headers-using-a-pre-commit-hook).
+1. if needed, fork the repository to your own Github profile and create your own feature branch off of the latest master commit. While working on your feature branch, make sure to stay up to date with the master branch by pulling in changes, possibly from the 'upstream' repository (follow the instructions [here](https://help.github.com/articles/configuring-a-remote-for-a-fork/) and [here](https://help.github.com/articles/syncing-a-fork/));
+1. make sure the existing unit tests still work;
+1. make sure that the existing integration tests still work;
+1. add your own unit tests and integration tests (if necessary);
+1. update or expand the documentation;
+1. [push](http://rogerdudler.github.io/git-guide/) your feature branch to (your fork of) the repository on GitHub;
+1. create a pull request, e.g. following the instructions [here](https://help.github.com/articles/creating-a-pull-request/).
+
+In case you feel like you've made a valuable contribution, but you don't know how to write or run tests for it, or how to generate the documentation: don't let this discourage you from making the pull request; we can help you! Just go ahead and submit the pull request, but keep in mind that you might be asked to append additional commits to your pull request (have a look at some of our old pull requests to see how this works).
+
+## You want to contribute in some other way
+
+Contributions to the code are by no means the only way to contribute to the Research Project Directory. If you wish to contribute in some other way, please contact us at rsd@esciencecenter.nl.

README.md

@@ -1,3 +1,7 @@
 # KIN-RPD
 
-Research Project Directory for KIN
+Research Project Directory (RPD) for KIN.
+
+KIN RPD is modified version of [Research Software Directory](https://github.com/research-software-directory/RSD-as-a-service).
+
+KIN RPD focus is on Research Projects of [KIN](https://hetkin.nl/en/home-en/)

deployment/README.md

@@ -59,3 +59,16 @@ In the provided `docker-compose.yml` file we define a volume where the database
 The internal docker network is also defined.
 
 You can use volume mount in the frontend image to provide custom settings that will overwrite default theme and styles.
+
+## Update KIN-RPD images
+
+The current approach uses `latest` tag for the kin-rpd images. You can then pull new version and restart the services.
+
+```bash
+# pull images
+docker compose pull
+# restart containers
+docker compose up --detach --remove-orphans
+# optionally remove obsolete images
+docker image prune
+```

frontend/components/AppFooter/OrganisationLogo.tsx

@@ -8,31 +8,24 @@ import LogoAvatar from '../layout/LogoAvatar'
 
 
 export default function OrganisationLogo({host}: { host: RsdHost }) {
-
   if (host?.logo_url && host?.website) {
     const {name,logo_url,website}=host
     return (
-      <div className="flex items-center">
-        <a href={website} target="_blank" rel="noreferrer">
-          <LogoAvatar
-            name={name}
-            src={logo_url}
-          />
-        </a>
-      </div>
+      <a href={website} target="_blank" rel="noreferrer">
+        <LogoAvatar
+          name={name}
+          src={logo_url}
+        />
+      </a>
     )
   }
   if (host?.logo_url) {
     const {name,logo_url}=host
     return (
-      <div className="flex items-center">
-        <span>
-          <LogoAvatar
-            name={name}
-            src={logo_url}
-          />
-        </span>
-      </div>
+      <LogoAvatar
+        name={name}
+        src={logo_url}
+      />
     )
   }
   return null