Giter Club home page Giter Club logo

website's Introduction

Nebula Labs Home Site

Contributor Covenant

A place for core Nebula Labs documentation.

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

Installation

If you only need to view the website, see the Nebula Labs Home page

To build this project, you will need a working Node.js installation, preferably Node.js 12 or later.

All of the commands used to run this project can interchange Yarn for NPM if desired.

First, clone the repository.

Then install the dependencies:

npm install

Now start the local development server:

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.

Deployment

First, build the website to compile the resources into a servable static bundle:

npm run build

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

This project uses Netlify to automatically build and deploy the website, but the build folder can be deployed anywhere static assets can be served.

website's People

Contributors

williecubed avatar taliadev avatar dependabot[bot] avatar adammcadamson avatar eboysen avatar michellekelman avatar spaceface16518 avatar tikenov avatar charliemahana avatar ryan-radloff avatar md-y avatar

Stargazers

Ethan Reece avatar Jason Antwi-Appah avatar  avatar Connor Winston avatar Shaurya Dwivedi avatar  avatar Jack Myrick avatar  avatar  avatar

Watchers

James Cloos avatar  avatar Ben Wang avatar Lisa Wu avatar

website's Issues

[Bug Report] "Project Nebula" text is truncated on Safari

Expected Behavior

On Safari, the "Project Nebula" text next to the logo in the website nav bar is truncated. On Chrome, the full text appears as expected. on Safari, the "Project Nebula" text should also be not truncated and should take up the necessary horizontal space.

Bug Description

On Safari, the "Project Nebula" text is truncated. This seems to only happen on Safari, and does not happen on Chrome nor Firefox on macOS.

How to Reproduce

Steps to reproduce the behavior:

  1. Navigate to https://about.utdnebula.com
  2. Observe the text adjacent to the Nebula logo at the top left corner of the page.

Other Information

This issue reproduces on all versions of Safari tested, including mobile and desktop.
Screen Shot 2022-02-17 at 11 35 52 AM

Device Information

Reproduced at least on:
Safari on iOS 15.3.1
Safari on iPadOS 15.4 beta 3
Safari on macOS 12.3 beta 3

[Feature Request] Separate about section into multiple headers

Overview

Project Info and Roles can be their own sections with dropdown menus instead of being nested within the about section.

Proposal

The main website header would have (order and spacing open to discussion):

  • About (Overview, Project Governance, Meetings)
  • Projects (formerly project info)
  • People & Roles (finish the remaining job descriptions)
  • Maintainer Docs
  • Blog
  • GitHub
  • Contact Us / Join Us

[Feature Request] Establish standard naming for projects

Overview

Since all the projects now have codenames or short names, we need to find a way to represent the codenames along with project names on the website.

Proposal

Frontpage project labels:

  • "Codename: Project Name" (ex. "Athena: UTD Grades")
  • "Project Name - Codename"
  • Change the graphics on the project frontpage to codenames and use "Project Name" for labels

Footer and Project Info labels:
Either use the codename / short name or project name.

[Feature Request] Frontpage, footer, and project info project listings

Overview

The order of projects on the frontpage is different from the order of the projects in the footer and About->Project Info. The footer is also missing Comet Circle / Course Heatmap.

Proposal

A new order for project lists needs to be decided on and changed for the frontpage project links, footer project links, and project info organization.
Order proposal (open to discussion):

  1. Nebula Planner
  2. UTD Survival Guide
  3. UTD Grades: Athena
  4. Nebula API
  5. Course Heatmap

Supplementary Information

While updating the order, it might be beneficial to rename all the projects using a standard label format (see issue #18).

[Feature Request] Add search functionality to website

Overview

The Project Nebula website is meant to be an entry point for all important Project Nebula information, including references for brand guidelines and information on how contributors can get involved.

Ideally, a website visitor should be able to visit the website, type into a search bar, and get links to relevant information for maintainers or project documentation.

Proposal

Docusarus makes search easy. In short, we'll follow the framework's documentation, which includes information on how to set this up using Algolia, a search index provider. The best part? It's free for open-source projects, and we're definitely open source.

Whoever is assigned to this issue would likely have to work with @CharlieMahana or myself (but preferably the former ;)) to set up Algolia from the admin side.

Supplementary Information

Ideally, all pages and headings should be indexed. I'm pretty sure Algolia can support this.

[Feature Request] Replace footer logo

Overview

The logo in the footer is transparent, and there is not enough contrast between the logo and background (both light and dark modes).

Proposal

Remove logo transparency.
Change logo text to match the header logo:

  • Light mode - black text
  • Dark mode - white text

[Feature Request] Change frontpage graphics

Overview

The graphic for each project on the frontpage need to be updated to represent each individual project while following the Project Nebula color scheme.

Proposal

Design team needs to produce new graphics for each product that can be used throughout the website.
The graphics need to be updated on the frontpage.

[Feature Request] Remove double menu option

Overview

On pages with sidebars, when the window size is decreased there are two menu options (header in top left corner and sidebar in bottom right corner).

Proposal

The header menu option is necessary throughout all website pages so it should stay the same.
The sidebar menu option needs to be changed, a few ideas (open to discussion):

  • A table of contents at the top of the page with links to each subpage (as well as a back button)
  • A second menu icon in the top left corner with a different icon style

Respect system theme for dark/light mode

Overview

The website currently has a dark mode switch, but it defaults to using the light theme. It would be ideal if a user didn't have to update the switch to view the website in their preferred color scheme.

Proposal

The website should respect the user's color scheme (dark/light). Specifically, it should use the browser's built-in color scheme (dark/light) and use the system theme.

Supplementary Information

The Docusaurus docs should give enough information to resolve this.

Also, shout-out to @Jake3231 for catching this!

[Feature Request] Move contact page to top-level route

Overview

The contact page is buried in the /docs/about/projects/contact, which makes the url ugly and more difficult to type. The contact page should be a top-level destination and more accessible.

Proposal

  • Move the contact page in the docs folder such that the slug for the contact page is accessible at /contact

[Feature Request] Show current project milestones on website

Overview

As a general member of the Project Nebula community, I would like to see GitHub milestones for upcoming releases on the Project Nebula website.

Proposal

  • Each project should have the milestones from its associated repositories visible on the page. For example, I would be able to navigate to Planner's product page and see a link to the Version 1.0.0 milestone (https://github.com/UTDNebula/planner/milestone/2)
  • The milestones should be fetched from a dynamic source - ideally using the GitHub API. Using this approach, each of the issues associated with the milestone should have their information displayed on the page, as well.

Supplementary Information

TODO: Include mock-up

[Feature Request] Frontpage text color contrast

Overview

Change colors / text contrast on the website frontpage.

Proposal

In light mode, white text is difficult to see on the light purple background. Change all text on the light purple background to black (or another dark color) by default.

[Feature Request] Add Instagram account to website

Overview

Add the Project Nebula Instagram (@UTDNebula) to the website.

Proposal

For now, we should add a link directly to our Instagram profile page somewhere on the Homepage as well as in the footer under "Community".

Supplementary Information

In the future, we can integrate our feed into our website on the homepage so users don't have to visit Instagram to see our latest posts.

[Feature Request] Change / update footer community links

Overview

Change "Project Discussion" label and add additional links under "Community" label.

Proposal

Change "Project Discussion" to "GitHub Project Discussion".
Add UTDNebula GitHub link and interest form link under under the "Community" label.

Proposed ordering of links:

Community

  • Code of Conduct
  • UTDNebula Github
  • Github Project Discussion
  • Interest Form

[Feature Request] Recruiting role descriptions

Overview

Finish all the role descriptions and add under the Roles section for future recruiting cycles.

Proposal

Positions that are currently missing:

  • Head of Project Nebula
  • Head of Marketing
  • Head of Outreach / Recruiting
  • Head of Engineering (rename Engineering Lead)
  • Data Analyst
  • Project Lead (General)
  • Content Writer

Order of roles must be determined as well.

Contributor "boot camp"

Overview

Project Nebula requires a lot of contributions from a lot of people, but we need to ensure that everyone working on our projects is given enough information and support so they can contribute as easily as possible. Given the turnover of students working on our projects, we should create a set of resources to quickly onboard contributors and to contributors' gaps in knowledge.

Proposal

As a new contributor to Project Nebula, I should be able to learn about the following topics in an accessible, understandable way:

  • #26
  • Software engineering
  • Testing
  • Deployment

Supplementary Information

In the future, the skills taught in this contributor bootcamp could be separated into another website, like bootcamp.utdnebula.com. Much of the information taught in the project is applicable to a wide variety of projects

Also, this may or may not have been inspired by my software engineering class.

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.