Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Update the docs and replace the Hubot website #1678

Merged
merged 2 commits into from
Oct 14, 2023
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
51 changes: 51 additions & 0 deletions .github/workflows/sfab-gh-pages.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
# Sample workflow for building and deploying a sfab site to GitHub Pages
name: Deploy sfab with GitHub Pages dependencies preinstalled

on:
# Runs on pushes targeting the default branch
push:
branches: ["main"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
concurrency:
group: "pages"
cancel-in-progress: false

jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Use Node.js and Build with sfab
uses: actions/setup-node@v3
with:
node-version: latest
- run: npm run build
- name: Upload artifact
uses: actions/upload-pages-artifact@v2

# Deployment job
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v2
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@ node_modules
.nyc_output/
npm-debug.log
coverage/
_site
4 changes: 3 additions & 1 deletion .npmignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,4 +5,6 @@ bin/e2e-test.sh
test
docs
examples
script
script
www
dist
16 changes: 10 additions & 6 deletions docs/adapters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
permalink: /docs/adapters/
title: Adapters
layout: layouts/docs.html
permalink: /adapters.html
---

# Adapters
Expand All @@ -8,20 +10,22 @@ Adapters are the interface to the service you want your hubot to run on.

Hubot includes two official adapters:

* [Shell](./adapters/shell.md), i.e. for use with development
* [Campfire](./adapters/campfire.md)
* [Shell](./adapters/shell.html), i.e. for use with development
* [Campfire](./adapters/campfire.html)

There are Third-party adapters available for most chat services. Here are the most popular ones:

* [Discord](https://github.com/hubot-friends/hubot-discord)
* [IRC](https://github.com/hubot-friends/hubot-irc)
* [Slack](https://github.com/hubot-friends/hubot-slack)
* [MS Teams](https://github.com/hubot-friends/hubot-ms-teams)
* [Gitter](https://github.com/huafu/hubot-gitter2)
* [HipChat](https://github.com/hipchat/hubot-hipchat)
* [IRC](https://github.com/nandub/hubot-irc)
* [Rocket.Chat](https://github.com/RocketChat/hubot-rocketchat)
* [Slack](https://github.com/slackhq/hubot-slack)
* [XMPP](https://github.com/markstory/hubot-xmpp)

Browse all [repositories with the `hubot-adapter` topic on GitHub](https://github.com/search?q=topic%3Ahubot-adapter&type=Repositories) or [search for adapters on NPM](https://www.npmjs.com/search?q=hubot%20adapter&ranking=popularity). Add the `hubot-adapter` [topic](https://help.github.com/articles/classifying-your-repository-with-topics/) to your repository on GitHub to include it in this list.

## Writing Your Own Adapter

Interested in adding your own adapter? Check out our documentation for [developing adapters](./adapters/development.md)
Interested in adding your own adapter? Check out our documentation for [developing adapters](./adapters/development.html)
21 changes: 8 additions & 13 deletions docs/adapters/campfire.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,24 @@
---
permalink: /docs/adapters/campfire/
title: Campfire adapter
layout: layouts/docs.html
permalink: /adapters/campfire.html
---

# Campfire adapter

[Campfire](http://campfirenow.com/) is a web based chat application built by
[37signals](http://37signals.com). The Campfire adapter is one of the original
adapters in Hubot.
[Campfire](http://campfirenow.com/) is a web based chat application built by [37signals](http://37signals.com). The Campfire adapter is one of the original adapters in Hubot.

## Getting Started

You will need a Campfire account to start, which you can
[sign up for free](https://signup.37signals.com/campfire/free/signup/new).
You will need a Campfire account to start.

Next, you will need to create a user on your Campfire account for your Hubot,
then give it access so it can join to your rooms. You will need to create a room
if you haven't already.
Next, you will need to create a user on your Campfire account for your Hubot, then give it access so it can join to your rooms. You will need to create a room if you haven't already.

Hubot defaults to using its [shell](./shell.md), so to use Campfire instead, you
can run hubot with `-a campfire`:
Hubot defaults to using its [shell](./shell.html), so to use Campfire instead, you can run hubot with `-a campfire`:

% bin/hubot -a campfire

If you are deploying to Heroku or using foreman, you need to make
sure the hubot is called with `-a campfire` in the `Procfile`:
If you are deploying to Heroku or using foreman, you need to make sure the hubot is called with `-a campfire` in the `Procfile`:

web: bin/hubot -a campfire -n Hubot

Expand Down
10 changes: 6 additions & 4 deletions docs/adapters/development.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
permalink: /docs/adapters/development/
title: Development adapter
layout: layouts/docs.html
permalink: /adapters/development.html
---

# Development adapter
Expand Down Expand Up @@ -65,7 +67,7 @@ exports.use = (robot) => new Sample(robot)
}
```

7. Generate your Hubot using the `yo hubot` [command](https://hubot.github.com/docs/)
7. Generate your Hubot using the `npx hubot --create myhubot`
8. Change working directories to the `hubot` you created in step 7.
9. Now perform an `npm link` to add your adapter to `hubot`
- `npm link ../hubot-sample`
Expand Down Expand Up @@ -115,10 +117,10 @@ Another option is to load the file from local disk.
"dependencies": {
},
"peerDependencies": {
"hubot": ">=4.2.0"
"hubot": ">=9"
},
"devDependencies": {
"coffeescript": ">=1.2.0"
"coffeescript": ">=2.7.0"
}
```

Expand Down
4 changes: 3 additions & 1 deletion docs/adapters/shell.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
---
permalink: /docs/adapters/shell/
title: Shell adapter
layout: layouts/docs.html
permalink: /adapters/shell.html
---

# Shell adapter
Expand Down
Binary file added docs/assets/fonts/eot/handsean-webfont.eot
Binary file not shown.
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154042.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154044.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154045.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154046.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154049.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154051.eot
Binary file not shown.
Binary file added docs/assets/fonts/eot/style_154053.eot
Binary file not shown.
Binary file added docs/assets/fonts/otf/handsean-webfont.ttf
Binary file not shown.
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154042.otf
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154045.otf
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154046.otf
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154048.otf
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154051.otf
Binary file not shown.
Binary file added docs/assets/fonts/otf/style_154053.otf
Binary file not shown.
Loading
Loading