Skip to content

Commit

Permalink
clarify upgrading instructions for beta-users
Browse files Browse the repository at this point in the history
  • Loading branch information
hofstef committed Aug 14, 2024
1 parent 42a6644 commit 7e99082
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 10 deletions.
7 changes: 2 additions & 5 deletions _pages/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,11 @@ layout: single
toc: true
toc_sticky: true
---
# Updating to the Latest Version

If you have used one of the `v2.0.0-beta` versions or the latest build (`v2.x.x.-dev`), we recommend clearing your local browser storage and then reloading the page. This will reset your icon configuration to default and delete the automatically saved drafts. Instructions:
- [Firefox](https://support.mozilla.org/en-US/kb/clear-cookies-and-site-data-firefox#w_clear-cookies-for-the-current-website)
- Chrome: In the address bar, click the button in the left corner (*show website information*), then *cookies and website date*, *manage website data*, and delete the data for egon.io.

# Changelog

> Have you used *v2.0.0-beta* or *latest build*? Please follow these [instructions](https://egon.io/howto#launching-egon) before using the *v2.0.0* or newer.
## Latest Build

Note: Yet to be released changes appear here.
Expand Down
2 changes: 2 additions & 0 deletions _pages/home.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,8 @@ excerpt: "A lightweight tool to support [*Domain Storytelling*](https://domainst
[<i class="fas fa-play"></i> Use latest build*](app-latest){: .btn .btn--primary .btn--x-large}
*) only recommended for testing new features

> Have you used *v2.0.0-beta* or *latest build*? Please follow these [instructions](https://egon.io/howto#launching-egon) before using the *current* version.
[<i class="fas fa-book"></i> Changelog](/changelog){: .btn .btn--info .btn--x-large}
[<i class="fas fa-code"></i> Source](https://github.com/WPS/domain-story-modeler){: .btn .btn--info .btn--x-large}
[<i class="fas fa-portrait"></i> Examples](https://github.com/WPS/egon.io-examples){: .btn .btn--info .btn--x-large}
Expand Down
21 changes: 16 additions & 5 deletions _pages/howto.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,28 @@ There is no login or registration required to use Egon. Egon runs completely in

## Launching Egon

Egon is available as...:
- [Online version](https://egon.io/): Just click *Use Online* and start modeling.
- Docker image: tbd

Developers have more options, see developer's [readme](https://github.com/WPS/egon.io/).
### Online

We provide an [online version](https://egon.io/) on our webpage. Just click *Use Online* and start modeling.

> **Updating to the latest version:** If you have used one of the `v2.0.0-beta` versions or the latest build (`v2.x.x.-dev`), you need to clear your local browser storage and then reload the page in order for Egon to load properly. This will reset your icon configuration to default and delete the automatically saved drafts. Instructions:
> - [Firefox](https://support.mozilla.org/en-US/kb/clear-cookies-and-site-data-firefox#w_clear-cookies-for-the-current-website)
> - Chrome: In the address bar, click the button in the left corner (*show website information*), then *cookies and website date*, *manage website data*, and delete the data for egon.io.
### Docker

tbd

<!--
TODO: include this as soon as the Docker container is publicly available
- Docker image: You can run Egon as Docker container using [this image](https://github.com/WPS/egon.io/pkgs/container/egon.io).
-->

### For Developers

Please see the developer's [readme](https://github.com/WPS/egon.io/ on how to build and run Egon on your machine.


## Headline

Click on the headline to change the title of the Domain Story. Add a description to document assumptions (e.g., what has happened before the story starts) and variations (e.g., optional activities). Use `shift`+`enter` to add line breaks to the description.
Expand Down

0 comments on commit 7e99082

Please sign in to comment.