-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update readme and create docs folder (#31)
* Update readme and create docs folder - Add staging and deployment information. - Add technologies.md - Add code of conduct that lives in the repo. * Change reference from master to production
- Loading branch information
Showing
4 changed files
with
117 additions
and
56 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| # Code of Conduct | ||
|
|
||
| ## The Quick Version | ||
|
|
||
| Our events and online spaces are dedicated to providing a harassment-free experience for everyone, regardless of gender and gender identity, age, sexual orientation, disability, physical appearance, body size, race, or religion (or lack thereof). We do not tolerate harassment of participants in any form. Sexual language and imagery is never appropriate. Participants violating these rules may be sanctioned or expelled at the discretion of the organizers. | ||
|
|
||
| No weapons of any kind, or drugs are allowed at Write/Speak/Code. | ||
|
|
||
| ## The Less Quick Version | ||
|
|
||
| Write/Speak/Code is dedicated to providing a harassment-free experience for everyone. We do not tolerate harassment of participants in any form. This code of conduct applies to all Write/Speak/Code spaces both online and off. Anyone who violates this code of conduct may be sanctioned or expelled from these spaces at the discretion of the Write/Speak/Code. | ||
|
|
||
| Some Write/Speak/Code spaces may have additional rules in place, which will be made clearly available to participants. Participants are responsible for knowing and abiding by these rules. | ||
|
|
||
| ### Harassment includes: | ||
|
|
||
| - Offensive comments related to gender, gender identity and expression, sexual orientation, disability, mental illness, neuro(a)typicality, physical appearance, body size, age, race, or religion. | ||
| - Unwelcome comments regarding a person's lifestyle choices and practices, including those related to food, health, parenting, drugs, and employment. | ||
| - Deliberate misgendering or use of 'dead' or rejected names. | ||
| - Gratuitous or off-topic sexual images or behaviour in spaces where they're not appropriate. | ||
| - Physical contact and simulated physical contact (eg, textual descriptions like "hug" or "backrub") without consent or after a request to stop. | ||
| - Threats of violence. | ||
| - Incitement of violence towards any individual, including encouraging a person to commit suicide or to engage in self-harm. | ||
| - Deliberate intimidation. | ||
| - Stalking or following. | ||
| - Harassing photography or recording, including logging online activity for harassment purposes. | ||
| - Sustained disruption of discussion. | ||
| - Unwelcome sexual attention. | ||
| - Pattern of inappropriate social contact, such as requesting/assuming inappropriate levels of intimacy with others. | ||
| - Continued one-on-one communication after requests to cease. | ||
| - Deliberate "outing" of any aspect of a person's identity without their consent except as necessary to protect vulnerable people from intentional abuse. | ||
| - Publication of non-harassing private communication. | ||
|
|
||
| ### Write/Speak/Code prioritizes marginalized people's safety over privileged people's comfort and therefore we will not act on complaints regarding: | ||
|
|
||
| - 'Reverse' -isms, including 'reverse racism,' 'reverse sexism,' and 'cisphobia'. | ||
| - Reasonable communication of boundaries, such as "leave me alone," "go away," or "I'm not discussing this with you". | ||
| - Communicating in a 'tone' you don't find congenial. | ||
| - Criticizing racist, sexist, cissexist, or otherwise oppressive behavior or assumptions. | ||
|
|
||
| ## Need Help? | ||
|
|
||
| Organizers can be contacted by email at: [email protected] |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,16 +1,16 @@ | ||
| # Contributing to writespeakcode.com | ||
| # Contribute | ||
|
|
||
| ## Participation | ||
|
|
||
| - Find an issue labelled `good first issue` or `help wanted` and claim it by assigning yourself. | ||
| - Find an issue labelled `good first issue` or `help wanted` and claim it by commenting on the issue. | ||
| - Tag the person who created the issue or the [codeowners](/.github/codeowners) with any questions. | ||
|
|
||
| ## Code of Conduct | ||
|
|
||
| This project and everyone participating in it is governed by our [Code of Conduct](https://www.writespeakcode.com/code-of-conduct.html). By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]). | ||
| This project and everyone participating in it is governed by our code of conduct. By participating, you are expected to uphold this code. Please report unacceptable behavior to [[email protected]](mailto:[email protected]). | ||
|
|
||
| ### The Quick Version | ||
|
|
||
| Our events and online spaces are dedicated to providing a harassment-free experience for everyone, regardless of gender and gender identity, age, sexual orientation, disability, physical appearance, body size, race, or religion (or lack thereof). We do not tolerate harassment of participants in any form. Sexual language and imagery is not appropriate at any point. Participants violating these rules may be sanctioned or expelled at the discretion of the organizers. | ||
|
|
||
| [Read the Full Code of Conduct](https://www.writespeakcode.com/code-of-conduct.html) | ||
| [Read the full Code of Conduct](./CODE-OF-CONDUCT.md) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| # Technologies | ||
|
|
||
| ## Gatsby | ||
|
|
||
| A quick look at the top-level files and directories you'll see in a Gatsby project. | ||
|
|
||
| . | ||
| ├── node_modules | ||
| ├── src | ||
| ├── .gitignore | ||
| ├── .prettierrc | ||
| ├── gatsby-browser.js | ||
| ├── gatsby-config.js | ||
| ├── gatsby-node.js | ||
| ├── gatsby-ssr.js | ||
| ├── LICENSE | ||
| ├── package-lock.json | ||
| ├── package.json | ||
| └── README.md | ||
|
|
||
| 1. **`/node_modules`**: This directory contains all of the modules of code that your project depends on (npm packages) are automatically installed. | ||
|
|
||
| 2. **`/src`**: This directory will contain all of the code related to what you will see on the front-end of your site (what you see in the browser) such as your site header or a page template. `src` is a convention for “source code”. | ||
|
|
||
| 3. **`.gitignore`**: This file tells git which files it should not track / not maintain a version history for. | ||
|
|
||
| 4. **`.prettierrc`**: This is a configuration file for [Prettier](https://prettier.io/). Prettier is a tool to help keep the formatting of your code consistent. | ||
|
|
||
| 5. **`gatsby-browser.js`**: This file is where Gatsby expects to find any usage of the [Gatsby browser APIs](https://www.gatsbyjs.org/docs/browser-apis/) (if any). These allow customization/extension of default Gatsby settings affecting the browser. | ||
|
|
||
| 6. **`gatsby-config.js`**: This is the main configuration file for a Gatsby site. This is where you can specify information about your site (metadata) like the site title and description, which Gatsby plugins you’d like to include, etc. (Check out the [config docs](https://www.gatsbyjs.org/docs/gatsby-config/) for more detail). | ||
|
|
||
| 7. **`gatsby-node.js`**: This file is where Gatsby expects to find any usage of the [Gatsby Node APIs](https://www.gatsbyjs.org/docs/node-apis/) (if any). These allow customization/extension of default Gatsby settings affecting pieces of the site build process. | ||
|
|
||
| 8. **`gatsby-ssr.js`**: This file is where Gatsby expects to find any usage of the [Gatsby server-side rendering APIs](https://www.gatsbyjs.org/docs/ssr-apis/) (if any). These allow customization of default Gatsby settings affecting server-side rendering. | ||
|
|
||
| 9. **`LICENSE`**: Gatsby is licensed under the MIT license. | ||
|
|
||
| 10. **`package-lock.json`** (See `package.json` below, first). This is an automatically generated file based on the exact versions of your npm dependencies that were installed for your project. **(You won’t change this file directly).** | ||
|
|
||
| 11. **`package.json`**: A manifest file for Node.js projects, which includes things like metadata (the project’s name, author, etc). This manifest is how npm knows which packages to install for your project. | ||
|
|
||
| 12. **`README.md`**: A text file containing useful reference information about your project. | ||
|
|
||
| ### 🎓 Learning Gatsby | ||
|
|
||
| Looking for more guidance? Full documentation for Gatsby lives [on the website](https://www.gatsbyjs.org/). Here are some places to start: | ||
|
|
||
| - **For most developers, we recommend starting with our [in-depth tutorial for creating a site with Gatsby](https://www.gatsbyjs.org/tutorial/).** It starts with zero assumptions about your level of ability and walks through every step of the process. | ||
|
|
||
| - **To dive straight into code samples, head [to our documentation](https://www.gatsbyjs.org/docs/).** In particular, check out the _Guides_, _API Reference_, and _Advanced Tutorials_ sections in the sidebar. |