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.

Sign up for GitHub

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

Fix typos and image rendering on documentation site #787

Merged
merged 2 commits into from
Dec 6, 2024
Merged

Fix typos and image rendering on documentation site #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
5170a5d
Fix link to SSI logo for header
phillybroadbent Dec 6, 2024
91899f0
Fix typos in the documentation
phillybroadbent Dec 6, 2024
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
2 changes: 1 addition & 1 deletion docs/_includes/header.html
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<h4 class="d-flex align-items-center">
<img src="img/logo.png" class="img-fluid me-2" alt="Software sustainability institute logo" style="height: 1.5em;">
<img src="{{site.baseurl}}/img/logo.png" class="img-fluid me-2" alt="Software sustainability institute logo" style="height: 1.5em;">
<a class="navbar-brand" href="{{ site.baseurl }}/">{{ site.title }}</a>
{% if site.subtitle %}<small class="d-block m-4">{{ site.subtitle }}</small>{% endif %}
</h4>
4 changes: 2 additions & 2 deletions docs/_posts/2016-12-09-setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ dependencies including Django itself are managed using pip in a Python virtual e

## Dependencies

- Python >= 3.8
- Django == 3.2
- Python >= 3.9
- Django == 4.2
- SQLite 3

Using your preferred package management system ensure Python and Django are installed. We use venv for python
Expand Down
17 changes: 9 additions & 8 deletions docs/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,27 @@
---
layout: default
title: "FAT Documentation"
title: "lowFAT Documentation"
---

# LowFAT User and Developer Guide

Welcome to the documentation of the Software Sustainability Institute's Fellowship Administration Tool (FAT).
Welcome to the documentation of the Software Sustainability Institute's Low effort Fellowship Administration Tool (lowFAT).

## Users
### Fellows
WIP

*See tutorial for claimants*

### Staff
WIP

*See tutorial for staff*

## Developers

LowFAT is open source anyone can make a copy and add remove features. For those looking to add (or remove) functionality
from LowFAT they should follow this guide. For SSI staff , or external contributors, working directly on the LowFAT
repository careful consideration should be paid to the workflow section to ensure adherence to our development practice.
LowFAT is open source, anyone can make a copy and add or remove features. For those looking to add (or remove) functionality
from LowFAT they should follow this guide. For SSI staff, or external contributors, when working directly on the LowFAT
repository, careful consideration should be paid to the workflow section to ensure adherence to our development practice.
*See developers section*

#### License

Expand Down Expand Up @@ -58,7 +59,7 @@ For backing up the database in preparation for a site update.

### Reuse and Redistribution

We wrote FAT to be one of our internal tools, but it is released under the BSD 3-Clause License and you are welcome to re-use it.
We wrote lowFAT to be one of our internal tools, but it is released under the BSD 3-Clause License and you are welcome to re-use it.

**If you have any questions, please open an issue on [GitHub](https://github.com/softwaresaved/lowfat/issues).**

Loading