diff --git a/api/usage.md b/api/usage.md index 8b1721f..0812157 100644 --- a/api/usage.md +++ b/api/usage.md @@ -109,7 +109,7 @@ name | type | example | desc id | integer | 42 | the id of the resource uuid | string | "b35e6500-2086-4893-affb-8c57ae2bb6b9" | the universally unique id shortname | string | 1200 | the course number or code -tags | array\ | ["uhhhhh"] | the course's tags +tags | array\ | ["uhhhhh"] | the course's tags ### Terms @@ -154,4 +154,3 @@ seats | integer | 40 seats_taken | integer | 20 | the number of students currently registered for this section conflict_ids | array\ | [4, 8, 15, 16, 23] | the ids of all sections that overlap with this section periods | array | [{ "day": 1, "start": 800, "end": 950, type: "LEC"}] | the section's periods. each period has a day of the week, start time, end time, and type - diff --git a/architecture/adapters.md b/architecture/adapters.md index ba77514..39f22f3 100644 --- a/architecture/adapters.md +++ b/architecture/adapters.md @@ -1,5 +1,5 @@ - diff --git a/architecture/overview.md b/architecture/overview.md index d168834..32f2d51 100644 --- a/architecture/overview.md +++ b/architecture/overview.md @@ -82,7 +82,7 @@ While automatically pulling and combining data from various sources is great, we This allows us to correct for out of date sources, add data that isn't present anywhere else, or even use Yacs as a primary catalog and information system. The way core handles overrides is by storing two sets of attributes for each record: `auto_attributes`, and `override_attributes`. -These are both [`jsonb` columns](https://blog.codeship.com/unleash-the-power-of-storing-json-in-postgres/), and are therefore unstructured. +These are both [`jsonb` columns][json-cols], and are therefore unstructured. `auto_attributes` stores the state of the record exactly as it came from malg. `override_attributes` stores, attributes that were set manually, and, you guessed it, overrides `auto_attributes`. @@ -107,3 +107,5 @@ That's how data gets in and out of Yacs. This pipeline was developed through a good amount of trial and error. It is not 100% perfect, but it is simple to develop against, easy to contribute to, and it gets the job done. Pretty neat! + +[json-cols]: https://blog.codeship.com/unleash-the-power-of-storing-json-in-postgres/ diff --git a/architecture/service_map.md b/architecture/service_map.md index 8925e9f..5d2213b 100644 --- a/architecture/service_map.md +++ b/architecture/service_map.md @@ -14,7 +14,7 @@ This is a good place to start if you don't know where something lives, or want t The above diagram shows how each of the services connect. For more in-depth information on how Yacs operates as a whole, see [overview](architecture/overview) -### [core](https://github.com/yacs-rcos/yacs/blob/master/core) +### [core][core-repo] Yacs is currently the largest service. To avoid confusion, we'll call this "Yacs Core", or just "Core". @@ -23,7 +23,7 @@ It provides a REST API for accessing and manually updating this data. Yacs Core is also responsible for generating schedules, and computing section conflicts. It is a Rails 5 app, and uses PostgreSQL to store data. -### [web](https://github.com/yacs-rcos/yacs/blob/master/web) +### [web][web-repo] Yacs Web is the primary student-facing frontend for Yacs. It is written in Typescript with Angular 6. @@ -32,50 +32,61 @@ It provides the interface for browsing, searching, and selecting courses, as wel It will also provide an interface for receiving notifications (planned). If you are a new contributor, this is probably the best place to look for work to do as well. -### [admin](https://github.com/yacs-rcos/yacs-admin) +### [admin][admin-repo] Yacs Admin is the administrative frontend for Yacs. It is an interface for administrators, instructors, and sysadmins to make manual updates to the Yacs database. In practice, it is typically used for correcting errors, updating course details, and managing non-catalog (special topics) courses. -### [malg](https://github.com/yacs-rcos/yacs/blob/master/malg) +### [malg][malg-repo] Yacs Malg is the 'secret sauce' that connects Yacs to your university. It pulls data from JSON data sources, and intelligently and configurably combines (amalgamates) it into a master graph. The graph serialized and stored in Redis for internal persistance, and every entity is written to a Kafka topic as well for further processing and storage. Malg polls each data source at regular intervals, and continually writes changes to Redis and Kafka. -### [adapters](https://github.com/yacs-rcos/yacs/blob/master/adapters) +### [adapters][adapters-repo] Yacs uses services called adapters to pull data from a university's systems, and transform that data into a form Yacs can ingest. Each data source has a corresponding adapter, which, when combined, provide a complete picture of a university's academic data. It is very easy to create new adapters - more information explaining them can be found on the [adapters documentation](https://yacs.io/#/architecture/adapters). They can be written in any language, and must simply respond to a set of http endpoints. -### [users](https://github.com/yacs-rcos/yacs/blob/master/users) +### [users][users-repo] Yacs Users is the user authentication server for Yacs. It is a full stack Rails 5 app, and uses devise for authentication. It also handles storing user data, and provides a REST API for accessing and modifying that data (planned). -### [notifications](https://github.com/yacs-rcos/yacs/blob/master/notifications) +### [notifications][notifications-repo] Yacs Notifications serves the streaming API for changes to Yacs objects. It allows clients to receive notifications regarding courses and sections they are interested in. -### [docs](https://github.com/yacs-rcos/docs) +### [docs][docs-repo] Docs is the repository for this documentation! It uses Docsify, and awesome static site generator that generates beautiful documentation from everyday Markdown files. Because we have a bunch of repos, documentation goes in here so it is easier to find, with the exception of each service's README. -### [nginx](https://github.com/yacs-rcos/yacs-nginx) +### [nginx][nginx-repo] The nginx configuration we use to deploy Yacs. It has reverse proxies for the external APIs and services the frontend builds. -### [auth](https://github.com/yacs-rcos/yacs-auth) +### [auth][auth-repo] Yacs Auth is a microservice authorization library. It contains our authorization logic and session management, which uses JSON Web Tokens (JWT) with Redis for session handling and validation. This library allows any service to authenticate a user and validate or invalidate their session, as long as that service is connected to the shared Redis instance. + +[core-repo]: https://github.com/yacs-rcos/yacs/blob/master/core +[web-repo]: https://github.com/yacs-rcos/yacs/blob/master/web +[admin-repo]: https://github.com/yacs-rcos/yacs-admin +[malg-repo]: https://github.com/yacs-rcos/yacs/blob/master/malg +[adapters-repo]: https://github.com/yacs-rcos/yacs/blob/master/adapters +[users-repo]: https://github.com/yacs-rcos/yacs/blob/master/users +[notifications-repo]: https://github.com/yacs-rcos/yacs/blob/master/notifications +[docs-repo]: https://github.com/yacs-rcos/docs +[nginx-repo]: https://github.com/yacs-rcos/yacs-nginx +[auth-repo]: https://github.com/yacs-rcos/yacs-auth diff --git a/contributors/getting_started.md b/contributors/getting_started.md index 43d48fd..4a438aa 100644 --- a/contributors/getting_started.md +++ b/contributors/getting_started.md @@ -26,13 +26,13 @@ This document will explain how we do things, our development and project managem ### Issues First thing's first: issues! -We use [Github Issues](https://guides.github.com/features/issues/) to keep track of what we need to do. +We use [Github Issues][github-issues] to keep track of what we need to do. Every issue describes a single task, problem, or request. Issues should be small, specific, and well defined. ### Projects -We use [Github Projects](https://help.github.com/articles/about-project-boards/) to keep track of our issues across our multiple services and initiatives (more on this [later](contributors/service_map.md)). Our main project board is the [Core Project](https://github.com/orgs/YACS-RCOS/projects/3). +We use [Github Projects][github-projects] to keep track of our issues across our multiple services and initiatives (more on this [later](contributors/service_map.md)). Our main project board is the [Core Project][core-project]. Issues on this project are organized into five categories: 1) **Needs Review**. Newly created issues go here. @@ -92,8 +92,8 @@ university:rpi | Specific to RPI ## Finding an Issue Now that you see how things work, you are ready to find your first issue! -The [Ready for Development](https://github.com/orgs/YACS-RCOS/projects/3#column-2034428) column on the [Core Project](https://github.com/orgs/YACS-RCOS/projects/3) is a great place to start. -There are a number of issues here labeled [good-first-issue](https://github.com/orgs/YACS-RCOS/projects/3?card_filter_query=label%3A%22good+first+issue%22). +The [Ready for Development][ready-for-development] column on the [Core Project][core-project] is a great place to start. +There are a number of issues here labeled [good-first-issue][good-first-issue-label]. Issues with this label have been selected by the maintainers as good starting points for new contributors. You are not, however, limited to issues with this label by any means! @@ -119,3 +119,10 @@ So now you have something to work on. Congratulations on making it this far! The next step is to get Yacs running on your computer. Check out the [Setup Guide](contributors/setup_guide) for the next steps! + +[github-issues]: https://guides.github.com/features/issues/ +[github-projects]: https://help.github.com/articles/about-project-boards/ +[core-project]: https://github.com/orgs/YACS-RCOS/projects/3 +[ready-for-development]: https://github.com/orgs/YACS-RCOS/projects/3#column-2034428 +[good-first-issue-label]: https://github.com/orgs/YACS-RCOS/projects/3?card_filter_query=label%3A%22good+first+issue%22 +