Convert docs to ir-docs

.circleci/config.yml

@@ -3,13 +3,22 @@
 # Check https://circleci.com/docs/2.0/language-javascript/ for more details
 #
 
+version: 2.1
+
+orbs:
+  publish-docs: infinitered/[email protected]
+
+
+parameters:
+  "force-docs":
+    type: boolean
+    default: false
+
 defaults: &defaults
-  docker:
-    # Choose the version of Node you want here
+  docker: # Choose the version of Node you want here
     - image: cimg/node:18.17.1
   working_directory: ~/repo
 
-version: 2
 jobs:
   setup:
     <<: *defaults
@@ -65,9 +74,26 @@ jobs:
           name: Publish to NPM
           command: yarn ci:publish # this will be added to your package.json scripts
 
+# Parameters for the publish-docs orb
+publish-details: &publish-details
+  description: A delightful toolkit for building Node-based CLIs in TS/JS
+  git_email: [email protected]
+  git_username: Infinite Red CI
+  label: Gluegun
+  project_name: gluegun
+  source_docs_dir: ir-docs
+  source_repo_directory: source
+  target_docs_dir: docs
+  target_repo: [email protected]:infinitered/ir-docs.git
+  target_repo_directory: target
+
 workflows:
   version: 2
   test_and_release:
+    when:
+      and:
+        - not: << pipeline.parameters.force-docs >>
+        - true  # Placeholder for correct YAML structure
     jobs:
       - setup
       - tests:
@@ -79,3 +105,19 @@ workflows:
           filters:
             branches:
               only: master
+      - publish-docs/publish_docs:
+          <<: *publish-details
+          filters:
+            branches:
+              only:
+                - ir-docs
+          requires:
+            - publish
+            - test_and_release
+  # for testing and debugging
+  force-docs:
+    when: << pipeline.parameters.force-docs >>
+    jobs:
+      - publish-docs/publish_docs:
+          <<: *publish-details
+

docs/README.md

@@ -103,9 +103,9 @@ module.exports = {
 }
 ```
 
-See the [toolbox api docs](./docs/toolbox-api.md) for more details on what you can do.
+See the [toolbox api docs](/toolbox-api/) for more details on what you can do.
 
-See the [runtime docs](./docs/runtime.md) for more details on building your own CLI and join us in the #gluegun channel of the Infinite Red Community Slack ([community.infinite.red](http://community.infinite.red)) to get friendly help!
+See the [runtime docs](/runtime/) for more details on building your own CLI and join us in the #gluegun channel of the Infinite Red Community Slack ([community.infinite.red](http://community.infinite.red)) to get friendly help!
 
 # Who Is Using This?
 

docs/_sidebar.md

@@ -1,8 +1,9 @@
 - [Home](/)
-- [Getting Started](/getting-started)
-- [Runtime API](/runtime)
-- [Toolbox API](/toolbox-api)
-  - [config](/toolbox-config)
+
+* [Getting Started](/getting-started)
+* [Runtime API](/runtime)
+* [Toolbox API](/toolbox-api)
+  - [config](/toolbox-api/config)
   - [filesystem](/toolbox-filesystem)
   - [semver](/toolbox-semver)
   - [http](/toolbox-http)
@@ -14,10 +15,10 @@
   - [template](/toolbox-template)
   - [patching](/toolbox-patching)
   - [packageManager](/toolbox-package-manager)
-- Tutorials
+* Tutorials
   - [Tutorial: Making a Movie CLI](/tutorial-making-a-movie-cli)
   - [Tutorial: Making a Plugin](/tutorial-making-a-plugin)
-- Guides
+* Guides
   - [Guide: Architecting Your Gluegun CLI](/guide-architecture)
-- [Plugins](/plugins)
-- [Contributing](/contributing)
+* [Plugins](/plugins)
+* [Contributing](/contributing)

docs/tutorial-making-a-movie-cli.md

@@ -2,7 +2,7 @@
 
 _You can see the latest version of the result of this tutorial on Github at [https://github.com/infinitered/tutorial-movie](https://github.com/infinitered/tutorial-movie)!_
 
-In this tutorial, we'll make a Gluegun-powered command-line interface called `movie`. Before doing this tutorial, make sure you've followed the installation instructions in [Getting Started](/getting-started). We will also be using [yarn](https://yarnpkg.com/) in this tutorial rather than `npm`. You can use `npm` if you want.
+In this tutorial, we'll make a Gluegun-powered command-line interface called `movie`. Before doing this tutorial, make sure you've followed the installation instructions in [Getting Started](../getting-started). We will also be using [yarn](https://yarnpkg.com/) in this tutorial rather than `npm`. You can use `npm` if you want.
 
 ## Generate a new CLI
 

ir-docs/contributing/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Contributing",
+  "position": 600,
+  "link": {
+    "type": "doc",
+    "id": "index"
+  }
+}

ir-docs/contributing/index.md

@@ -0,0 +1,94 @@
+# Contributing
+
+_Welcome!_
+
+Bug fixes, features, docs, marketing, and issue support are all contributions. We love it when people help out and are more than willing to give you advice, guidance, or just be a 🐥 debugger for you.
+
+## Global Dependencies
+
+If you're reading this, you are probably interested in pitching in from a code point of view.
+
+`gluegun` is powered by Node (7.6 or above). Install Node using `brew` (if on macOS) or by following the instructions here: [https://nodejs.org/en/download/current/](https://nodejs.org/en/download/current/)
+
+Also install yarn: `brew install yarn` or [https://yarnpkg.com](https://yarnpkg.com).
+
+## Installing `gluegun`
+
+Next, fork the repo [on Github](https://github.com/infinitered/gluegun) and clone down your repo.
+
+```sh
+git clone [email protected]/<yourusername>/gluegun
+```
+
+Install all the dependencies.
+
+```
+cd gluegun
+yarn
+```
+
+Gluegun's source files are mostly in `./src` and are written in [TypeScript](https://www.typescriptlang.org). Documentation lives in `/docs`.
+
+## Running Tests And Linting
+
+On macOS or Linux:
+
+```sh
+yarn test
+yarn lint
+yarn watch
+yarn integration
+```
+
+On windows:
+
+```sh
+yarn lint
+yarn windows:test
+```
+
+## Features & Fixes
+
+```sh
+git branch feature/fun
+# furious typing
+yarn test
+yarn lint
+git commit -m "Adds fun"
+git push -u origin --HEAD
+```
+
+Passing tests and linting is required before we'll merge a pull request. If you need help with this, feel free to file an issue or chat with us on the [Infinite Red Community Slack](http://community.infinite.red).
+
+## Submitting a Pull Request
+
+Jump on Github on your fork. Switch to the branch with your new changes, and
+open a PR against `master` of [infinitered/gluegun](https://github.com/infinitered/gluegun).
+
+Screenshots of what the feature is 💯. Animated gifs (suggested apps: licecap, Gif Brewery, or Kap) are 💯 + 🦄.
+
+Then submit the pull request.
+
+- It's okay to submit an issue before breaking changes or shenanigans to get a sense if it's cool
+- It's okay to submit PRs to start a discussion - just mark it 🚨🚨🚨 (or whatever) to let us know it's a conversation
+- It's okay to submit changes to PRs not yet merged, just make sure it's related to the PR
+- If Github is complaining about conflicts, rebase downstream, merge upstream
+
+## Keeping up to date
+
+You want your fork's `master` to be the same as `gluegun/master`.
+
+```sh
+# just once, run this to track our repo as `upstream`
+git remote add upstream https://github.com/infinitered/gluegun.git
+
+# then when you need to update
+git checkout master
+git pull upstream
+# if on your own branch
+git checkout <your branch>
+git merge master
+
+# and here's where you'd create your branch
+git checkout -b feature/mybranch
+```

ir-docs/contributing/releasing.md

@@ -0,0 +1,10 @@
+# Releasing Gluegun
+
+We now have CircleCI continuous integration and continous deployment set up! Thanks to Morgan Laco for setting that up.
+
+To release, just squash and merge a pull request and prefix with one of the following:
+
+- "fix: Some feature" - will release a patch version (aka 1.0.1)
+- "feat: Some feature" - will release a feature version (aka 1.1.0)
+- "feat: BREAKING CHANGE: Some breaking change" - will release a breaking version (aka 2.0.0)
+- "doc: Some docs" or "chore: Some chore" won't release

ir-docs/guides/_category_.json

@@ -0,0 +1,8 @@
+{
+  "label": "Guides",
+  "position": 600,
+  "link": {
+    "type": "generated-index",
+    "description": "Guides to advanced Gluegun topics."
+  }
+}