UoL - BsC Computer Science - Documentation

Welcome to the unofficial UoL's CS Degree Documentation! 👋

This is an open-source project to provide useful information for people who are interested in the programme. It's a full documentation with how-to, useful information, tricks and more.

The main goal is to help people who are new, but hopefully this will be used as a guide for every student independent of their progress on the programme.

Lend us a hand and contribute

You are more than free to contribute, here is what you can do:

• Correct grammar/typos errors
• Translate the documentation to your language.
• Update references, links, data, values and etc to up to date.

How to contribute

The gitflow we're working is:

Branches

• main: Main branch lol (the final code ready for deployment)
• develop: Where all PRs should be sent, very unique commits should be done here (quick fix, typos etc)
• username_My-Language: Translation branches for individual work.
• username_issueNumber: Individual branch for solving issues.

Helping with translation

TO-DO

• Translate all documentation
• Translate navbar, sidebar, and other components
• Translate links, resources and other useful informations

Language Requisites

• Desired language proficiency
• Follow grammar rules

How to translate

Site configuration​

Use the site i18n configuration to declare the i18n locales: You can check here the i18n codes: i18n lang codes

docusaurus.config.js

export default {
  i18n: {
    defaultLocale: 'en',
    locales: ['en', 'pt-br'],
  },

1. Create a new branch with the convention yourusername_langcode (e.x: per-sa_PT-BR)
2. Setup your directory just like this: On the folder i18n, create a folder with the i18n Language Code (e.x FR, PT-BR), create a new folder called docusaurus-plugin-content-docs, create a new folder called current and copy all files from the docs folder to the current folder:

├── i18n
│   ├── i18n language code
│   │   ├── docusaurus-plugin-content-docs
│   │   │   ├── current
│   │   │   │   ├── docs content

Make sure to always sync your branch with develop, commit significant changes and after you're done, create a PR (Pull Request) to develop.

You can only develop one language per environment, so make sure to run the following command:

npm run start -- --locale fr

Installation

This website is built using Docusaurus 2, a modern static website generator.

Clone the project

$  git  clone  https://github.com/my-uol/uol-cs-docs.git

Go to the directory

$  cd  uol-cs-docs/

Install dependencies

$  npm  i

Local Development

$  npm  start

This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.

Build

$  npm  build

This command generates static content into the build directory and can be served using any static contents hosting service.