Merge pull request #73 from wayfair-incubator/playbook-project-rename

Project rename: `auxeng-docs` -> `aux-eng-playbook`

.dockerignore

@@ -65,5 +65,6 @@ public
 yarn-error.log
 .pnp/
 .pnp.js
+
 # Yarn Integrity file
 .yarn-integrity

.github/ISSUE_TEMPLATE/BUG_REPORT.md

@@ -31,5 +31,5 @@ Please provide the version number where this issue was encountered.
 
 ## Checklist
 
-- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/auxeng-docs/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/aux-eng-playbook/blob/main/CONTRIBUTING.md)
 - [ ] I have verified this does not duplicate an existing issue

.github/PULL_REQUEST_TEMPLATE.md

@@ -15,7 +15,7 @@ Note that by _not_ including a description, you are asking reviewers to do extra
 
 ## Checklist
 
-- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/auxeng-docs/blob/main/CONTRIBUTING.md)
+- [ ] I have read the [contributing guidelines](https://github.com/wayfair-incubator/aux-eng-playbook/blob/main/CONTRIBUTING.md)
 - [ ] Existing issues have been referenced (where applicable)
 - [ ] I have verified this change is not present in other open pull requests
 - [ ] Functionality is documented

.gitignore

@@ -65,5 +65,6 @@ public
 yarn-error.log
 .pnp/
 .pnp.js
+
 # Yarn Integrity file
 .yarn-integrity

.nvmrc

@@ -1 +1 @@
-16
+19

CHANGELOG.md

@@ -9,6 +9,17 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### TBA
 
+### [0.0.2] - 2022-12-14
+
+### Added
+
+- New Aux Eng article content
+
+### Changed
+
+- Complete project rename from `auxeng-docs` to `aux-eng-playbook`
+- Updated existing WIP article content
+
 ## [0.0.1] - 2022-10-18
 
 ### Added
@@ -21,5 +32,6 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Build and dependency fixes, Docker enhancements
 - Cleaned up and improved Goals splash page
 
-[unreleased]: https://github.com/wayfair-incubator/auxeng-docs/compare/v0.0.1...HEAD
-[0.0.1]: https://github.com/wayfair-incubator/auxeng-docs/releases/tag/v0.0.1
+[unreleased]: https://github.com/wayfair-incubator/aux-eng-playbook/compare/v0.0.2...HEAD
+[0.0.2]: https://github.com/wayfair-incubator/aux-eng-playbook/releases/tag/v0.0.2
+[0.0.1]: https://github.com/wayfair-incubator/aux-eng-playbook/releases/tag/v0.0.1

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # How to Contribute
 
-Thanks for your interest in contributing to Aux Eng Docs! Here are a few general guidelines on contributing and
+Thanks for your interest in contributing to the Aux Eng Playbook! Here are a few general guidelines on contributing and
 reporting bugs that we ask you to review. Following these guidelines helps to communicate that you respect the time of
 the contributors managing and developing this open source project. In return, they should reciprocate that respect in
 addressing your issue, assessing changes, and helping you finalize your pull requests. In that spirit of mutual respect,
@@ -14,7 +14,7 @@ any real-time space (eg. Slack, Discord, etc).
 ## Reporting Issues
 
 Before reporting a new issue, please ensure that the issue was not already reported or fixed by searching through our
-[issues list](https://github.com/wayfair-incubator/auxeng-docs/issues).
+[issues list](https://github.com/wayfair-incubator/aux-eng-playbook/issues).
 
 When creating a new issue, please be sure to include a **title and clear description**, as much relevant information as
 possible, and, if possible, a test case.
@@ -32,16 +32,16 @@ reserve breaking changes until the next major version release.
 
 ## Other Ways to Contribute
 
-We welcome anyone that wants to contribute to Aux Eng Docs to triage and reply to open issues to help troubleshoot
+We welcome anyone that wants to contribute to the Aux Eng Playbook to triage and reply to open issues to help troubleshoot
 and fix existing bugs. Here is what you can do:
 
 - Help ensure that existing issues follows the recommendations from the _[Reporting Issues](#reporting-issues)_ section,
   providing feedback to the issue's author on what might be missing.
-- Review and update the existing content of our [Wiki](https://github.com/wayfair-incubator/auxeng-docs/wiki) with up-to-date
+- Review and update the existing content of our [Wiki](https://github.com/wayfair-incubator/aux-eng-playbook/wiki) with up-to-date
   instructions and code samples.
-- Review existing pull requests, and testing patches against real existing applications that use Aux Eng Docs.
+- Review existing pull requests, and testing patches against real existing applications that use the Aux Eng Playbook.
 - Write a test, or add a missing test case to an existing test.
 
-Thanks again for your interest on contributing to Aux Eng Docs!
+Thanks again for your interest on contributing to the Aux Eng Playbook!
 
-:heart:
+💜

README.md

@@ -1,14 +1,16 @@
-# Aux Eng Docs
+# Aux Eng Playbook
 
-A collection of documentation related to how Wayfair Engineering has implemented "[Auxiliary Engineering](https://www.aboutwayfair.com/tech-innovation/what-is-auxiliary-engineering)"
-
-[![Release](https://img.shields.io/github/v/release/wayfair-incubator/auxeng-docs?display_name=tag)](https://github.com/wayfair-incubator/auxeng-docs/releases)
-[![License: BSD 0-Clause](https://img.shields.io/badge/License-BSD%200--Clause-7462E0.svg)](LICENSE)
+[![Deploy](https://github.com/wayfair-incubator/aux-eng-playbook/actions/workflows/deploy.yml/badge.svg?branch=main)](https://github.com/wayfair-incubator/aux-eng-playbook/actions/workflows/deploy.yml)
+[![Release](https://img.shields.io/github/v/release/wayfair-incubator/aux-eng-playbook?display_name=tag)](https://github.com/wayfair-incubator/aux-eng-playbook/releases)
+[![License: BSD 0-Clause](https://img.shields.io/badge/License-BSD%200--Clause-orange.svg)](LICENSE)
 [![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.0-24B8EE.svg)](CODE_OF_CONDUCT.md)
+[![Maintainer](https://img.shields.io/badge/Maintainer-Wayfair-7F187F)](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+. We recommend using [nvm](https://github.com/nvm-sh/nvm).
+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.
 
@@ -28,7 +30,7 @@ yarn develop
 Plenty of information may show, but you should eventually see something like:
 
 ```shell
-You can now view AuEngDocs in the browser.
+You can now view Aux Eng Playbook in the browser.
 
   http://localhost:8000/
 
@@ -40,7 +42,7 @@ You can edit the site by editing the files in `src/`. This site uses CSS, JS, an
 
 ## 🐳 Docker Setup
 
-If you'd prefer to develop within a `node:18-alpine` container, this project also supports using Docker Compose with hot-reloading capabilites for Gatsby.
+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.
 

package.json

@@ -1,9 +1,9 @@
 {
-  "name": "auxeng-docs",
+  "name": "aux-eng-playbook",
   "private": true,
-  "description": "A documentation site by Auxiliary Engineers at Wayfair",
-  "version": "0.0.1",
-  "author": "Gary White Jr. <gwhite@wayfair.com>",
+  "description": "Wayfair Tech's playbook for building and supporting an Auxiliary Engineering program",
+  "version": "0.0.2",
+  "author": "Wayfair Open Source <OpenSource@wayfair.com>",
   "dependencies": {
     "@babel/core": "7.20.5",
     "bootstrap": "5.2.3",
@@ -62,9 +62,9 @@
   },
   "repository": {
     "type": "git",
-    "url": "https://github.com/wayfair-incubator/auxeng-docs"
+    "url": "https://github.com/wayfair-incubator/aux-eng-playbook"
   },
   "bugs": {
-    "url": "https://github.com/wayfair-incubator/auxeng-docs/issues"
+    "url": "https://github.com/wayfair-incubator/aux-eng-playbook/issues"
   }
 }

renovate.json

@@ -1,29 +1,10 @@
 {
   "$schema": "https://docs.renovatebot.com/renovate-schema.json",
-  "description": "Renovate configuration recommended by the Wayfair OSPO",
-  "labels": [
-    "renovate/{{depName}}"
-  ],
+  "description": "Wayfair OSPO recommended presets (https://github.com/wayfair/ospo-automation/blob/main/default.json)",
   "extends": [
-    "config:base",
-    ":dependencyDashboard",
-    ":rebaseStalePrs"
-  ],
-  "schedule": [
-    "before 3am every weekday"
-  ],
-  "enabledManagers": [
-    "dockerfile",
-    "docker-compose",
-    "github-actions",
-    "npm"
+    "github>wayfair/ospo-automation"
   ],
   "packageRules": [
-    {
-      "matchUpdateTypes": ["minor", "patch", "pin", "digest"],
-      "groupName": "Minor Packages",
-      "automerge": true
-    },
     {
       "matchPackageNames": ["gatsby"],
       "matchPackagePrefixes": ["gatsby-"],
@@ -43,10 +24,6 @@
     {
       "matchManagers": ["dockerfile", "docker-compose"],
       "groupName": "Docker"
-    },
-    {
-      "matchManagers": ["github-actions"],
-      "groupName": "GitHub Actions"
     }
   ]
 }