Skip to content

Commit

Permalink
chore: Move technical details to mdbook
Browse files Browse the repository at this point in the history
  • Loading branch information
St4NNi committed Oct 31, 2024
0 parents commit 082a054
Show file tree
Hide file tree
Showing 8 changed files with 496 additions and 0 deletions.
36 changes: 36 additions & 0 deletions .github/workflows/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: Deploy
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
permissions:
contents: write # To push a branch
pages: write # To push to a GitHub Pages site
id-token: write # To update the deployment status
steps:
- uses: actions/checkout@v4
with:
fetch-depth: 0

- uses: actions-rs/cargo@v1
with:
command: install
args: mdbook mdbook-alerts
- name: Build Book
run: |
# This assumes your book is in the root of your repository.
# Just add a `cd` here if you need to change to another directory.
mdbook build
- name: Setup Pages
uses: actions/configure-pages@v4
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
# Upload entire repository
path: 'book'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
book
*.code-workspace
/.idea/
392 changes: 392 additions & 0 deletions LICENSE

Large diffs are not rendered by default.

33 changes: 33 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Aruna presentations

[![CC BY-ND 4.0][cc-by-nd-shield]][cc-by-nd]

Repository for the documentation of the BMBF funded project FAIR Dataspaces.

A rendered version of the wiki can be found here:

https://fair-ds4nfdi.github.io/wiki/

## Deploy Locally with Docker for Testing

* In the repository's root directory, run `docker run -v $PWD:/book -p 3000:3000 peaceiris/mdbook serve --hostname 0.0.0.0`
* Browse to http://localhost:3000
* You can edit the content while the container is running and see the results immediately.


## Contributing

The contribution to the wiki is done via pull requests. The book is rendered as markdown via the `src` directory.

[SUMMARY.md](./src/SUMMARY.md) contains the table of content for the book.

## License

This work is licensed under a
[Creative Commons Attribution-NoDerivs 4.0 International License][cc-by-nd].

[![CC BY-ND 4.0][cc-by-nd-image]][cc-by-nd]

[cc-by-nd]: https://creativecommons.org/licenses/by-nd/4.0/
[cc-by-nd-image]: https://licensebuttons.net/l/by-nd/4.0/88x31.png
[cc-by-nd-shield]: https://img.shields.io/badge/License-CC%20BY--ND%204.0-lightgrey.svg
9 changes: 9 additions & 0 deletions book.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
[book]
authors = ["Sebastian Beyvers", "Jannis Hochmuth", "Lukas Brehm", "Frank Förster", "Maria Hansen"]
language = "en"
multilingual = false
src = "src"
title = "Presentations by the Aruna project"


[preprocessor.alerts]
3 changes: 3 additions & 0 deletions src/SUMMARY.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
# Summary

- [Introduction](./introduction.md)
Binary file added src/assets/aruna_white_font.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
20 changes: 20 additions & 0 deletions src/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
<p align=center>
<img width=250 src="assets/aruna_white_font.png" alt="The Rust logo">
</p>

Welcome to our repo with additional information for our presentations.
This is intended to give a blog-like deeper inside on the presented topics and additional examples, contexts and more.

If you are looking for technical documentation for aruna please click [here](https://arunastorage.github.io/documentation/v2.0.x/).


> [!NOTE]
> Click here to see our latest KubeCon + CloudNativeCon information

## License

This work is licensed under a
[Creative Commons Attribution-NoDerivs 4.0 International License](https://creativecommons.org/licenses/by-nd/4.0/).

![image](https://licensebuttons.net/l/by-nd/4.0/88x31.png)

0 comments on commit 082a054

Please sign in to comment.