Skip to content

Commit

Permalink
Update of the documentation to bring it in-line
Browse files Browse the repository at this point in the history
Also added the License (woops) and editorconfig
  • Loading branch information
mirdaki committed Sep 5, 2018
1 parent 6d87281 commit 17db600
Show file tree
Hide file tree
Showing 9 changed files with 102 additions and 127 deletions.
12 changes: 12 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
# EditorConfig helps developers define and maintain consistent
# coding styles between different editors and IDEs
# http://editorconfig.org

root = true

[*]
indent_style = tab
end_of_line = lf
charset = utf-8
trim_trailing_whitespace = true
insert_final_newline = true
36 changes: 18 additions & 18 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,46 +1,46 @@
# Contributing to Open Source Club Website

Thank you for helping out with the UFOSC's club website!
Thank you for helping out with the OSC's club website!

Following these guidelines helps us keep good project workflow. We appreciate you working with us on it.
Following these guidelines helps us keep good project workflow. We appreciate you working with us on it.

Please read our [CODE_OF_CONDUCT.md](CODE_OF_CONDUCT.md) to understand our community expectations. Check out our [Discord](https://discord.gg/Gsxej6u) for any additional questions or just to hangout! Look at our [CONTRIBUTORS.md](CONTRIBUTORS.md) for a list of maintainers and contributors.

## How to help?

Please check the [Projects](https://github.com/ufosc/club-website/projects) and [Issues](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) pages for current task. If you see something that you would like to help with, ask about helping in a comment and we'll assign it too you. If you're just starting out, checkout our **[beginner friendly](https://github.com/ufosc/club-website/labels/good%20first%20issue)** issues for ways to help.
Please check the [Projects](https://github.com/ufosc/club-website/projects) and [Issues](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) pages for current task. If you see something that you would like to help with, ask about helping in a comment and we'll assign it too you. If you're just starting out, checkout our **[beginner friendly](https://github.com/ufosc/club-website/labels/good%20first%20issue)** issues for ways to help.

Checkout the [DESIGN.md](docs/DESIGN.md) file for a high level explanation of the project. For a road map, look at the [TODO.md](docs/TODO.md) which lists planned features for the project. Check out the other files in docs for more information.
Checkout the [DESIGN.md](docs/DESIGN.md) file for a high level explanation of the project. For a road map, look at the [TODO.md](docs/TODO.md) which lists planned features for the project. Check out the other files in docs for more information.

### Report Bug
### Report Bug

Check to see if someone already reported this [bug](https://github.com/ufosc/club-website/labels/bug) already exists. If so then leave a comment on that issue. If not, please provide a detailed description of the bug. Include what was happening before the error, all settings, and test results. This helps us more quickly identify and solve any problems. Create an [Issue](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) with the description and add a bug label. We will do our best to respond quickly to it.
Check to see if someone already reported this [bug](https://github.com/ufosc/club-website/labels/bug) already exists. If so then leave a comment on that issue. If not, please provide a detailed description of the bug. Include what was happening before the error, all settings, and test results. This helps us more quickly identify and solve any problems. Create an [Issue](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) with the description and add a bug label. We will do our best to respond quickly to it.

### Request a Feature

Check to see if the feature is already listed in our [TODO.md](docs/TODO.md). If it's not, describe the feature and why it would be beneficial. Create an [Issue](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) with this description and add a feature enhancement label. We will do our best to respond quickly to it.
Check to see if the feature is already listed in our [TODO.md](docs/TODO.md). If it's not, describe the feature and why it would be beneficial. Create an [Issue](https://github.com/ufosc/club-website/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) with this description and add a feature enhancement label. We will do our best to respond quickly to it.

### Run Test
### Run Test

Open it up in a browser.

### Submit Changes
### Submit Changes

1. Create a fork or branch to tackle a specific issue
- Team members branch off of dev and follow this [guide](https://guides.github.com/introduction/flow/)
1. Create a fork or branch to tackle a specific issue
- Team members branch off of dev and follow this [guide](https://guides.github.com/introduction/flow/)
- Others make a [fork](https://guides.github.com/activities/forking/)
- Name it after the issue or feature you are working on
2. Follow the style guidelines below
2. Follow the style guidelines below
- This helps with debugging and working on the project
3. Make small incremental commits
- It's easier to find issues when only a small amount of code is changed
4. Run and pass tests
5. Make a pull request
4. Verify everything works (and that nothing broke)
5. Make a pull request
- The request will be reviewed
- Any needed changes will be noted
6. The changes will be added to the project
- Any needed changes will be noted
6. The changes will be added to the project
- Yay! Thank you so much for helping out

## Style Guide
## Style Guide

TODO: Add
[OSC general style guidelines ](https://github.com/ufosc/resources/blob/master/coding-guidelines/general-style.md)
17 changes: 10 additions & 7 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,19 @@
# Contributors
# Contributors

Special thanks to all the contributors who volunteered their valuable time to this project.
Special thanks to all the contributors who volunteered their valuable time to this project.

## Maintainers
## Maintainers

Members tasked with maintaining the code and the peace. Message them if there is any issue. Retired maintainers will be noted.

- **Mathew Booe, @mirdaki**
- **Joshua Hew, @CSugarPrince** (Retired)

## Contributors
## Contributors

Some awesome people who have made this project possible.

- **Joshua Hew, @CSugarPrince**
Some awesome people who have made this project possible.

- **Lucas Grinspan, @lucasgrinspan**
- **@juansuh**
- **Paolo Garcia, @paologarcia002**
- **@JING1201**
7 changes: 7 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
Copyright 2018 Open Source Club

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
9 changes: 5 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,13 @@ The website needs to be a central place for
Install
- An internet browser like [Firefox](https://www.mozilla.org/en-US/firefox/new/) or [Google Chrome](https://www.google.com/chrome/index.html)
- A text editor like [VSCode](https://code.visualstudio.com/), [Atom](https://atom.io/), or [Sublime Text](https://www.sublimetext.com/)
- Install an [EditorConfig](https://editorconfig.org/) plugin if available, to help ensure consistent formatting

Then clone this repo
[Then clone this repo](https://help.github.com/articles/cloning-a-repository/)

### Testing
### Testing

Open up the index.html file in a browser by dragging the file from your file explorer into the browser window.
Open up the index.html file (under the website folder) in a browser by dragging the file from your file explorer into the browser window.

## Deployment

Expand All @@ -29,7 +30,7 @@ TBD, probably deploying our own Nginx server.
- **CSS** - Short for Cascading Style Sheets. It defines the look of the page
- **JavaScript** - Not short for anything. It adds the functionality to the page.

Check out the [resources file](docs/resources.md) in docs for a list of links to learn more about these technologies.
Check out the [resources file](docs/resources.md) in docs for a list of links to learn more about these technologies.

## Contributing

Expand Down
49 changes: 40 additions & 9 deletions docs/DESIGN.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,47 @@
# Club Website Design
# Club Website Design

TODO: Fill out
The goal of the redesign is to make a fast and responsive (so it works on devices from phones to desktop monitors) website that provides all the information anyone interested or already in the club needs.

**A paragraph or two giving an overview of the project. Give a brief description of each program. The goal is to quickly get new members up to speed.**
## File Structure

## **Component One**
All of the website code is under the [website folder](../website/).

**Go more in-depth here on each component. Explain the purpose of the component, what technologies it uses, how it interacts with the other components, where it is in the project, and the current state of it. This can be several paragraphs long. The hope is that it answers any questions someone working on this component might have.**
The HTML files are the actual web pages we load. The "index.html" is our homepage (web browsers by default load the index.html file). The names of the other ones should explain their purpose. Each HTML file has the the same header and footer, as they are in each page of the website.

## Resources
The assets folder contains fonts, images, and other files that we use, but aren't code. Both fonts and images have their own folders inside the assets folder.

### **Component One** Links
The styles folder contains the CSS for the website. There is a "unified.css" file that contains all the CSS each web page shares. This way we can make tweaks in one file, and update the styling on all of the pages (for instance the background color). Each of the pages also has a CSS file of it's own (it should have the same name as the HTML file). This has the CSS for the structure of the page, as well as any other page specific styling. The "Font Awesome" font uses some CSS too, so it's files are included in the styles folder as well (with either "fa" or "fontawesome" in the name).

- **Link to useful resources**
- **They can link to in depth information**
Eventually we will have a "scripts" folder to contain any JavaScript for the pages. The naming will be treated the same as the CSS (where shared JavaScript will be in a unified file and each page get's a JavaScript file with the same name as the HTML one).

Finally we have an unfinished folder for pages that haven't been completed yet. Each page has a sub-folder that contains all the assets, styling, and scripting that page needs.

## Web Pages

Below is a breakdown of what should be included in each web page.

- Home
- Greeting
- Mission statement
- An invitation to get involved
- A place to sign up for email notifications
- About
- Description of the club and what it does
- A more in-depth section on how to get started
- History of the club
- Projects
- A list of club projects
- Descriptions, screenshots, members who worked on it, link to it
- Should indicate whether if it's active or not
- Events
- A list of upcoming and past events
- Link to presentations and notes for each
- Link to the Facebook event
- A way to add the event calendar to the users calendar
- Resources
- List of the resource we provide (like those from the GitHub resources folder)
- Could also have officer information (club documents repo)

## User Interface

We are going for a modern style of our website. Some rough drafts of the designs are available in the [references folder](references/) in addition to some [example sites](references/other-sites.md) we took inspiration from.
65 changes: 0 additions & 65 deletions docs/ISSUE_TEMPLATE.md

This file was deleted.

20 changes: 0 additions & 20 deletions docs/TODO.md

This file was deleted.

14 changes: 10 additions & 4 deletions docs/resources.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,14 @@
# Resources
# Resources

Here is a list of links to the club's resource pages on different technologies we are using.

Here is a list of links to the club's resource pages on different technologies.

- [HTML](https://github.com/ufosc/resources/blob/master/resources/html.md)
- [CSS](https://github.com/ufosc/resources/blob/master/resources/css.md)
- [JavaScript](https://github.com/ufosc/resources/blob/master/resources/javascript.md)
- [Git](https://github.com/ufosc/resources/tree/master/resources/git)
- [Git](https://github.com/ufosc/resources/tree/master/resources/git)

## Other

Here are some resources not included in the clubs resource folder.

- [Font Awesome](https://fontawesome.com/)

0 comments on commit 17db600

Please sign in to comment.