Merge pull request #9 from research-software-directory/985-faq

docs: add FAQ

.gitignore

@@ -7,3 +7,4 @@ node_modules
 .temp
 .cache
 dist
+.idea

docs/adding-projects.md

@@ -59,7 +59,7 @@ In the top right corner of the page, you can find a **"View page"** link, which
 
 ![image](/view-and-publish.gif)
 
-The **"Published** slider can be use to make the page public once you are satisfied with the result.
+The **"Published** slider can be used to make the page public once you are satisfied with the result.
 
 To return to editing the page use the ![image](/edit-page.gif) link in the top right.
 
@@ -79,7 +79,7 @@ You can correct the available information and add any missing fields before addi
 project. Therefore, you can safely change information about this person without having an effect on any other project the person is involved in.
 
 ::: danger
-When manually adding team members or adding images or email adresses of persons, please ensure you have **persmission** to share this information!
+When manually adding team members or adding images or email addresses of persons, please ensure you have **permission** to share this information!
 :::
 
 ## Contributing Organisations

docs/adding-software.md

@@ -14,7 +14,7 @@ After signing in, you can use the __"+"__ button next to your avatar icon on the
 ![image](/plus-software-projects.gif)
 
 To create a new software page, you must provide a name for your software and a short description of what it does. Once you click "save" the RSD will use this information to
-initialize a new empty software page. This software page is not be public yet to give you some time to provide additional information.
+initialize a new empty software page. This software page is not public yet to give you some time to provide additional information.
 
 Next, you can add additional information in the 7 sections explained below.
 
@@ -23,7 +23,7 @@ Next, you can add additional information in the 7 sections explained below.
 In this section you can provide the basic information about the software:
 
 - A **Getting started URL** which refers to webpage with more information about the software. This is shown as the "getting started" button on the software page.
-- A **Source code repository URL** of the software. This link will show up as a repository icon on the software page and will be used to harvest information about the software development activity, which will be shown as a graph. At the moment we support [github](), [gitlab]() and have limited support for [bitbucket]().
+- A **Source code repository URL** of the software. This link will show up as a repository icon on the software page and will be used to harvest information about the software development activity, which will be shown as a graph. At the moment we support [GitHub](https://github.com/), [GitLab](https://about.gitlab.com/) and have limited support for [Bitbucket](https://bitbucket.org/product/).
 - A more extensive **Description** of the software, which will be shown on the software page. You can use markdown to write this description, or import an existing markdown file from the web.
 - A **concept DOI** for the archived releases of the software. This concept DOI will be used to automatically detect new releases of your software, and generate the block with citation information shown on the software page. You can find more information on concept DOIs and how to create them [here]().
 - *Keyword*s describing the software. These will be shown in the sidebar of the software page. If you have provided a concept DOI, the keywords can also be imported from the archive metadata.
@@ -52,7 +52,7 @@ organisations already registered in the RSD or in the [ROR](https://ROR.org) dat
 ## Mentions
 
 This section allows you to add mentions to your software page. You can use this to list publications, presentations, videos, blogs, etc. that prominently feature your software, or the results produced by your software.
-To add a mention, you can use the search bar below "Find publication" to search for a DOI or publication title in the RSD, [Crossref](https://www.crossref.org/) or [Datacite](https://datacite.org/). All the relevant data about the publication will be retrieved automatically. For publications without a DOI (typically blogs or webpages), it is also possible to manually add a mention.
+To add a mention, you can use the search bar below "Find publication" to search for a DOI or publication title in the RSD, [Crossref](https://www.crossref.org/) or [DataCite](https://datacite.org/). All the relevant data about the publication will be retrieved automatically. For publications without a DOI (typically blogs or webpages), it is also possible to manually add a mention.
 
 ![image](/mentions.gif)
 

docs/faq.md

@@ -1,3 +1,22 @@
 # Frequently Asked Questions
 
-No questions yet!
+**Why can't I see the software and projects I contributed to when I'm logged in?**<br>
+Your account is for administration purposes only, i.e., your account is for editing software, project and organisation pages to which someone gave you the rights to edit them. We are working on creating 'profile' pages where you can see all contributions made by one person, aggregated on ORCID, so make sure to add your ORCID on all your contributions.
+
+**Can I add a profile picture to my account?**<br>
+Currently not, as accounts are for administrative purposes only (see also the question above). We are considering to add this in the future. 
+
+**Why is there no citation block on my software page?**<br>
+We can harvest the citation information of all releases based on the [Zenodo concept DOI](https://help.zenodo.org/faq/#versioning) you provide to us. You can enter the concept DOI on the *Information* tab of the edit page. There is a button below the field that will check for you if the DOI you entered is a valid concept DOI, and it will propose to update your DOI if it can detect the corresponding concept DOI for the DOI you provided.
+
+**The citation block / Git activity graph / programming languages are still not visible**<br>
+These are harvested in the background. The various harvesters run every few minutes, harvesting a small part of the RSD. When you change the corresponding fields, you are usually first in line to be harvested, so check again in a few minutes.
+
+**Why can't I delete my software/project page?**<br>
+Deleting pages might have unwanted side effects, please contact us if you accidentally created a page. You can use [our development site](https://research-software.dev/), which we regularly clear, to try out all the features.
+
+**Do you have a public forum for discussions and questions?**<br>
+You can use the [GitHub discussions page](https://github.com/research-software-directory/RSD-as-a-service/discussions) for this.
+
+**Where can I request a new feature or report a bug?**<br>
+You can use the [GitHub issues page](https://github.com/research-software-directory/RSD-as-a-service/issues) for this.

docs/getting-access.md

@@ -4,7 +4,7 @@ While anyone is free to browse through the content of the RSD, you'll need to be
 Currently, there are two ways to get access:
 
 * You have an [ORCID](https://orcid.org/), and send us a request for access, or
-* Your organisation participates in [SurfConext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) and has enabled access to the RSD.
+* Your organisation participates in [SURFconext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) and has enabled access to the RSD.
 
 If you wish to add your organisation to the RSD or claim an organisation which is already listed, please have a look at how to [Register an organisation](register-organisation.md).
 
@@ -20,24 +20,24 @@ Please [contact us](mailto:[email protected]) if you wish to use ORCID to si
 * Your name.
 * Your affiliation(s).
 * Your ORCID.
-* Example links illustrating the the content you wish to add.
+* Example links illustrating the content you wish to add.
 :::
 
 We will then contact you to arrange access. Once your ORCID sign in is enabled, an RSD account is created automatically the first time you [sign in](getting-access.md#how-to-sign-in).
 
-## Getting access via SURFConext
+## Getting access via SURFconext
 
-[SurfConext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) is an identity provider for Dutch research and education institutions. It can be used by
-employees of member organisations to sign in to the RSD using their institute credentials. You can check if your organisation in on the list of [SURFConext
-members](https://support.surfconext.nl/stats/idplist.html). Before you can use SURFConext to sign in, your organisation __must enable the RSD service__ in their SURFconext
+[SURFconext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) is an identity provider for Dutch research and education institutions. It can be used by
+employees of member organisations to sign in to the RSD using their institute credentials. You can check if your organisation in on the list of [SURFconext
+members](https://support.surfconext.nl/stats/idplist.html). Before you can use SURFconext to sign in, your organisation __must enable the RSD service__ in their SURFconext
 dashboard.
 
 ::: tip
-You can check [here](https://dashboard.surfconext.nl/apps/9514/oidc10_rp/about) if your organisation has enabled the RSD service in SURFConext.
+You can check [here](https://dashboard.surfconext.nl/apps/9514/oidc10_rp/about) if your organisation has enabled the RSD service in SURFconext.
 :::
 
-If your organisation is has not enabled the RSD service yet, please contact your local SURFConext representative, and ask them to contact us via the
-[RSD administrators](mailto:[email protected]) email. In the mean time you may use the ORCID sign in described above as an alternative.
+If your organisation has not enabled the RSD service yet, please contact your local SURFconext representative, and ask them to contact us via the
+[RSD administrators](mailto:[email protected]) email. In the meantime you may use the ORCID sign in described above as an alternative.
 
 Once your organisation has enabled the RSD service in SURFConext, you should be able to sign in to the RSD using your institute credentials. An RSD account is created automatically
 the first time you [sign in](getting-access.md#how-to-sign-in).

docs/introduction.md

@@ -14,7 +14,7 @@ Research software is one of the most important scientific instruments available
 discoveries.
 
 The Research Software Directory (RSD) is a free online platform designed to showcase the impact of research software on research and society. By showing research software together with
-relevant contextual information such as scientific publications, contributors, projects, citation information and much more, we stimulate thereuse and encourage proper citation
+relevant contextual information such as scientific publications, contributors, projects, citation information and much more, we stimulate the reuse and encourage proper citation
 to ensure the researchers and RSEs developing the software get credit for their work.
 
 More information about the concepts behind the RSD can be found in this excellent
@@ -23,5 +23,5 @@ More information about the concepts behind the RSD can be found in this excellen
 ## About us
 
 The Research Software Directory was initiated in 2017 by the [Netherlands eScience Center](https://esciencecenter.nl) as a platform to showcase the research software developed at
-our center. After sucessfully using the RSD for several years, we decided in 2021 to re-engineer the platform so we can offer it as an online service to other research
+our center. After successfully using the RSD for several years, we decided in 2021 to re-engineer the platform so we can offer it as an online service to other research
 organisations. In 2022, our development effort was joined by [HIFIS](https://hifis.net/).

docs/register-organisation.md

@@ -7,7 +7,7 @@ If you wish to officially add your organisation to the RSD, or claim an organisa
 * Which organisation you represent.
 
 We will then contact you to arrange access for your organisation. Once your organisation is registered,
-this will indicated by a verification checkmark on the card of your organisation:
+this will be indicated by a verification checkmark on the card of your organisation:
 
 ![image](/example-organisation.webp)
 

docs/release.md

@@ -7,11 +7,11 @@ SPDX-License-Identifier: CC-BY-4.0
 
 # Making a release
 
-To make a new release we use github action release_manual.yml to manually release all modules at once.
+To make a new release we use GitHub action release_manual.yml to manually release all modules at once.
 
 Follow these steps to call release action.
 
-- navigate to [github actions](https://github.com/research-software-directory/RSD-as-a-service/actions)
+- navigate to [GitHub actions](https://github.com/research-software-directory/RSD-as-a-service/actions)
 - select `create release draft (manual)` action
 - on the right you select "Run workflow". Ensure "main" brand is selected and click on "Run workflow"
 
@@ -30,11 +30,11 @@ Follow these steps to call release action.
 - update citation file with new version number and release date
 - make deployment.zip file where all files needed for deployment are included
 - commit new CITATION.cff file with message 'release: update citation file'
-- create github release (draft) and include information from changelog and deployment.zip
+- create GitHub release (draft) and include information from changelog and deployment.zip
 
 ## Removing draft release
 
-If you need to remove draft release you can do that via [github interface](https://github.com/research-software-directory/RSD-as-a-service/releases)
+If you need to remove draft release you can do that via [GitHub interface](https://github.com/research-software-directory/RSD-as-a-service/releases)
 
 ## Removing tags
 

docs/sign-in.md

@@ -9,7 +9,7 @@ SPDX-License-Identifier: CC-BY-4.0
 
 Before you can add content to the RSD, you need to be able to sign in using one of the supported identity providers:
 
-* [SurfConext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials)
+* [SURFconext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials)
 * [ORCID](https://orcid.org/)
 
 More information on how to get access via these identify providers can be found in [How to get an account](getting-access.md).
@@ -22,17 +22,17 @@ To sign in to the RSD, go to the __"Sign in"__ button at the top right corner of
 
 If you sign in to the RSD for the first time, the identify provider may ask you permission to share information with the RSD.
 
-### Signing in with SURFConext
+### Signing in with SURFconext
 
-[SurfConext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) is an identity provider for Dutch research and education institutions. It can be used by
+[SURFconext](https://www.surf.nl/en/surfconext-global-access-with-1-set-of-credentials) is an identity provider for Dutch research and education institutions. It can be used by
 employees of these organisations to sign in to the RSD using their institute credentials. Before they can do so, however, an organisation __must enable the RSD service__ in their
 SURFconext dashboard.
 
 ::: tip
-You can check [here](https://dashboard.surfconext.nl/apps/9514/oidc10_rp/about) if your organisation has enabled the RSD service in SURFConext.
+You can check [here](https://dashboard.surfconext.nl/apps/9514/oidc10_rp/about) if your organisation has enabled the RSD service in SURFconext.
 :::
 
-To sign in using SURFConext, go to the "sign in" button at the top right corner of the page and select the __SURFConext__ identity provider. Next, select the
+To sign in using SURFconext, go to the "sign in" button at the top right corner of the page and select the __SURFconext__ identity provider. Next, select the
 appropriate organisation and then enter your credentials in the organisation specific sign in page that follows.
 
 ### Signing in with ORCID