Skip to content

Commit

Permalink
Improve docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bkis committed Jul 6, 2023
1 parent b002a23 commit 6ca29d3
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 18 deletions.
7 changes: 7 additions & 0 deletions docs/content/concepts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
# Concepts

## Structure Levels
(WIP)

## Data Layers
(WIP)
27 changes: 11 additions & 16 deletions docs/content/index.md
Original file line number Diff line number Diff line change
@@ -1,32 +1,36 @@
# What is Tekst?

Tekst is a collaborative, web-based research platform for aligning, displaying, linking, exploring, and enriching resources on natural language texts (and more). It is developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project on Old Indic texts, where it constitutes the technical basis of the *VedaWeb* research platform.
!!! warning

!!! info "Please note"
Just like Tekst itself, this manual/documentation is still very incomplete and actively worked on.

Tekst is a collaborative, web-based research platform for aligning, displaying, linking, exploring, and enriching resources on natural language texts ([and more](#alternative-use-cases)). It is developed within the scope of the [VedaWeb 2.0](https://vedaweb.uni-koeln.de/) research project on Old Indic texts, where it constitutes the technical basis of the *VedaWeb* research platform.

!!! info

At the moment, the VedaWeb platform is still a custom made application that was developed in an earlier phase of the VedaWeb project. Many of its concepts will find their way into Tekst, but it lacks core features like user management, collaboration and the possibility to work with multiple arbitrarily structured texts. As soon as Tekst is ready, the VedaWeb platform will become the first public instance of Tekst.


## Use Case
## Use Cases

### Philological Research Projects

The main intent for the development of Tekst was to create a technical basis for the online research platform [VedaWeb](https://vedaweb.uni-koeln.de/), where numerous resources on multiple Old Indic Sanskrit texts can be browsed, compared and searched. These include text versions, translations, annotations and references to external sources, which are all aligned to the structure of their respective reference texts.

Therefore, the most obvious use case are comparable research projects that either want to publish and showcase their research data, simply curate a set of established resources on certain reference texts, or even encourage the research community to participate and contribute to a central platform dedicated to provide relevant resources.

### Other
### Alternative Use Cases

The above being said, nothing is stopping you from using Tekst in different contexts. As long as

1. your data revolves around a somewhat structured work or other phenomenon (e.g. book, movie, theatre play or even a simple sequence of years) with one or more [structure levels](#structure-levels)
2. the types of [data layers](#data-layers) Tekst offers match the data you want to work with
1. your data revolves around a somewhat structured work or other phenomenon (e.g. book, movie, theatre play or even a simple sequence of years) with one or more [structure levels](concepts.md#structure-levels)
2. the types of [data layers](concepts.md#data-layers) Tekst offers match the data you want to work with

..., Tekst might be a viable option. In the end, giving it a try on your local machine [is relatively easy](setup.md#using-docker-recommended).

!!! info "Please note"

Despite the alternative use cases mentioned, "texts" are used as an exemplary use case throughout this documentation.
Despite the alternative use cases mentioned, "texts" are used exemplary throughout this documentation **and in the user interface of Tekst**, as this is the main use case for this software.


## Features
Expand All @@ -42,15 +46,6 @@ This list is far from exhaustive, but includes some features that might be decis
- Extensively typed and documented server API (via [OpenAPI](https://spec.openapis.org/oas/v3.0.2) specification) and built-in interactive API documentation (via [Swagger UI](https://github.com/swagger-api/swagger-ui) and/or [ReDoc](https://github.com/Redocly/redoc)), all thanks to [FastAPI](https://github.com/tiangolo/fastapi)


## Concepts

### Structure Levels
(WIP)

### Data Layers
(WIP)


## Caveats

Depending on your requirements, you might want to consider the following list of potential shortcomings:
Expand Down
4 changes: 2 additions & 2 deletions docs/content/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -81,11 +81,11 @@ Read [this](https://docs.docker.com/engine/reference/commandline/compose/) to le

To configure an initial admin account, follow these steps:

1. In your `.env` file, set `TEKST_SECURITY__INIT_ADMIN_EMAIL` (admin account initial email address) and `TEKST_SECURITY__INIT_ADMIN_PASSWORD` (admin account initial password). The Password **must** have at least 8 characters and **must** container at least one of each:
1. In your `.env` file, set `TEKST_SECURITY__INIT_ADMIN_EMAIL` and `TEKST_SECURITY__INIT_ADMIN_PASSWORD`. The Password **must** have at least 8 characters and **must** contain at least one of each:
- lowercase letters
- UPPERCASE LETTERS
- digits 0-9
2. Follow the setup instructions depending on the deployment strategy you chose above.
3. When setup is finished and everything is working, **immediately log in with your initial administrator account and change its password!**

Alternatively, and this is for advanced users, you can leave the two values blank in `.env` and just register a new user via the Webclient as normal. You then have to log into the database modify the documents for this initial account to be activated, verified and a superuser (admin).
Alternativelyand this is for advanced usersyou can leave the two values blank in `.env` and just register a new user via the Webclient as normal. You then have to log into the database and modify the data for this initial account (in the `users` collection) to be activated, verified and a superuser (admin). See the [MongoDB documentation](https://www.mongodb.com/docs/mongodb-shell/) for how to do this.
1 change: 1 addition & 0 deletions docs/mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ repo_name: VedaWebProject/Tekst

nav:
- 'index.md'
- 'concepts.md'
- 'setup.md'

markdown_extensions:
Expand Down

0 comments on commit 6ca29d3

Please sign in to comment.