Skip to content

Commit

Permalink
additional readme, some graphics
Browse files Browse the repository at this point in the history
  • Loading branch information
gernotstarke committed Dec 13, 2023
1 parent 610598d commit 4ebb2d8
Show file tree
Hide file tree
Showing 6 changed files with 41 additions and 13 deletions.
30 changes: 17 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,23 +6,27 @@ This repository is organized as follows:
![main folders of this repo](documentation/0-repo-overview.drawio.svg)


## Overview
## Development and Feature Planning

![context diagram](documentation/3-context-status-arc42-org.drawio.png)

### Explanation
Upcoming features and are planned with a [GitHub project](https://github.com/orgs/arc42/projects/5/views/1)

| Element | Description |
| --- | --- |
| Plausible.io | This (commercial) service collects usage data. We access via their API |
| GitHub | Bug- and Issue-counter, plus additional repository status. Access via GraphQL |
| Fly.io | Our cloud provider (aka hyperscaler). We query the geographical region from their API.|
| Uptimerobot | in planning: Tracks availability of the site(s). API not yet tested.|
| Turso DB | in planning: A distributed, self-replicating SQLite database in the cloud. |
## Supported by INNOQ

API calls are handled via the site-usage-statistics service, located in its own [repository](https://github.com/arc42/site-usage-statistics).
This work is actively supported by [INNOQ Deutschland GmbH](https://innoq.com).

## Development Status + Planning
![Supported by INNOQ](supported-by-innoq.svg)

Upcoming features and current development are planned with a [GitHub project](https://github.com/orgs/arc42/projects/5/views/1)
## Licence

![CC-BY-SA](by-sa.png)

This content is provided _as-is_, without any guarantees.
It is open-source under the [Creative-Commons-ShareAlike 4.0](https://creativecommons.org/licenses/by-sa/4.0/deed.en) licence:

* see the [original text](https://creativecommons.org/licenses/by-sa/4.0/) and the
* [legal details](https://creativecommons.org/licenses/by-sa/4.0/legalcode.en)


Created 2023 by [Dr. Gernot Starke](https://gernotstarke.de) and contributors.

Binary file added by-sa.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/canvas-status-arc42-org.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 documentation/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Documentation Overview

![context diagram](documentation/3-context-status-arc42-org.drawio.png)

### Explanation

| Element | Description |
| --- | --- |
| Plausible.io | This (commercial) service collects usage data. We access via their API |
| GitHub | Bug- and Issue-counter, plus additional repository status. Access via GraphQL |
| Fly.io | Our cloud provider (aka hyperscaler). We query the geographical region from their API.|
| Uptimerobot | in planning: Tracks availability of the site(s). API not yet tested.|
| Turso DB | in planning: A distributed, self-replicating SQLite database in the cloud. |

API calls are handled via the site-usage-statistics service, located in its own [repository](https://github.com/arc42/site-usage-statistics).

## Development Status + Planning

Upcoming features and current development are planned with a [GitHub project](https://github.com/orgs/arc42/projects/5/views/1)

3 changes: 3 additions & 0 deletions go.mod
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module status.arc42.org-site

go 1.21
1 change: 1 addition & 0 deletions supported-by-innoq.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 4ebb2d8

Please sign in to comment.