From 297138600106c434b84f4956c5713a07d6e2a858 Mon Sep 17 00:00:00 2001 From: NewUser-Dot-JPG Date: Tue, 10 Oct 2023 14:56:23 +0200 Subject: [PATCH] Improvements on readablilty and fixing links Fixed some links and also added a few reading clarifications. --- docs/conceptual/theory.md | 8 ++++---- docs/guides/frequently-asked-questions.md | 4 ++-- docs/landingpage/5-contributor.md | 5 +++-- docs/research.md | 2 +- 4 files changed, 10 insertions(+), 9 deletions(-) diff --git a/docs/conceptual/theory.md b/docs/conceptual/theory.md index 42494f3a0..b1b916dcc 100644 --- a/docs/conceptual/theory.md +++ b/docs/conceptual/theory.md @@ -23,7 +23,7 @@ the other interfaces. Every system contains a dataset, which represents the state of the system. Every interface produces and consumes events that may change the state of the system. This state is represented in a persistent store, -aka the database [^3]. Events that the system detects may cause the +aka the database. Events that the system detects may cause the state to change. ![Anatomy of an information system](datamigration-Pre-migration.drawio.png) @@ -37,7 +37,7 @@ database management systems refer to as integrity rules. The purpose of integrity rules is to keep the constraints they represent satisfied. -An *information system* is a combination of dataset, schema, and functionality. Each is defined in a separate section. +An [information system](#information-systems-sctinformation-systems) is a combination of dataset, schema, and functionality. Each is defined in a separate section. ## Datasets {#sct:Datasets} @@ -203,7 +203,7 @@ As before, a suffix disambiguates the elements of this definition when needed. *An information system $\mathscr{S}$ is a tuple $\langle\mathscr{D},\mathscr{Z},\mathcal{O},\text{\it maint}\rangle$, -in which* +in which:* - *dataset $\mathscr{D}=\langle{\mathcal{T}},{\text{\it inst}}\rangle$ as @@ -352,7 +352,7 @@ so this is a dataset $\mathscr{D}$ as introduced before. The Ampersand compiler generates a schema $\mathscr{Z}$, which contains -concepts, relations, and rules. It defines the set of concepts: +concepts, relations and rules. It defines the set of concepts: $\mathcal{C}=\{ {\tt Module}, {\tt Course}, {\tt Student}\}$ diff --git a/docs/guides/frequently-asked-questions.md b/docs/guides/frequently-asked-questions.md index 588b506cb..af108df4b 100644 --- a/docs/guides/frequently-asked-questions.md +++ b/docs/guides/frequently-asked-questions.md @@ -10,8 +10,8 @@ Some questions in this page do not have an answer yet. Please consider that as o * How can I inspect the database underneath an Ampersand application? ## Deployment -* How can I deploy an Ampersand application on my laptop? -* How can I deploy an Ampersand application on a virual machine (i.e. a server) +* [How can I deploy an Ampersand application on my laptop?](installing-ampersand.md) +* [How can I deploy an Ampersand application on a virual machine (i.e. a server)](installing-ampersand.md) * How can I deploy an Ampersand application on Kubernetes? ## Data diff --git a/docs/landingpage/5-contributor.md b/docs/landingpage/5-contributor.md index 77499d681..ae8112cca 100644 --- a/docs/landingpage/5-contributor.md +++ b/docs/landingpage/5-contributor.md @@ -6,12 +6,13 @@ title: For contributors Many people have contributed to the Ampersand project in the past, each in her or his own way. We're very proud of the results and we are amazed daily of the software that tiny specifications can produce. -If you want to be part of it, contact [stefjoosten]() on Github to discuss your contribution. +If you want to be part of it, contact [stefjoosten]() on Github to discuss your contribution. Here are some links that are useful for contributors. ## Ordina A-team -If you are allready part of the Ordina A-team, you can find [onboarding documentation here](../guides/onboarding.md). +If you are already part of the Ordina A-team, you can find [onboarding documentation here](../guides/onboarding.md). + ## The tools we use - [Best Practices](../guides/best-practices) describe the do's and don'ts that every contributor should know before committing a contribution. diff --git a/docs/research.md b/docs/research.md index 6da4a8e21..60d1f7a02 100644 --- a/docs/research.md +++ b/docs/research.md @@ -60,7 +60,7 @@ Stef Joosten, [Rekenen met Taal](https://www.researchgate.net/publication/236340 The application [RAP](https://rap.cs.ou.nl) was built as an educational tool, and developed further into a tool in which anyone can build and run their own prototypes. -The project has contributed to the development of applications in relation algebra, which has lead to numerous publications in the [International Conference of Relation Algebraic Methods in Computer Science](http://www.ramics-conference.org). +The project has contributed to the development of applications in relation algebra, which has lead to numerous publications in the [International Conference of Relation Algebraic Methods in Computer Science](https://ramics20.lis-lab.fr/). Numerous students at the Open Universiteit have graduated in the context of Ampersand.