Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: fix spelling and grammatical errors, fix formatting #750

Merged
merged 1 commit into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,10 @@ Runs the app in the development mode.<br>
Lints typescript code and log if there are any errors.<br>
`npm run lint:fix` should be used if you want to fix all auto-fixable errors and warnings.

## Documentation

You can find the full documentation for the User Office project [here](https://userofficeproject.github.io/user-office-core/develop/).

## Contribution and release versioning

Please refer to the [Contribution guide](CONTRIBUTING.md) to get information about contributing and versioning.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/developer-guide/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,6 @@ to release new versions automatically.

All other commit types will trigger no new release.

> **_NOTE:_** When merging the pull requests with `Squash and merge` option on github, the title of the pull request should follow the commit guidelines mentioned above because all the commits are squashed into one commit with title od the PR as a message of the commit. Otherwise when using normal `Merge pull request` the title of the pull request doesn't need to follow the commit guidelines but only the commit messages.
> **_NOTE:_** When merging the pull requests with `Squash and merge` option on GitHub, the title of the pull request should follow the commit guidelines mentioned above because all the commits are squashed into one commit with title of the PR as a message of the commit. Otherwise when using normal `Merge pull request` the title of the pull request doesn't need to follow the commit guidelines but only the commit messages.

_________________________________________________________________________________________________________
2 changes: 2 additions & 0 deletions documentation/docs/developer-guide/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,8 @@ The `.env` file format is supported by the dotenv library, which loads these var

For more detailed information, refer to the [dotenv documentation](https://www.npmjs.com/package/dotenv).

_________________________________________________________________________________________________________

## Environment Variables

### EAM Configuration (ESS-specific)
Expand Down
6 changes: 6 additions & 0 deletions documentation/docs/developer-guide/documentation_changes.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,8 @@ The documentation is built using **MkDocs**, a static site generator specificall
- [MkDocs Official Documentation](https://www.mkdocs.org/)
- [MkDocs Material Theme](https://squidfunk.github.io/mkdocs-material/)

_________________________________________________________________________________________________________

## General Guidelines

When contributing to the documentation, keep the following guidelines in mind:
Expand All @@ -23,6 +25,8 @@ When contributing to the documentation, keep the following guidelines in mind:
- Provide comments in code examples where necessary.
- Check for spelling and grammatical errors; tools like [Grammarly](https://www.grammarly.com/) can be helpful.

_________________________________________________________________________________________________________

## Running the Documentation Locally

To preview your changes locally, follow these steps:
Expand All @@ -34,6 +38,8 @@ To preview your changes locally, follow these steps:

This will start a local server where you can view the documentation in your browser.

_________________________________________________________________________________________________________

## Adding New Pages

If you add a new page, make sure to update the mkdocs.yml file:
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/developer-guide/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

_________________________________________________________________________________________________________

Kubernetes is a platform for automating the deployment, scaling, and operation of containerized applications. Helm is a package manager and simplifies the process of deploying and managing applications on Kubernetes by using pre-configured application packages called Helm charts.
Kubernetes is a platform for automating the deployment, scaling, and operation of containerized applications. Helm is a package manager that simplifies the process of deploying and managing applications on Kubernetes by using pre-configured application packages called Helm charts.

## Repository and Helm Chart

Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/developer-guide/rabbitmq.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ The RabbitMQ exchanges are configured using the `RabbitMQActionConfig` class. Th
exchanges?: string[] | null;
}

**Exchanges:** The exchanges property is an array of strings, each representing the name of a RabbitMQ exchange. These exchanges are where messages related to proposal status changes are sent.
**Exchanges:** The exchanges' property is an array of strings, each representing the name of a RabbitMQ exchange. These exchanges are where messages related to proposal status changes are sent.

_________________________________________________________________________________________________________

Expand Down Expand Up @@ -57,7 +57,7 @@ If no exchanges are configured, the function exits early without performing any

_________________________________________________________________________________________________________

## Frontend Display of RabbitMQ Exchanges
## Frontend display of RabbitMQ Exchanges

On the frontend, the `RabbitMQActionConfig` component is responsible for displaying the RabbitMQ exchanges where messages are sent. This provides users with information of how and where proposal data is routed.

Expand Down
10 changes: 5 additions & 5 deletions documentation/docs/developer-guide/step-by-step.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ________________________________________________________________________________

![System overview](../assets/images/sbs_overview.png)

Use this page to understand how different parts of the User Office code base is interconnected.
Use this page to understand how different parts of the User Office code base are interconnected.

As an example, we will implement an imaginary feature that enables product owners to give user officers the ability to **lock out a user**.

Expand All @@ -28,11 +28,11 @@ Start by adding a new column `is_locked` to the database by creating a new file

### Code changes

Now that we have DB column, let’s write a function in our datasource layer that will update the database.
Now that we have a DB column, let’s write a function in our datasource layer that will update the database.

#### 1. Create new database interface function

Add a new interface function under `/src/datasources/AdminDataSource.ts`. The Interface function will accept one parameter user_id, and return a value object of type BasicUserDetails containing the user who was locked out.
Add a new interface function under `/src/datasources/AdminDataSource.ts`. The interface function will accept one parameter user_id, and return a value object of type BasicUserDetails containing the user who was locked out.

lockUser(user_id: number): Promise<BasicUserDetails>;

Expand Down Expand Up @@ -60,7 +60,7 @@ Add the function to handle the database request in the file by implementing the

#### 3. Implement the interface in mockups

Also implement the interface in mockup db in `/src/datasources/mockups/AdminDataSource.ts`. Mockup DB layer is used in unit tests.
Also implement the interface in mockup DB in `/src/datasources/mockups/AdminDataSource.ts`. Mockup DB layer is used in unit tests.

async lockUser(
user_id: number
Expand All @@ -70,7 +70,7 @@ Also implement the interface in mockup db in `/src/datasources/mockups/AdminData

#### 4. Add function to logic layer for handling requests

With the database layer now ready, it's time to implement a mutation. Mutations contains database error handling, authorization and other important business logic. Procees by navigating to `/src/mutations/AdminMutations.ts` and add a new function.
With the database layer now ready, it's time to implement a mutation. Mutations contain database error handling, authorization and other important business logic. Proceed by navigating to `/src/mutations/AdminMutations.ts` and add a new function.

async lockUser(
agent: User | null, // This is a reference to the currently logged-in user, which will be passed in from resolver in next step.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ ________________________________________________________________________________
* [**How do I clone PDF templates?**](user-guide/user-officer/templates/pdf_template.md#how-do-i-clone-pdf-templates)
* [**How do I archive and unarchive PDF templates?**](user-guide/user-officer/templates/pdf_template.md#how-do-i-archive-and-unarchive-pdf-templates)
* [**How do I import and export PDF templates?**](user-guide/user-officer/templates/pdf_template.md#how-do-i-export-and-import-pdf-templates)
* [**What does #calls mean on PDF templates?**](user-guide/user-officer/templates/pdf_template.md#what-does-calls-mean-on-pdf-templates)
* [**What do #calls mean on PDF templates?**](user-guide/user-officer/templates/pdf_template.md#what-does-calls-mean-on-pdf-templates)

??? info "**Proposal Templates**"
### **Proposal templates**
Expand Down
4 changes: 2 additions & 2 deletions documentation/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ ________________________________________________________________________________

??? info "**A**"
:material-book-open-variant-outline: **Actions**
> Actions refer to specific operations that User Officers can perform on proposals, documents, or other system components. Examples of actions include viewing proposals, editing, cloning, exporting, deleting, archiving, assigning a scientist etc.
> Actions refer to specific operations that User Officers can perform on proposals, documents, or other system components. Examples of actions include viewing proposals, editing, cloning, exporting, deleting, archiving, assigning a scientist, etc.

:material-book-open-variant-outline: **Access token**
> An access token is a security credential used to authenticate and authorize users or applications to access specific resources within the User Office system. It is issued upon successful login or authentication and is used to verify the identity of the requester and their permissions for accessing various functionalities or data.
Expand All @@ -16,7 +16,7 @@ ________________________________________________________________________________
> API Access Tokens are unique identifiers used to authenticate and authorize API requests to the User Office system. They enable secure interaction between external applications and the User Office by allowing programmatic access to its features and data, ensuring that only authorized applications can perform actions or retrieve information.

:material-book-open-variant-outline: **App Settings**
> App Settings refer to the configuration options that allow User Officers to customize the behaviour and appearance of User Office. These settings include timezone, date format and pallette colour settings to customuse the User Interface.
> App Settings refer to the configuration options that allow User Officers to customize the behavior and appearance of User Office. These settings include time zone, date format and palette colour settings to customize the User Interface.

:material-book-open-variant-outline: **Archive**
> Archive is an action which allows User Officers to store templates that are no longer actively used but need to be kept for reference. Archiving helps in managing system performance and data organization by separating current, active information from older records.
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/quick_start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

________________________________________________________________________________________________________

For a demo or a temporary account, please contact [Fredrik Bolmsten](mailto:fredrik.bolmsten@ess.eu).
For a demo or temporary account, please contact [Fredrik Bolmsten](mailto:fredrik.bolmsten@ess.eu).

Alternatively, you can run it locally by following [this guide](developer-guide/running_locally.md).

Expand Down
Loading
Loading