utnkar / documentation

Documentation on the UTN IT infrastructure, hosted on docs.utn.se

UTN Documentation

Welcome to the official documentation for the Uppsala Union of Engineering and Science Students (UTN) IT infrastructure. Our goal is to provide a centralized resource detailing all digital systems and activities within UTN, such as the main website, email services, and individual section websites.

Access the published documentation at: docs.utn.se.

Set Up

To get started, clone the repository using git clone --recursive link_to_this_repository.

This site is built with Hugo. Once Hugo is installed, simply run hugo in the project directory to generate HTML files in the public/ folder, which are then ready for website deployment.

For development convenience, use hugo server to start a local web server that reflects live changes as you work.

Get Involved

Contributions are highly encouraged! If you notice areas for improvement or want to enhance the documentation, please submit an issue or a pull request.

documentation's Issues

Quality check 'Other Applications'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Hall of Fame'

I have no idea but lets go over this page

Quality check 'Guides'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

found problem

I found an error on page blabal

#22

Quality check everything

Our documentation site should give every new utn developer enough information and guidance for them to do their work.
The guides and information needs to be understandable for everyone and not only experienced developers.

We need to go over every thing and make sure that docs is working for it's intended use.
Remove information that is irrelevant.
Replace poor descriptions with clearer and easier ones.
If a topic is hard to explain in text, think if a image or some other kind of media would better describe the problem.

When a problem is found with a page, create a new issue and link it with the parent issue for that page.

In each of the following issues there is a short todo list as a reminder of what to look for. This does not need to be followed religiously.

#17
#18
#19
#20
#21
#22
#23
#24
#25
#26 (Not so sure if this needs any QA but lets check it anyway)
#28

Quality check 'Project Moore'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Delete GleSys info. No longer in use

Remove MFK from google suites

The information about MFK is no longer accurate
https://docs.utn.se/infrastructure/google_suite/

Restructure Project Moore

#28

The information about project moore should introduce a new developer into what project moore is(it kinda does) but also how to start contributing to the project. Today it jumps straight into how one goes about adding new roles and opening a "sök" at apply.utn.se etc.

This should be reorganized so that it is easier to navigate, smoother introduction for new developers, and evaluated by a non-expert.

Documentation for roletype styrelsen is incorrect

Styrelsen recently got changed so that they can see everything for role types presidium, group leader and engaged. It was changed in this PR UTNkar/moore#507

Investigate if *Mobile Application* is superfluous

No mobile apps are currently in use or in development. Thus it's at the moment redundant.

Add info in README.md about wsl2 and postgres

Postgresql does not start automatically for WSL2 ubuntu users.

Need to run the command
''sudo service postgresql start''

Quality check 'Registration system'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Bocken - Journal System'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Infrastructure'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Add 2022 Spring Presidium to Hall of Fame

Quality check 'Development Tools

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Server Software'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Mobile Application'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?

Quality check 'Developing for UTN'

• Are the instructions easy to follow?

• Is the information correct and valid today?

• Check if the information should be placed somewhere else or if it's location is good

• Are the instructions easy enough for a complete beginner? If not, do they redirect or give tips of where to get more information?