Skip to content

Commit db6a88e

Browse files
committed
Developer page with boxes, buttons, icons
1 parent 98cd3cb commit db6a88e

3 files changed

Lines changed: 62 additions & 14 deletions

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
Separate the training docs/help content to separate repo, like [IBISBA Handboook](https://ibisba.github.io/workshop/docs/intro.html).
44

5-
Built using [Jupyter Book 1](https://jupyterbook.org/).
5+
Built using [Jupyter Book 1](https://jupyterbook.org/). For additional guidance, see:
6+
7+
- [Anatomy of a Jupyter Book (TeachBooks.io)](https://teachbooks.io/manual/basic-features/jupyterbook.html)
68

79
To run locally, install Jupyter Book then build:
810
```shell

TeSS_docs/developers/code-data.md

Lines changed: 54 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,64 @@
22

33
TeSS is committed to the FAIR principles: making data findable, accessible, interoperable and re-usable. As such, all content in TeSS is available under the CC BY 4.0 licence, and can be accessed through our API and widgets. The TeSS codebase is also available to re-use under the BSD Licence, and can be found on GitHub.
44

5+
6+
::::{grid} 1 1 2 2
7+
:class-container: text-center
8+
:gutter: 3
9+
10+
:::{grid-item-card}
11+
12+
{octicon}`mark-github` **Software**
13+
^^^
14+
15+
The source code for TeSS [is available on GitHub](https://github.com/ElixirTeSS/TeSS), under the [BSD 3-Clause](https://tess.elixir-europe.org/about/developers#api:~:text=available%20under%20the-,BSD%203%2DClause,-license.) license.
16+
:::
17+
18+
19+
:::{grid-item-card}
20+
21+
{fas}`plug` **Data**
22+
^^^
23+
24+
Data in TeSS can be accessed via our [API](#api), under the [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/).
25+
:::
26+
27+
::::
28+
29+
530
## Widgets
631
Widgets are chunks of javascript code that can be copied into website source code to display TeSS content. There are several different styles and functionalities available from our configurable widget suite. Widgets can be used to enhance your site and offer your community lists of relevant events or training resources.
732

33+
```{button-link} https://elixirtess.github.io/TeSS_widgets/
34+
:color: primary
35+
View our available widgets
36+
```
837

938

1039
## API
1140

12-
TeSS has a fully functioning JSON API. You can explore our JSON-API by appending .json_api to the end of the URL of most pages (excluding parameters). For example:
41+
TeSS has a fully functioning JSON API. You can explore our JSON-API by appending .json_api to the end of the URL of most pages (excluding parameters). For example:
42+
43+
```
44+
https://tess.elixir-europe.org/events.json_api
45+
https://tess.elixir-europe.org/materials.json_api?scientific_topics=RNA-Seq
46+
https://tess.elixir-europe.org/content_providers.json_api
47+
https://tess.elixir-europe.org/workflows.json_api
48+
```
49+
50+
The full documentation for the TeSS JSON API can be found here:
51+
52+
```{button-link} hhttps://tess.elixir-europe.org/api/json_api
53+
:color: primary
54+
View the JSON-API documentation
55+
```
56+
57+
58+
## Developer guides
59+
60+
There are additional guides for installing and configuring a TeSS instance.
61+
62+
```{button-link} https://github.com/ElixirTeSS/TeSS/tree/master/docs
63+
:color: primary
64+
View the developer guides (on GitHub)
65+
```

TeSS_docs/index.md

Lines changed: 5 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,8 @@ This documentation is intended to provide help and information on how to use a t
1010
:::{grid-item-card}
1111
:link: overview/tess
1212
:link-type: doc
13-
:class-header: bg-light
1413

15-
Overview
14+
**Overview**
1615
^^^
1716

1817
What is TeSS, definitions of terms.
@@ -21,33 +20,28 @@ What is TeSS, definitions of terms.
2120
:::{grid-item-card}
2221
:link: accounts/user
2322
:link-type: doc
24-
:class-header: bg-light
2523

26-
Account creation
24+
**Account creation**
2725
^^^
2826

2927
Creating a user account, setting up a content provider.
30-
3128
:::
3229

3330
:::{grid-item-card}
3431
:link: spaces/intro-spaces
3532
:link-type: doc
36-
:class-header: bg-light
3733

38-
Spaces
34+
**Spaces**
3935
^^^
4036

4137
When to set up a TeSS space, how to credit other spaces' materials.
42-
4338
:::
4439

4540
:::{grid-item-card}
4641
:link: content/auto
4742
:link-type: doc
48-
:class-header: bg-light
4943

50-
Content
44+
**Content**
5145
^^^
5246

5347
Automatically or manually register events, materials or learning paths.
@@ -56,9 +50,8 @@ Automatically or manually register events, materials or learning paths.
5650
:::{grid-item-card}
5751
:link: developers/code-data
5852
:link-type: doc
59-
:class-header: bg-light
6053

61-
Developers
54+
**Developers**
6255
^^^
6356

6457
Configure an API or widget.

0 commit comments

Comments
 (0)