Skip to content

Commit

Permalink
Added horizontal breakpoints to each secondary header + updated readme
Browse files Browse the repository at this point in the history
  • Loading branch information
nkurtys committed Oct 30, 2024
1 parent 5b5c957 commit e067dd3
Show file tree
Hide file tree
Showing 29 changed files with 201 additions and 127 deletions.
3 changes: 2 additions & 1 deletion docs/_Getting-Started/01-introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,10 +45,11 @@ More information on how to contribute to the consortium, participate in coffee t
By sending an email you agree with the NFDI4Microbiota Consortium Privacy Policy, found bellow the Helpdesk contact form.


---


## What is this Knowledge Base about?

---

This knowledge base is a collection of information and references with
relevance for the microbiology community in terms of Research Data
Expand Down
12 changes: 11 additions & 1 deletion docs/_Getting-Started/01-privacy-policy-english-translation.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,13 +8,14 @@ hide: true

## DISCLAIMER

---

The following policy is an automated translation of the German text. Please refer to the German original for a legally binding document.

---

## § 1 Information on data collection, controller, contacting us

---

1. In the following, we provide information about the collection of personal data when using our websites www.nfdi4microbiota.de, www.nfdi4life.de, www.zbmed.de, www.livivo.de, www.publisso.de, https://books.publisso.de, https://repository.publisso.de and zbmedblog.de. Personal data is all data that can be related to you personally, e.g. name, address, e-mail addresses, user behavior.

Expand All @@ -38,6 +39,7 @@ The following policy is an automated translation of the German text. Please refe

## § 2 Your rights

---

1. You have the following rights vis-à-vis us with regard to your personal data:

Expand All @@ -61,6 +63,7 @@ The following policy is an automated translation of the German text. Please refe

## § 3 What data we collect when you visit our website

---

1. When using the website for information purposes only, i.e. if you do not register or otherwise provide us with information, we only collect the personal data that your browser transmits to our server. If you wish to view our website, we collect the following data, which is technically necessary for us to display our website to you and to ensure stability and security (legal basis is Art. 6 para. 1 sentence 1 lit. f GDPR): - IP address - date and time of the request - time zone difference to Greenwich Mean Time (GMT) - content of the request (specific page) - access status/HTTP status code - amount of data transferred in each case - website from which the request comes - browser - operating system and its interface - language and version of the browser software.

Expand All @@ -80,6 +83,7 @@ The following policy is an automated translation of the German text. Please refe

## § 4 What other data we collect when you use the other functions and offers on our website and what we do with it

---

1. In addition to the purely informational use of our website, we offer various services that you can use if you are interested. These include the use of www.livivo.de, https://books.publisso.de, https://repository.publisso.de and a library user account registered with us. To do so, you must generally provide additional personal data that we use to provide the respective service and to which the aforementioned data processing principles apply.

Expand All @@ -91,6 +95,7 @@ The following policy is an automated translation of the German text. Please refe

## § 5 Objection to/revocation of the processing of your data

---

1. If you have given your consent to the processing of your data, you can withdraw this at any time. Such a revocation affects the permissibility of the processing of your personal data after you have expressed it to us.

Expand All @@ -100,6 +105,7 @@ The following policy is an automated translation of the German text. Please refe

## § 6 Use of our blog function, use of our web store, use of our portals

---

Use of the blog functions In our blog (zbmedblog.de), in which we publish various articles on topics relating to our activities, you can make public comments. Your comment will be published with your specified user name next to the post. We recommend that you use a pseudonym instead of your real name. Your username and e-mail address are required, all other information is voluntary. If you leave a comment, we will continue to store your IP address. This storage is necessary for us to be able to defend ourselves against liability claims in the event of possible publication of unlawful content. We need your e-mail address in order to contact you if a third party objects to your comment as unlawful. The legal basis is Art. 6 para. 1 sentence 1 lit. b and f GDPR. Comments are checked before publication. We reserve the right to delete comments if they are objected to as unlawful by third parties.

Expand Down Expand Up @@ -131,6 +137,7 @@ The following policy is an automated translation of the German text. Please refe

## § 7 Our newsletter

---

1. With your consent, you can subscribe to our newsletter, with which we inform you about our current interesting offers. The advertised goods and services are named in the declaration of consent.

Expand All @@ -142,6 +149,7 @@ The following policy is an automated translation of the German text. Please refe

## § 8 Use of web analytics

---

### Use of Google Analytics

Expand Down Expand Up @@ -181,6 +189,7 @@ The following policy is an automated translation of the German text. Please refe

## § 9 Social media

---

### Use of social media buttons

Expand All @@ -206,6 +215,7 @@ The following policy is an automated translation of the German text. Please refe

## § 10 Online advertising

---

### Use of Google Adwords Conversion6

Expand Down
14 changes: 6 additions & 8 deletions docs/_Getting-Started/02-contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@ docs_css: markdown

## Introduction


This document contains instructions on how to contribute to the Knowledge base and is intended for contributors with no prior GitHub experience. Feel free to skip to the appropriate section if you feel like you are an experienced user.

The main steps a user must follow to contribute to the Knowledge Base are:
Expand All @@ -18,17 +17,16 @@ The main steps a user must follow to contribute to the Knowledge Base are:
- Create new files
3. Add your name to the [03-contributors.md](https://github.com/NFDI4Microbiota/nfdi4microbiota-knowledge-base/blob/main/docs/_Getting-Started/03-contributors.md) file.

---

## Create a GitHub account

---

Users will need a GitHub account if they wish to contribute to the Knowledge Base. If you do not already have an account, go to the GitHub [homepage](https://github.com/) and click the `Sign Up` button to create one. Then follow the instructions. Once you have created an account, and signed in, go to the [Knowledge Base repository](https://github.com/NFDI4Microbiota/nfdi4microbiota-knowledge-base.github.io)

---

## Make changes to the repository

---

### Edit existing files

Expand Down Expand Up @@ -71,17 +69,17 @@ To create a new issue:

[Here](https://docs.github.com/en/issues/tracking-your-work-with-issues/creating-an-issue) is a guide on creating issues on GitHub if you need further help.

---

## Add your name to the CONTRIBUTORS file

---

We appreciate your contribution! Please add your name to the [03-contributors.md](https://github.com/NFDI4Microbiota/nfdi4microbiota-knowledge-base/blob/main/docs/_Getting-Started/03-contributors.md) file.

---

## Contribution Rules

---

When adding or editing files, please observe the following rules:

Expand All @@ -90,17 +88,17 @@ When adding or editing files, please observe the following rules:
3. Keep the content factual
4. Reference sources appropriately (see below)
5. Use a single `##` for the main file heading and use `###`, `####`, etc, for all subheadings
6. Before the second and every following `##` add `---` for a visual break line.
6. After the second and every following `##` add `---` for a visual break line.
7. Place image files in the `assets/img/` directory
8. Use internal links to markdown documents with {% raw %}`[Link text]({% link _RDM-Share/26_licenses.md %})`{% endraw %}
9. Non-public links are be restricted to the how-we-operate section and whitelisted in `.github/workflows/ignored-urls.txt` manually

*Note: we might edit your contribution to homogenize the writing style.*

---

## Cite sources

---

1. Websites can be linked in the text (e.g. [NFDI4Microbiota](https://nfdi4microbiota.de/)).
2. Journal articles can be referenced at the bottom of the page, as in a regular scientific journal.
Expand Down
16 changes: 7 additions & 9 deletions docs/_How-We-Operate/00-n4m-intro.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,9 @@ Here, all information, guidelines, SOPs, documents, and links required for the w
### Contribution
Each member of the consortium can [contribute to this repository](https://knowledgebase.nfdi4microbiota.de/Getting-Started/02-contributing.html).

---

## The Nationale Forschungsdateninfrastruktur (NFDI) e.V. (NFDI association)

---

- The National Research Data Infrastructure (NFDI) aims to systematically index, edit, interconnect, and make available the valuable stock of data from science and research.
Digital data storage is an indispensable prerequisite for treating new research issues, generating findings, and making innovations. Therefore, the NFDI association was founded in 2020.
Expand All @@ -31,10 +30,10 @@ Each member of the consortium can [contribute to this repository](https://knowle
- In a 30-minute video, the [statute](https://www.youtube.com/watch?v=mXNeZdzCfBg&t=434s) of the NFDI e.V. (German) is explained on their [YouTube channel](https://www.youtube.com/channel/UCTz321rUFOvrKOgkFfhyhLQ).
- The Deutsche Forschungsgesellschaft (DFG) funds different NFDI consortia (independently of the NFDI e.V.). Further information and introductory videos can be found on the [DFG website](https://www.dfg.de/en/research-funding/funding-initiative/nfdi).

---

## Introduction to NFDI4Microbiota

---

**Vision:**

Expand Down Expand Up @@ -81,10 +80,10 @@ h) # of training
i) # of ambassadors
j) # of commits to the knowledge base

---

## Governance of NFDI4Microbiota

---

Governance is the process of making and enforcing decisions within an organization or society. In the following, the governance structure will be introduced, and the governance bodies are defined.

Expand Down Expand Up @@ -149,10 +148,9 @@ thus reacting to new and unforeseen scenarios. It is staffed based on suggestion
### NFDI4Microbiota Policy
The General Assembly adopted the NFDI4Microbiota Policy in 2023, which will be published on the [NFDI4Microbiota Zenodoo community](https://zenodo.org/communities/nfdi4microbiota) soon.

---

## Annual timeline of important dates for the consortium

---

This timeline gives a rough orientation on the annual tasks, deliverables, meetings, etc. of the administration and the outreach of NFDI4Microbiota.

Expand Down Expand Up @@ -182,10 +180,10 @@ Middle of November | Announcement | M5.3 | Forwarding Flex Funds decision to app
December | Event | TA51 | NFDI4Microbiota Annual Conference 2024
December | Meeting | TA5 | Quarterly coordination coffee

---

## NFDI4Microbiota Community, Members, Partners, and Participants

---

### NFDI4Microbiota Community
The NFDI4Microbiota community is defined as the group of all researchers working within or with microbiology-related projects and the respective data.
Expand Down Expand Up @@ -223,10 +221,10 @@ found. All participants are members of the mailing list participants-at-nfdi4mic
Ambassadors are young researchers (PhD students, Post Docs, etc.) of microbiology research groups. They actively [registered](https://helmholtz-hzi.limesurvey.net/158936?newtest=Y&lang=en)
and are part of the mailing list ambassador-at-nfdi4microbiota.de. Details on the ambassador program can be found on the [web portal](https://nfdi4microbiota.de/community/ambassador.html).

---

## Communication

---

Within the consortium, as well as externally, we have several communication possibilities through different channels:

Expand All @@ -253,10 +251,10 @@ If you are involved in further sections, task forces, or administrative groups (
NFDI mailing lists. For some mailing lists, archives of past emails do exist and can be viewed too. Every NFDI4Microbiota member should at least register to 'nfdi-all' mailing list.
All lists can be accessed via [this link](https://lists.nfdi.de/postorius/lists/).

---

## Finances

---

For the consortium, the information on the annual direct cost distributions and flexible funding are of interest.
In general, the [Usage Guidelines of the DFG](https://www.dfg.de/resource/blob/168728/8ee8c5e88b49e485ec3e0cb8d3fe107d/dfg-nfdi300-de-v0721-data.pdf) giving a guideline on
Expand Down
10 changes: 4 additions & 6 deletions docs/_How-We-Operate/01-governance-workflows.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,10 +12,10 @@ hide: false
Governance is the process of making and enforcing decisions within an organization or society. The following will introduce the governance structure, and the governance bodies are defined.
Details on the bodies of the NFDI4Microbiota can be found in the [introduction to NFDI4Microbiota](00-n4m-intro.html#governance-of-nfdi4microbiota).

---

## The General Assembly

---

### Frequency of the General Assembly
The GA takes place twice a year, most likely in March/April and in October/November.
Expand Down Expand Up @@ -72,10 +72,10 @@ consortium for information and review for two weeks. Afterwards, the minutes wil
### Documentation of the General Assembly
All files regarding the General Assembly are filed [in Nextcloud](https://nextcloud.nfdi4microbiota.de/f/105454) (internal link).

---

## The Scientific Advisory Board

---

A detailed description of the Scientific Advisory Board (SAB) of NFDI4Microbiota can be found in the [introduction to NFDI4Microbiota](00-n4m-intro.html#governance-of-nfdi4microbiota).

Expand Down Expand Up @@ -124,10 +124,9 @@ consortium.
All files regarding the SAB are filed [here](https://nextcloud.nfdi4microbiota.de/f/105451) (internal link).
The members of the SAB are displayed on the web portal.

---

## The Project Review Board

---

The Project Review Board (PRB) is responsible for selecting new projects within the scope of the flexible funding and allocation mechanism, thus reacting to new and unforeseen scenarios. It is staffed based on
suggestions made by the SAB and decision-making includes a peer review process.
Expand Down Expand Up @@ -164,10 +163,9 @@ To update the PRB regularly, they will receive the following information via the
- the outcome and the proposals of the annual FlexFunds call, and
- a season's greeting email.

---

## The Circulation Procedure

---

If resolutions have to be made between the meetings of the General Assembly or the Scientific Advisory Board, a circulation procedure can be performed. A simple majority is required to approve a resolution,
which means more then half of the cast votes.
Expand Down
11 changes: 5 additions & 6 deletions docs/_How-We-Operate/02-training-guidelines.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,10 +29,9 @@ software or tools. We only mention certain software products to
illustrate our points. We separate the guidelines along the timeline of
before, during, and after the training.

---

## Before the Training

---

 A large part of the trainer’s work will already be done in preparation
for any training event. Here, we list some points that should be considered when preparing to provide a well-received training event.
Expand Down Expand Up @@ -193,10 +192,9 @@ everyone. A good introduction is given in “[Ten simple rules for making
training materials
FAIR](https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1007854)”.

---

## During the Training

---

### Arrival
Before the first session of your training event, you should
Expand Down Expand Up @@ -330,10 +328,10 @@ training in the future. Do try to ensure that the feedback can be
anonymous and that the questions highlight points of improvement to
enable you/the team to provide an even better experience the next time.

---

## After the Training

---

Shortly after the event, you should  **meet with all trainers** involved
and **gather their feedback**. Collect points that should be improved
Expand All @@ -354,7 +352,8 @@ benefit from the work you already provided. If you do so, make sure to
state under what license you provide your work. We suggest a permissive
license such as [CC BY](https://creativecommons.org/licenses/by/4.0/), or „CC 0“.

## Get Help

---

## Get Help
If you have any further questions about the management and analysis of your microbial research data, please contact us: [[email protected]](mailto:[email protected]) (by emailing us you agree to the privacy policy on our website: [Contact](https://nfdi4microbiota.de/contact-form/))
Loading

0 comments on commit e067dd3

Please sign in to comment.