Giter VIP home page Giter VIP logo

docs's Introduction

Welcome to Yacs!

It's so good to see you!

What is Yacs?

Yacs was created with the goal of making students' lives a little easier. It allows users to avoid the clunky UIs of proprietary Catalog Management and Student Information Systems, replacing these unpleasant experiences with easy browsing and searching of courses, and adds the additional functionality of easy schedule generation, and much more.

But Yacs has grown to be much more than a simple schedule generator. Our mission at Yacs is the following:

  1. To alleviate the stress around academic and extracurricular planning for Students, Faculty and Staff by offering a free, easy-to-use interface to supplement or replace traditional academic information and management systems.
  1. To enable innovative, disruptive applications in the academic space by breaking down proprietary information silos and providing consistent, digestible, Open Data.
  1. To empower students to take control of their academic experience and excel their careers through learning about and contributing to Open Source.

Further, Yacs aims to provide the best experience possible to as many people as possible by serving as many universities as we can. Yacs is built from the ground up to be modular and flexible, and as such can use data from any source, and even combine data from many sources in an intelligent way.

We have made it as easy as possible to connect Yacs to your university, and have designed this process to be accessible to developers of nearly any skill level. Please read through this documentation or contact us if you'd like to bring Yacs to your school, and help us make Yacs as great as it can be.

Yacs owes its creation and continued maintenance to RCOS, the Rensselaer Center for Open Source, and is developed in collaboration with BUGS, NYU's Open Source Club.

About this site

This site is the home of (nearly) all Yacs documentation. Like all Yacs projects, this documentation is free and open source, and lives in our Github.

How to Read These Docs

The Yacs documentation is divided into several sections. Each section and its purpose is described here.

Overview

Start Here! This section contains the about page, which explains what Yacs is, why it exists, where we are, and where we plan to go. This section also contains the Code of Conduct. By participating in the Yacs community, you are agreeing to follow the Code of Conduct. Understanding and following the Code of Conduct is extremely important for the health and success of the project, its contributors, and the Yacs community.

Contributing

Look here if you want to contribute to Yacs, run the software on your machine, or just play around with the source. Here you will find installation instructions, project management information, and tips on how and where to get started.

Architecture

Here you will find the nitty-gritty details about how Yacs works. This is a useful resource if you are looking to tackle a larger issue, or want to work towards bringing Yacs to your university.

User Guides

This section contains user guides specific to each of the roles that use yacs. This section is currenrly under construction.

API Docs

Yacs has a public API! This API can be used to build all sorts of interesting, useful, or silly applications using the power of open data. If you have an idea for something to build using the Yacs API, or are looking for inspiration, we'd love to hear from you!

Afterword

Yacs is an open, safe community, and this site is a living document. So please treat it as such! If you find these docs to be insufficient, or you think you can do better, by all means let us know or open a pull request. We encourage contributions from all, no matter how big or small.

When people help us to feel good about who we are, they are helping us love the meaning of what we create in this life - Mr. Rogers

docs's People

Contributors

a1liu avatar bad-science avatar brianhotopp avatar copperwater avatar kburk1997 avatar richtxo avatar sydtaylo avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

docs's Issues

Getting Started Page

Create a page instructing developers on how to get started contributing to Yacs. This should include key repositories, installation instructions, etc.

Cover Page

Create a cover page, welcoming new users to the project.

The page should include:

  • The title of the project (duh)
  • A tagline
  • Key link(s)
  • A backdrop image that somehow represents Yacs
  • (when we have one) a logo

Architecture Page

Create Architecture page with diagrams of service-level architecture, and good descriptions of each.

404 Error when clicking Project on https://yacs.io

From issue 410 which was in the wrong repo

Describe the bug
There is what appears to be a GitHub 404 error.

To Reproduce
Steps to reproduce the behavior:

  1. Go to yacs.io
    
  2. Click on Projects in the top right corner.
    
  3. 404
    

Expected behavior
I expect it to bring me here.
The GitHub link is already up there though, so I am not exactly sure where it really should go.

Desktop (please complete the following information):

OS: linux
Browser firefox
Version don't know

Intro Page

Create an intro page introducing the project, what it does, and it's goals.

Repository Map Page

We have many repos, and this can get confusing. We need a page mapping each repo to it's purpose.

Get Yacs Page

Create a page with instructions and contact info for getting Yacs at your school!

Improve readability of some documents

I did a readability check of our current documentation as part of the accessibility audit.

As a general guideline, most text should aim for approximately an 8th grade reading level or lower. If that is not possible (e.g. highly technical or academic texts), provide a TL;DR in plain English that is an 8th grade reading level or lower.

The following pages need improvement with regards to readability:

Page Grade Level Flesch Reading Ease Gunning Fog Index
Repository Map 9th grade 54 (fairly difficult to read) 11.7 (hard to read)
Code of Conduct (foreword only) College 37.6 (difficult to read) 16.2 (difficult to read)
Running Yacs (for development) 9th grade 59.8 (standard/average) 11.6 (hard to read)

All other pages so far are at an 8th grade level or below!

About page

This page should live in the overview section. It should explain the motivation for Yacs, a little about it's history, what problems we are trying to solve, and where the project is heading.

Add Table of Contents

The documentation should have a table of contents in the beginning, directing different types of documentation users to where they should go, and how the documentation should be read.

Overview Section

Add Overview section with general information, README, CoC, basic project info

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.