Skip to content

Commit 194fcec

Browse files
MarekSuchanekMarekSuchanek
authored
Merge pull request #18 from OSTrails/release/0.1.0
Release 0.1.0
2 parents 31a5aa6 + 2b4ee1d commit 194fcec

32 files changed

+1319
-44
lines changed

‎.editorconfig

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ max_line_length = off
1212
indent_size = 4
1313

1414
[*.bat]
15+
indent_style = tab
1516
end_of_line = crlf
1617

1718
[*.{yaml,yml}]
@@ -25,3 +26,6 @@ indent_size = 2
2526

2627
[*.js]
2728
indent_size = 2
29+
30+
[Makefile]
31+
indent_style = tab

‎.github/ISSUE_TEMPLATE/config.yml

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
blank_issues_enabled: true
2+
contact_links:
3+
- name: OSTrails Deliverables
4+
url: https://ostrails.eu/deliverables
5+
about: Please check deliverables of OSTrails for reference.
6+
- name: OSTrails Glossary
7+
url: https://ostrails.eu/glossary
8+
about: Please check glossary if any terminology is unclear.

‎.github/ISSUE_TEMPLATE/missing-info.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: "Missing, Incomplete, or Legacy Information"
2+
description: "Report sections that lack sufficient explanation or needs update."
3+
labels: ["enhancement"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: "Describe the missing information"
8+
description: "What information is missing, and what should be included? Is it related to DMP, SKG, FAIR, and/or other sections?"
9+
validations:
10+
required: true
11+
- type: input
12+
attributes:
13+
label: "Page or file location"
14+
description: "Provide as exact location in the text as possible (file/section)."
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: "Suggested enhancement"
20+
description: "Do you have a suggestion on how to improve it?"
21+
- type: textarea
22+
attributes:
23+
label: "Additional references and context"
24+
description: "Any other notes? Please provide links or additional context."

‎.github/ISSUE_TEMPLATE/rendering.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: "Rendering or Formatting Issue"
2+
description: "Report issues related to documentation layout, broken formatting, or incorrect rendering when browsing docs.ostrails.eu."
3+
labels: ["bug", "formatting"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: "Describe the rendering issue"
8+
description: "What part of the documentation is not displaying correctly?"
9+
validations:
10+
required: true
11+
- type: textarea
12+
attributes:
13+
label: "Screenshots (if applicable)"
14+
description: "Attach screenshots to show the issue."
15+
- type: input
16+
attributes:
17+
label: "Issue location"
18+
description: "Provide the exact URL or file path."
19+
validations:
20+
required: true
21+
- type: input
22+
attributes:
23+
label: "Used browser/s and versions"
24+
description: "Specify the browser/s and their versions."
25+
validations:
26+
required: true

‎.github/ISSUE_TEMPLATE/technical.yml

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
name: "Repository Issue"
2+
description: "Report issues related to Sphinx builds, dependencies, or other technical errors within the repository."
3+
labels: ["bug", "technical"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: "Describe the issue"
8+
description: "What technical issue are you experiencing?"
9+
validations:
10+
required: true
11+
- type: input
12+
attributes:
13+
label: "Error message (if any)"
14+
description: "Paste any error logs or messages."
15+
- type: textarea
16+
attributes:
17+
label: "Steps to reproduce"
18+
description: "How can we reproduce this issue?"
19+
validations:
20+
required: true
21+
- type: textarea
22+
attributes:
23+
label: "Additional context"
24+
description: "Any other relevant information?"

‎.github/ISSUE_TEMPLATE/typo.yml

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "Typo or Text Improvement"
2+
description: "Report a typo, grammatical error, or wording improvement."
3+
labels: ["typo"]
4+
body:
5+
- type: textarea
6+
attributes:
7+
label: "Describe the typo or text issue"
8+
description: "Specify the incorrect text and suggest a correction if possible."
9+
validations:
10+
required: true
11+
- type: input
12+
attributes:
13+
label: "Page or file location"
14+
description: "Provide as exact location in the text as possible (file/section)."
15+
validations:
16+
required: true
17+
- type: textarea
18+
attributes:
19+
label: "Additional context"
20+
description: "Any other notes?"

‎.github/PULL_REQUEST_TEMPLATE/pull_request_template.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
## Description of Changes
2+
3+
<!--- Describe the changes made in this pull request, feel free to provide links to relevant materials --->
4+
5+
<!--- Suggested reviewers: @username1, @username2 --->
6+
<!--- Collaborators on this PR: @username3, @username4 --->
7+
8+
## Related Issue(s)
9+
10+
<!--- * Link to the issue(s) that this PR closes or is related to e.g. "closes #1" --->
11+
12+
## Checklist before requesting a review
13+
14+
- [ ] Code style check has been done
15+
- [ ] Check of built Sphinx documentation has been checked
16+
- [ ] This work complies with the current **Code of Conduct** and the **Contributing Guidelines**

‎CODEOWNERS

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,15 @@
1-
* @MarekSuchanek
1+
# This file is used to define the owners of the different parts of the repository.
22

3-
*.rst @TomMiksa @MarekSuchanek
3+
# ===================================================
4+
# All the management stuff
5+
# ---------------------------------------------------
6+
* @MarekSuchanek
7+
8+
# ===================================================
9+
# Specific parts of the documentation
10+
# ---------------------------------------------------
11+
docs/architecture/* @TomMiksa
12+
docs/architecture/fair* @dgarijo @markwilkinson
13+
docs/architecture/skg* @paolomanghi
14+
docs/commons/* @TomMiksa @MarekSuchanek
15+
docs/other/* @MarekSuchanek

‎CONTRIBUTING.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -78,21 +78,24 @@ fix: correct typos
7878
When contributing to the documentation, please follow these steps:
7979

8080
1. Fork the repository (if not in the OSTrails organization).
81-
2. Create a new branch for your changes (base = `develop`).
81+
2. Create a new branch for your changes (base = `next`).
8282
3. Make your changes and commit them.
8383
4. Push your changes.
84-
5. Open a pull request to the `develop` branch of the main repository.
84+
5. Open a pull request to the `next` branch of the main repository.
85+
86+
Both `next` and `main` branches are protected and require a review before merging. The `next` branch is used for the next release, while the `main` branch is used for the current release (and only release/hotfix PRs will be merged according to [Gitflow workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/gitflow-workflow)).
8587

8688
### Crediting Contributors
8789

8890
We will credit all contributors in the documentation. If you would like to be credited, please add your name and related information to the [`CONTRIBUTORS.yml`](./CONTRIBUTORS.yml) file.
8991

90-
Then, you can add your name to the list of contributors for a specific page:
92+
Then, you can add your name to the list of contributors for a specific page (under the first heading) using the `page-authors` directive:
9193

9294
```rst
9395
Page Title
9496
==========
9597
9698
.. page-authors::
9799
John Doe
100+
98101
```

‎CONTRIBUTORS.yml

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,38 @@ Marek Suchánek:
44
github: MarekSuchanek
55
orcid: 0000-0001-7525-9218
66
affiliation: CTU in Prague
7+
8+
Daniel Garijo:
9+
first_name: Daniel
10+
last_name: Garijo
11+
github: dgarijo
12+
orcid: 0000-0003-0454-7145
13+
affiliation: Universidad Politécnica de Madrid
14+
15+
Mark Wilkinson:
16+
first_name: Mark
17+
last_name: Wilkinson
18+
github: markwilkinson
19+
orcid: 0000-0001-6960-357X
20+
affiliation: Universidad Politécnica de Madrid
21+
22+
Tomasz Miksa:
23+
first_name: Tomasz
24+
last_name: Miksa
25+
github: TomMiksa
26+
orcid: 0000-0002-4929-7875
27+
affiliation: TU Wien
28+
29+
John Shepherdson:
30+
first_name: John
31+
last_name: Shepherdson
32+
github: john-shepherdson
33+
orcid: 0000-0002-4402-9644
34+
affiliation: CESSDA ERIC
35+
36+
Allyson Lister:
37+
first_name: Allyson
38+
last_name: Lister
39+
github: allysonlister
40+
orcid: 0000-0002-7702-4495
41+
affiliation: University of Oxford

0 commit comments

Comments
 (0)