Skip to content

Commit

Permalink
docs: fix more spelling, formatting, delete redundancies (#755)
Browse files Browse the repository at this point in the history
  • Loading branch information
Oschroder authored Sep 11, 2024
1 parent 9083ba6 commit 62afde1
Show file tree
Hide file tree
Showing 26 changed files with 113 additions and 133 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@
[![Known Vulnerabilities](https://snyk.io/test/github/UserOfficeProject/user-office-core/master/badge.svg?targetFile=package.json)](https://snyk.io/test/github/UserOfficeProject/user-office-core/master?targetFile=package.json)

---
## Documentation

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

## Contributing

If you're planning to contribute to this project by adding new functionality, we encourage you to discuss it first in the Discussions tab. This helps ensure that your proposed changes align with the project's goals and prevents duplicate efforts. Here's how you can initiate a discussion:
Expand Down Expand Up @@ -50,10 +54,6 @@ 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/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ ________________________________________________________________________________

## Handling Dependencies

The User Office software uses dependency injection for services like email and RabbitMQ. To configure these services, you will need to modify the backend’s `configmap` and `secrets`:
The User Office software uses [dependency injection](dependency_injection.md) for services like email and RabbitMQ. To configure these services, you will need to modify the backend’s `configmap` and `secrets`:

- **RabbitMQ Configuration**: Set `RABBITMQ_HOSTNAME`, `RABBITMQ_USERNAME`, `RABBITMQ_CORE_EXCHANGE_NAME` in the `configmap`, and `RABBITMQ_PASSWORD` in the `secrets`.
- **Email Services Configuration**: The platform supports SMTP and Sparkpost. Adjust the dependency configuration as necessary for your environment.
Expand Down
5 changes: 2 additions & 3 deletions documentation/docs/faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ ________________________________________________________________________________
??? info "**Feedback templates**"
### **Feedback templates**
* [**What are feedback templates**](user-guide/user-officer/templates/feedback_template.md#what-are-feedback-templates)
* [**How do I mark a feedback template as active?**](user-guide/user-officer/templates/feedback_template.md#how-do-mark-a-feedback-template-as-active)
* [**How do I mark a feedback template as active?**](user-guide/user-officer/templates/feedback_template.md#how-to-mark-a-feedback-template-as-active)
* [**How do I create feedback templates?**](user-guide/user-officer/templates/feedback_template.md#how-do-i-create-feedback-templates)
* [**How do I edit feedback templates?**](user-guide/user-officer/templates/feedback_template.md#how-do-i-edit-feedback-templates)
* [**How do I import and export feedback templates?**](user-guide/user-officer/templates/feedback_template.md#how-do-i-import-and-export-feedback-templates)
Expand All @@ -93,7 +93,7 @@ ________________________________________________________________________________
### **Proposal workflows**
* [**What are proposal workflows?**](user-guide/user-officer/settings/proposal_workflow.md#what-are-proposal-workflows)
* [**How do I create a proposal workflow?**](user-guide/user-officer/settings/proposal_workflow.md#how-do-i-create-a-proposal-workflow)
* [**How do I edit a proposal workflow?**](user-guide/user-officer/settings/proposal_workflow.md#how-do-i-edit-a-proposal-workflow)
* [**How do I edit a proposal workflow?**](user-guide/user-officer/settings/proposal_workflow.md#how-do-i-create-a-proposal-workflow)

??? info "**FAPs**"
### **FAPs**
Expand All @@ -110,6 +110,5 @@ ________________________________________________________________________________
??? info "**Settings**"
### **Settings**
* [**What are features?**](user-guide/user-officer/settings/features.md#what-are-features)
* [**How do I configure the features?**](user-guide/user-officer/settings/features.md#how-do-i-configure-the-features)

_________________________________________________________________________________________________________
4 changes: 2 additions & 2 deletions documentation/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,7 +252,7 @@ ________________________________________________________________________________
> Sample ESI templates are predefined forms used to collect safety-related information about the samples involved in an experiment.

:material-book-open-variant-outline: **Shipment declaration templates**
> Shipment declaration templates are standardised forms used to collect and organise information about parcels being sent to a facility.
> Shipment declaration templates are standardized forms used to collect and organize information about parcels being sent to a facility.

:material-book-open-variant-outline: **Short code**
> A Short code is a brief identifier used to reference specific items or configurations within the User Office system.
Expand All @@ -261,7 +261,7 @@ ________________________________________________________________________________
> Statuses are labels that indicate the current state or progress of a proposal, request, or other item.

:material-book-open-variant-outline: **Sub templates**
> Sub templates are reusable building blocks containing questions, used to streamline and organise the creation of complex templates.
> Sub templates are reusable building blocks containing questions, used to streamline and organize the creation of complex templates.


??? info "**T**"
Expand Down
2 changes: 1 addition & 1 deletion documentation/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ ________________________________________________________________________________

## Welcome to User Office

The User Office Project is an international collaboration to build flexible web software designed to efficiently run and organize user programs at various scientific facilities.
The User Office project is an international collaboration to build flexible web software designed to efficiently run and organize user programs at various scientific facilities.

We have built this software with flexibility in mind - allowing user officers and user program managers to configure the software to the specific needs of their facility.

Expand Down
Loading

0 comments on commit 62afde1

Please sign in to comment.