Skip to content
This repository has been archived by the owner on May 11, 2021. It is now read-only.

Minor optimizations #39

Merged
merged 11 commits into from
Sep 18, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 19 additions & 48 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,73 +2,44 @@

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.
In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:
Examples of behavior that contributes to creating a positive environment include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members
- Using welcoming and inclusive language
- Being respectful of differing viewpoints and experiences
- Gracefully accepting constructive criticism
- Focusing on what is best for the community
- Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting
- The use of sexualized language or imagery and unwelcome sexual attention or advances
- Trolling, insulting/derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others' private information, such as a physical or electronic address, without explicit permission
- Other conduct which could reasonably be considered inappropriate in a professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.
Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.
This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at david@netlify.com. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at `organizers@techqueria.org`. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.
Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[homepage]: http://contributor-covenant.org [version]: http://contributor-covenant.org/version/1/4/
72 changes: 72 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,20 @@
# Contributing

<!-- TOC -->

- [Steps](#steps)
- [Project Tracker](#project-tracker)
- [Tools](#tools)
- [Structure](#structure)
- [Installation](#installation)
- [Live Server](#live-server)
- [Build](#build)
- [Questions?](#questions)

<!-- /TOC -->

## Steps

> To get started...

1. 🍴 [Fork this repo](https://github.com/techqueria/website#fork-destination-box)
Expand All @@ -16,6 +31,63 @@ Or just [create an issue](https://github.com/techqueria/website/issues) - any li

We are using [Waffle.io](https://waffle.io/techqueria/website) to track open issues and progress being made.

## Tools

This website uses [Hugo](https://gohugo.io/) as the static site generator and [Gulp](https://gulpjs.com/) + [Webpack](https://webpack.js.org/) as the asset pipeline.

The website is hosted and deployed by [Netlify](https://netlify.com).

The asset pipeline uses [PostCSS](http://postcss.org/) and [Babel](https://babeljs.io/) for Sass and JavaScript compilation and transpilation.

## Structure

```text
├── CNAME // domain
├── CODE_OF_CONDUCT.md // code of conduct
├── CONTRIBUTING.md // how to contribute
├── LICENSE // license
├── README.md // overview
├── gulpfile.babel.js // configuring build process for assets
├── netlify.toml // configuration for Netlify deployment
├── package.json // managing NPM packages
├── dist // static files generated and served through Netlify using npm start or npm build
├── site
| ├── archetypes // default post formats
| ├── config.toml // configuration file (Hugo)
| ├── content // content goes here (Markdown files with posts and pages)
| ├── layouts // HTML Liquid templates for pages
| └── static // files that go into root of dist directory
├── src
| ├── img // images are optimized through Gulp
| ├── js // compressed and transpiled to single JS file
| └── sass // compressed and compiled to single CSS file
└── webpack.config.js // build configuration that works in tandem with Gulp
```

## Installation

```bash
npm i
```

## Live Server

```bash
npm start
```

This will automatically open a browser tab with the website and BrowserSync will automatically reload the CSS or refresh the whole page, when stylesheets or content changes.

## Build

To build a static version of the website inside the `/dist` folder.

This command is not generally needed for local development as it is just used to handle deployments through Netlify.

```bash
npm run build
```

## Questions?

We have a dedicated `#website` channel within the Slack group where you can bring up questions, comments, concerns or general feedback.
Expand Down
54 changes: 0 additions & 54 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,6 @@

Website for [Techqueria.org](http://techqueria.org/), a community of Latinx professionals in the tech industry.

## Installation

```bash
npm i
```

## Development

### Live Server

```bash
npm start
```

This will automatically open a browser tab with the website and BrowserSync will automatically reload the CSS or refresh the whole page, when stylesheets or content changes.

### Build

To build a static version of the website inside the `/dist` folder.

This command is not generally needed for local development as it is just used to handle deployments through Netlify.

```bash
npm run build
```

## Usage

This website uses [Hugo](https://gohugo.io/) as the static site generator and [Gulp](https://gulpjs.com/) + [Webpack](https://webpack.js.org/) as the asset pipeline.

The website is hosted and deployed by [Netlify](https://netlify.com).

The asset pipeline uses [PostCSS](http://postcss.org/) and [Babel](https://babeljs.io/) for Sass and JavaScript compilation and transpilation.

### Structure

```text
├── dist // Static files generated and deployed (.gitignore)
├── gulpfile.babel.js // Build processes for assets
├── netlify.toml // Netlify deployment configuration
├── package.json // NPM packages to install
├── site // Hugo site that is built
| ├── archetypes // Default templates
| ├── config.toml // Hugo configuration file
| ├── content // Content goes here (Markdown files with posts and pages)
| ├── layouts // Layouts for pages and posts (Liquid HTML templates)
| └── static // Any static files that go into root of dist directory
├── src // Go to assets directory in dist
| ├── img // Optimized through gulp configuration
| ├── js // Compressed and transpiled to single JS file
| └── sass // Compressed and compiled to single CSS file
└── webpack.config.js // Webpack configuration
```

## Contributing

> To get started...
Expand Down
46 changes: 22 additions & 24 deletions gulpfile.babel.js
Original file line number Diff line number Diff line change
@@ -1,8 +1,6 @@
import autoprefixer from "autoprefixer";
import BrowserSync from "browser-sync";
import {
spawn
} from "child_process";
import {spawn} from "child_process";
import cssnano from "cssnano";
import del from "del";
import log from "fancy-log";
Expand All @@ -23,7 +21,7 @@ import webpackConfig from "./webpack.config";
const browserSync = BrowserSync.create();

// Hugo arguments
const hugoArgsDefault = ["-d", "../dist", "-s", "site", "-v"];
const hugoArgsDefault = ["-d", "../dist", "-s", "site", "-v", "-F"];

// Development tasks
gulp.task("hugo", (cb) => buildSite(cb));
Expand All @@ -34,32 +32,32 @@ gulp.task("build", ["clean", "hugo", "sass", "js", "img", "static"], (cb) => bui
// Compress SASS
gulp.task("sass", () =>
gulp
.src("./src/sass/styles.scss")
.pipe(
sass({
outputStyle: "compressed"
}).on("error", sass.logError)
)
.pipe(postcss([autoprefixer(), cssnano(), csso()]))
.pipe(sourcemaps.write("."))
.pipe(gulp.dest("./dist/assets/css"))
.pipe(browserSync.stream())
.src("./src/sass/styles.scss")
.pipe(
sass({
outputStyle: "compressed"
}).on("error", sass.logError)
)
.pipe(postcss([autoprefixer(), cssnano(), csso()]))
.pipe(sourcemaps.write("."))
.pipe(gulp.dest("./dist/assets/css"))
.pipe(browserSync.stream())
);

// Compress images
gulp.task("img", () =>
gulp
.src("./src/img/**/*")
.pipe(imagemin())
.pipe(gulp.dest("./dist/assets/img"))
.src("./src/img/**/*")
.pipe(imagemin())
.pipe(gulp.dest("./dist/assets/img"))
);

// Copy static files
gulp.task("static", () =>
gulp
.src("./src/static/**/*")
.pipe(gulp.dest("./dist/assets"))
.pipe(browserSync.stream())
.src("./src/static/**/*")
.pipe(gulp.dest("./dist/assets"))
.pipe(browserSync.stream())
);

// Clean up dist
Expand All @@ -76,7 +74,7 @@ gulp.task("js", () => {
"[webpack]",
stats.toString({
colors: true,
progress: true
progress: true,
})
);
browserSync.reload();
Expand All @@ -87,8 +85,8 @@ gulp.task("js", () => {
gulp.task("server", ["hugo", "sass", "js", "img", "static"], () => {
browserSync.init({
server: {
baseDir: "./dist"
}
baseDir: "./dist",
},
});
watch("./src/sass/**/*.scss", () => {
gulp.start(["sass"]);
Expand All @@ -112,7 +110,7 @@ function buildSite(cb, options, environment = "development") {
const args = options ? hugoArgsDefault.concat(options) : hugoArgsDefault;
process.env.NODE_ENV = environment;
return spawn(hugoBin, args, {
stdio: "inherit"
stdio: "inherit",
}).on("close", (code) => {
if (code === 0) {
browserSync.reload();
Expand Down
10 changes: 5 additions & 5 deletions site/archetypes/default.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: {{ replace .TranslationBaseName "-" " " | title }}
date: {{ .Date }}
title: { { replace .TranslationBaseName "-" " " | title } }
date: { { .Date } }
description: ''
# Featured image hosted on Imgur
banner: ''
# (Optional) Caption for banner image.
image: ''
# (Optional) Caption for image.
caption: ''
# (Optional) Link the featured image points to.
bannerLink: ''
imageLink: ''
# (Optional) Link this post redirects user to.
link: ''
# Not ready for publishing
Expand Down
7 changes: 2 additions & 5 deletions site/content/about.md → site/content/about/_index.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
title: About 🌮️
description: Techqueria is a community of Latinx professionals in the tech industry that was first established in 2016.
sortByTitle: true
---

## Who we are
Expand Down Expand Up @@ -51,8 +52,4 @@ Feel free to learn how to contribute using the section below.
- [Frances Coronel](https://www.linkedin.com/in/fvcroductions), a software engineer at Slack
- [David Silva](https://linkedin.com/in/dvidsilva), co-founder of Techqueria and senior developer at Slingshot Health

# You can also learn more about our partners and sponsors on our [sponsors page](/sponsors/).

# Branding

Find more about our brand, image and guidelines for our website in our [branding](/branding) page.
## More about us
2 changes: 1 addition & 1 deletion site/content/branding.md → site/content/about/brand.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: Branding 🎨
title: Brand 🎨
description: Download our assets and discover our style guide.
---

Expand Down
6 changes: 4 additions & 2 deletions site/content/communities/_index.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
---
title: Communities 👥️
description: Our online communities provide a space to communicate with each other, post about job offers, ask for career advice, share events, music and even recipes!
description: Opportunities to network and connect with other Latinx in tech.
url: /communities/
---

If want to add a community, feel free to open a PR on [GitHub](https://github.com/techqueria/website).
## Networking

Our online communities provide a space to communicate with each other, post about job offers, ask for career advice and share events, music and even recipes!
Loading