Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wayfair-incubator/aux-eng-playbook
Wayfair Tech's playbook for building and supporting an Auxiliary Engineering program.
https://github.com/wayfair-incubator/aux-eng-playbook
hacktoberfest playbook
Last synced: about 6 hours ago
JSON representation
Wayfair Tech's playbook for building and supporting an Auxiliary Engineering program.
- Host: GitHub
- URL: https://github.com/wayfair-incubator/aux-eng-playbook
- Owner: wayfair-incubator
- License: 0bsd
- Created: 2020-10-12T12:50:43.000Z (about 4 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T22:57:41.000Z (6 months ago)
- Last Synced: 2024-05-16T23:50:11.239Z (6 months ago)
- Topics: hacktoberfest, playbook
- Language: JavaScript
- Homepage:
- Size: 51 MB
- Stars: 4
- Watchers: 4
- Forks: 0
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# Aux Eng Playbook
[](https://github.com/wayfair-incubator/aux-eng-playbook/actions/workflows/deploy.yml)
[](https://github.com/wayfair-incubator/aux-eng-playbook/releases)
[](LICENSE)
[](CODE_OF_CONDUCT.md)
[](https://wayfair.github.io)
A playbook for technologists interested in introducing [Auxiliary
Engineering](https://www.aboutwayfair.com/tech-innovation/what-is-auxiliary-engineering)
to their engineering organization. The [Aux Eng
Playbook](https://github.com/wayfair-incubator/aux-eng-playbook) aims to
document Wayfair Tech's pioneering implementation of Aux Eng programs while
sharing key takeaways, learnings, and recipes for success.
## 🚀 Quick Start
To get started editing this site, you'll need Node v14+, and _preferably_ v19.
We recommend using [nvm](https://github.com/nvm-sh/nvm).
Once that's installed, you'll need [`yarn`](https://yarnpkg.com/) as well.
Start developing by initializing your node modules:
```shell
yarn
```
Then start the [gatsby development server](https://www.gatsbyjs.com/docs/):
```shell
yarn build
yarn develop
```
Plenty of information may show, but you should eventually see something like:
```shell
You can now view Aux Eng Playbook in the browser.
http://localhost:8000/
```
You can edit the site by editing the files in `src/`. This site uses CSS, JS,
and [css-in-js](https://cssinjs.org/).
> 💡 Note that for most images, you'll want to run `yarn build` before they show
> up correctly on the development site.
## 🐳 Docker Setup
If you'd prefer to develop within a `node:19-alpine` container, this project
also supports using Docker Compose with hot-reloading capabilites for Gatsby.
First, make sure you have both [docker](https://docs.docker.com/engine/install/)
and [docker-compose](https://docs.docker.com/compose/install/) installed.
To bring up the `gastby` development server, run:
```shell
docker-compose down
docker-compose up -d develop # Remove the -d flag if you don't witsh to daemonize the container
```
Once the server is up and running, when you make local changes to your `gatsby`
site content, the changes should hot-reload in your containerized instance,
accessible in a browser at `http://localhost:8000`. Note that it's easier to
observe the hot-reloading functionality in action when the container is not
daemonized.
If you'd like to interact with the
[gatsby-cli](https://www.gatsbyjs.com/docs/reference/gatsby-cli/) directly, you
can also run commands like:
```shell
docker-compose run gatsby --help
docker-compose run gatsby info # Example commmand to get environment information for debugging
```
## Contributing to Docs
If you're here to write some of our plentiful documentation, use these foolproof
steps:
1. Ensure you've completed the [Quick Start](#-quick-start) above, and have a
server running.
1. Make a new branch for your new document post.
1. Create a new directory (or sub-directory, or sub-sub-directory) in `src/docs`
like `my-doc`
1. Create an `index.md` file in `src/docs/my-doc` (or whatever you named your
doc). This will be your document's markdown page.
1. Write the [frontmatter](https://github.com/remarkjs/remark-frontmatter#use)
for the page like so:
```markdown
---
title: "My Snazzy Article"
---
```
1. Optionally, include any assets you need (images, etc) alongside `index.md`,
and reference them directly, eg: `[my-image](./my-image)`
1. Watch your markdown come to life in your browser by visiting the
corresponding path to your document from `/docs` (in this case, we'd visit
`docs/my-doc`)
1. When satisfied, commit the result for review.
## Deploying
As long as permissions work and everything is aligned in the stars, you ought to
be able to deploy with:
```shell
yarn deploy
```
## Troubleshooting
If you see strange behavior from developing or building the app, try `npx gatsby
clean`. This should use the `gatsby-cli` to clean out frayed node modules or
other unexpected hitches.