Skip to content

Commit 5fb9fb2

Browse files
svedziokSven Twardziok
andauthored
docs: restructure docs and update branding (#35)
Co-authored-by: Sven Twardziok <sven.twardziok@bih-charite.de>
1 parent f0fd5ad commit 5fb9fb2

39 files changed

+261
-144
lines changed

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
site/
22
_site/
3-
.venv
3+
.venv
4+
.notes
5+
.codespell*

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Documentation Hub
22

3-
Documentation for ELIXIR Cloud & AAI project.
3+
Documentation for the ELIXIR-on-Cloud project.
44

55
## Development
66

custom_theme/404.html

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313

1414

1515

16-
<title>ELIXIR::GA4GH Cloud Docs</title>
16+
<title>ELIXIR-on-Cloud Docs</title>
1717

1818

1919

@@ -75,7 +75,7 @@
7575

7676
<header class="md-header" data-md-component="header">
7777
<nav class="md-header__inner md-grid" aria-label="Header">
78-
<a href="/." title="ELIXIR::GA4GH Cloud Docs" class="md-header__button md-logo" aria-label="ELIXIR::GA4GH Cloud Docs" data-md-component="logo">
78+
<a href="/." title="ELIXIR-on-Cloud Docs" class="md-header__button md-logo" aria-label="ELIXIR-on-Cloud Docs" data-md-component="logo">
7979

8080
<img src="/images/logo.256px.png" alt="logo">
8181

@@ -87,7 +87,7 @@
8787
<div class="md-header__ellipsis">
8888
<div class="md-header__topic">
8989
<span class="md-ellipsis">
90-
ELIXIR::GA4GH Cloud Docs
90+
ELIXIR-on-Cloud Docs
9191
</span>
9292
</div>
9393
<div class="md-header__topic" data-md-component="header-topic">
@@ -172,12 +172,12 @@
172172

173173
<nav class="md-nav md-nav--primary" aria-label="Navigation" data-md-level="0">
174174
<label class="md-nav__title" for="__drawer">
175-
<a href="/." title="ELIXIR::GA4GH Cloud Docs" class="md-nav__button md-logo" aria-label="ELIXIR::GA4GH Cloud Docs" data-md-component="logo">
175+
<a href="/." title="ELIXIR-on-Cloud Docs" class="md-nav__button md-logo" aria-label="ELIXIR-on-Cloud Docs" data-md-component="logo">
176176

177177
<img src="/images/logo.256px.png" alt="logo">
178178

179179
</a>
180-
ELIXIR::GA4GH Cloud Docs
180+
ELIXIR-on-Cloud Docs
181181
</label>
182182

183183
<div class="md-nav__source">

docs/about/code-of-conduct.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# ELIXIR Cloud & AAI Code of Conduct
1+
# ELIXIR-on-Cloud Code of Conduct
22

33
## Our Pledge
44

docs/about/contact.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@ Get in touch with us through one of the following methods:
99

1010
| Method &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; &emsp; | Use it for |
1111
| --- | --- |
12-
| [:custom-github-black: &nbsp; Issue trackers][elixir-cloud-aai-github] | Report bugs, suggest features or discuss existing issues; please try to create issues in the most relevant repository (or repositories); as an example, find [here][issue-tracker-example] the issue tracker for the repository containing this documentation |
13-
| [:custom-slack: &nbsp; Slack][elixir-cloud-aai-slack] | Work closely together with us, e.g., if you would like to contribute or integrate your services or infrastructure with us |
14-
| [:custom-twitter: &nbsp; Twitter][elixir-cloud-aai-twitter] | Include us in your tweets; note that our Twitter account is silent for now, i.e., as an organization, we do not tweet ourselves |
15-
| [:custom-forum-black: &nbsp; Q&A forum][elixir-cloud-aai-forum] | Ask public Q&A style questions that can be answered by or discussed with us or anyone else |
16-
| [:custom-email: &nbsp; Email][elixir-cloud-aai-email] | First contact for collaborations or any other private communication; for continuous communication, please join our [Slack board][elixir-cloud-aai-slack] |
12+
| [:custom-github-black: &nbsp; Issue trackers][elixir-on-cloud-github] | Report bugs, suggest features or discuss existing issues; please try to create issues in the most relevant repository (or repositories); as an example, find [here][issue-tracker-example] the issue tracker for the repository containing this documentation |
13+
| [:custom-slack: &nbsp; Slack][elixir-on-cloud-slack] | Work closely together with us, e.g., if you would like to contribute or integrate your services or infrastructure with us |
14+
| [:custom-twitter: &nbsp; Twitter][elixir-on-cloud-twitter] | Include us in your tweets; note that our Twitter account is silent for now, i.e., as an organization, we do not tweet ourselves |
15+
| [:custom-forum-black: &nbsp; Q&A forum][elixir-on-cloud-forum] | Ask public Q&A style questions that can be answered by or discussed with us or anyone else |
16+
| [:custom-email: &nbsp; Email][elixir-on-cloud-email] | First contact for collaborations or any other private communication; for continuous communication, please join our [Slack board][elixir-on-cloud-slack] |
File renamed without changes.

docs/guides/guide-contributor/general-guidelines.md renamed to docs/contribute/general-guidelines.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,8 @@ of your ability.
1717

1818
Please use the comment functions available on GitHub to discuss issues and
1919
pull requests. For all other communications please refer to the communication
20-
channels listed in the [contact](../../about/contact.md) section. In
21-
particular, use the [chat][elixir-cloud-aai-slack] to discuss project ideas,
20+
channels listed in the [contact](../about/contact.md) section. In
21+
particular, use the [chat][elixir-on-cloud-slack] to discuss project ideas,
2222
get help on a problem, or any other informal discussion that does not need to
2323
be preserved as part of the repository you are working on.
2424

@@ -59,7 +59,7 @@ that code changes are always merged into protected branches via pull requests
5959
that will undergo one or more rounds of review and testing. The schema below
6060
visualizes this process.
6161

62-
[![GitHub Flow](../../images/github_flow.svg)][github-flow]
62+
[![GitHub Flow](../images/github_flow.svg)][github-flow]
6363

6464
1. [Create a "feature branch"][git-branch] from the development branch; use the
6565
`feature/my-feature` naming pattern to name your feature branch, e.g.,
Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
Great to see you here - we would be delighted to have you join our team! So if
44
you are interested, just read on for information on how to contribute.
55

6-
If you don't know what [ELIXIR][elixir] [Cloud & AAI][elixir-cloud-aai] is all
6+
If you don't know what [ELIXIR-on-Cloud][elixir-on-cloud] is all
77
about, follow the link or check out these documentation pages. Otherwise,
88
please read on to find out more about the general topics you can help us with,
99
our core values, what we can offer you and what we expect from contributors.
@@ -61,23 +61,23 @@ We offer you
6161
experts with diverse technical and cultural backgrounds
6262
- the opportunity to tackle modern, highly relevant technical challenges on the
6363
way to personalized medicine and genome-scale analytics in the cloud
64-
- support, feedback and appreciation for your work, as well as involvment in
64+
- support, feedback and appreciation for your work, as well as involvement in
6565
and influence on policy decisions proportional to the level of your
6666
engagement
6767
- networking opportunities within the [ELIXIR][elixir] and [GA4GH][ga4gh]
6868
communities, with many opinion leaders in academia and the tech industry
6969

7070
!!! note "Regular contributors"
7171

72-
Check out the additional [exiciting opportunities](#opportunities) for
72+
Check out the additional [exciting opportunities](#opportunities) for
7373
regular contributors!
7474

7575
## Our expectations
7676

7777
If all of that sounds tempting and you are still interested to contribute, we
7878
would only expect you to please
7979

80-
- respect our [Code of Conduct](../../about/code-of-conduct.md)
80+
- respect our [Code of Conduct](../about/code-of-conduct.md)
8181
- make an effort to adhere to good coding practices and our [contribution
8282
guidelines] (we will of course help you with that!)
8383
- communicate clearly and openly with us with regard to any issues that you
@@ -130,10 +130,10 @@ projects they were working on):
130130

131131
### Hackathons
132132

133-
We regularly lead [ELIXIR][elixir] [Cloud & AAI][elixir-cloud-aai]-related
133+
We regularly lead [ELIXIR-on-Cloud][elixir-on-cloud]-related
134134
projects at various (bio)hackathons. These are always fun events and often a
135135
highlight of the year! Check our [news
136-
page][elixir-cloud-aai-news] for any upcoming events. If you are interested in
136+
page][elixir-on-cloud-news] for any upcoming events. If you are interested in
137137
attending a hackathon, please reach out to us. In some cases, we may be able
138138
to procure funding for contributors.
139139

File renamed without changes.

docs/guides/guide-contributor/language-specific/python.md renamed to docs/contribute/language-specific/python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ section.
66
## Python version
77

88
For any _new_ projects, please use one of the two most recent [Python minor
9-
versions][py-downloads], exclusing pre-releases. For existing projects, use the
9+
versions][py-downloads], excluding pre-releases. For existing projects, use the
1010
Python version used throughout the project (mentioned in `pyproject.toml`).
1111

1212
## Packaging, build system & dependencies

0 commit comments

Comments
 (0)