From d56771843c2d1bc9bdc64674965274fc00a2984a Mon Sep 17 00:00:00 2001 From: Vitor Capretz Date: Thu, 5 Nov 2020 15:16:35 -0300 Subject: [PATCH] Remove docusaurus and docs since it's not used --- .github/workflows/nodejs.yml | 26 - docs/introduction.md | 42 - website/README.md | 198 - website/core/Footer.js | 99 - website/i18n/en.json | 25 - website/package.json | 14 - website/pages/en/index.js | 122 - website/sidebars.json | 5 - website/siteConfig.js | 64 - website/static/css/custom.css | 23 - website/static/img/logo.png | Bin 25109 -> 0 bytes website/yarn.lock | 6532 --------------------------------- 12 files changed, 7150 deletions(-) delete mode 100644 docs/introduction.md delete mode 100644 website/README.md delete mode 100755 website/core/Footer.js delete mode 100644 website/i18n/en.json delete mode 100644 website/package.json delete mode 100755 website/pages/en/index.js delete mode 100644 website/sidebars.json delete mode 100644 website/siteConfig.js delete mode 100644 website/static/css/custom.css delete mode 100644 website/static/img/logo.png delete mode 100644 website/yarn.lock diff --git a/.github/workflows/nodejs.yml b/.github/workflows/nodejs.yml index 94fdcdfca..b56a17713 100644 --- a/.github/workflows/nodejs.yml +++ b/.github/workflows/nodejs.yml @@ -77,29 +77,3 @@ jobs: if [ ${IS_BETA} = true ]; then export NPM_TAG="--tag beta"; fi yarn yarn publish ${NPM_TAG} - - ####### Deploy website - website: - name: Deploy website - runs-on: ubuntu-latest - timeout-minutes: 10 - needs: [npm_publish] - - steps: - - uses: actions/checkout@v1 - - uses: actions/setup-node@v1 - with: - node-version: 12.x - - name: Deploy website - env: - GH_EMAIL: ${{ secrets.GH_EMAIL }} - GH_NAME: ${{ secrets.GH_NAME }} - GH_TOKEN: ${{ secrets.GH_TOKEN }} - GIT_USER: ${{ secrets.GH_NAME }} - run: | - git config --global user.name "${GH_NAME}" - git config --global user.email "${GH_EMAIL}" - echo "machine github.com login ${GH_NAME} password ${GH_TOKEN}" > ~/.netrc - cd website - yarn - yarn publish-gh-pages diff --git a/docs/introduction.md b/docs/introduction.md deleted file mode 100644 index d316d2150..000000000 --- a/docs/introduction.md +++ /dev/null @@ -1,42 +0,0 @@ ---- -id: introduction -title: Introduction -sidebar_label: Introduction ---- - -## Getting Started - -Start by installing the library in your project: - -```sh -yarn add bull-board -# npm i bull-board -``` - -## Hello World - -The first step is to pass bull-board your Bull queues via the `setQueues` method. - -```ts -import Queue from 'bull' -// import { Queue } from 'bullmq' -import { setQueues } from 'bull-board' - -const someQueue = new Queue() -const someOtherQueue = new Queue() - -setQueues([someQueue, someOtherQueue]) -``` - -You can then add bull-board's `router` to your express routes. It is recommended to protect this endpoint via some sort of authentication, so consider placing it on an already protected admin route: - -```ts -import express from 'express' -import { router } from 'bull-board' - -const app = express() - -app.use('/admin/queues', router) -``` - -That's it! You can now access `/admin/queues` via your browser to monitor everything that is happening in your queues, as well as how your Redis instance is doing health-wise 😁 diff --git a/website/README.md b/website/README.md deleted file mode 100644 index 6477a55a5..000000000 --- a/website/README.md +++ /dev/null @@ -1,198 +0,0 @@ -This website was created with [Docusaurus](https://docusaurus.io/). - -# What's In This Document - -- [Get Started in 5 Minutes](#get-started-in-5-minutes) -- [Directory Structure](#directory-structure) -- [Editing Content](#editing-content) -- [Adding Content](#adding-content) -- [Full Documentation](#full-documentation) - -# Get Started in 5 Minutes - -1. Make sure all the dependencies for the website are installed: - -```sh -# Install dependencies -$ yarn -``` - -2. Run your dev server: - -```sh -# Start the site -$ yarn start -``` - -## Directory Structure - -Your project file structure should look something like this - -``` -my-docusaurus/ - docs/ - doc-1.md - doc-2.md - doc-3.md - website/ - blog/ - 2016-3-11-oldest-post.md - 2017-10-24-newest-post.md - core/ - node_modules/ - pages/ - static/ - css/ - img/ - package.json - sidebars.json - siteConfig.js -``` - -# Editing Content - -## Editing an existing docs page - -Edit docs by navigating to `docs/` and editing the corresponding document: - -`docs/doc-to-be-edited.md` - -```markdown ---- -id: page-needs-edit -title: This Doc Needs To Be Edited ---- - -Edit me... -``` - -For more information about docs, click [here](https://docusaurus.io/docs/en/navigation) - -## Editing an existing blog post - -Edit blog posts by navigating to `website/blog` and editing the corresponding post: - -`website/blog/post-to-be-edited.md` - -```markdown ---- -id: post-needs-edit -title: This Blog Post Needs To Be Edited ---- - -Edit me... -``` - -For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) - -# Adding Content - -## Adding a new docs page to an existing sidebar - -1. Create the doc as a new markdown file in `/docs`, example `docs/newly-created-doc.md`: - -```md ---- -id: newly-created-doc -title: This Doc Needs To Be Edited ---- - -My new content here.. -``` - -1. Refer to that doc's ID in an existing sidebar in `website/sidebars.json`: - -```javascript -// Add newly-created-doc to the Getting Started category of docs -{ - "docs": { - "Getting Started": [ - "quick-start", - "newly-created-doc" // new doc here - ], - ... - }, - ... -} -``` - -For more information about adding new docs, click [here](https://docusaurus.io/docs/en/navigation) - -## Adding a new blog post - -1. Make sure there is a header link to your blog in `website/siteConfig.js`: - -`website/siteConfig.js` - -```javascript -headerLinks: [ - ... - { blog: true, label: 'Blog' }, - ... -] -``` - -2. Create the blog post with the format `YYYY-MM-DD-My-Blog-Post-Title.md` in `website/blog`: - -`website/blog/2018-05-21-New-Blog-Post.md` - -```markdown ---- -author: Frank Li -authorURL: https://twitter.com/foobarbaz -authorFBID: 503283835 -title: New Blog Post ---- - -Lorem Ipsum... -``` - -For more information about blog posts, click [here](https://docusaurus.io/docs/en/adding-blog) - -## Adding items to your site's top navigation bar - -1. Add links to docs, custom pages or external links by editing the headerLinks field of `website/siteConfig.js`: - -`website/siteConfig.js` - -```javascript -{ - headerLinks: [ - ... - /* you can add docs */ - { doc: 'my-examples', label: 'Examples' }, - /* you can add custom pages */ - { page: 'help', label: 'Help' }, - /* you can add external links */ - { href: 'https://github.com/facebook/docusaurus', label: 'GitHub' }, - ... - ], - ... -} -``` - -For more information about the navigation bar, click [here](https://docusaurus.io/docs/en/navigation) - -## Adding custom pages - -1. Docusaurus uses React components to build pages. The components are saved as .js files in `website/pages/en`: -1. If you want your page to show up in your navigation header, you will need to update `website/siteConfig.js` to add to the `headerLinks` element: - -`website/siteConfig.js` - -```javascript -{ - headerLinks: [ - ... - { page: 'my-new-custom-page', label: 'My New Custom Page' }, - ... - ], - ... -} -``` - -For more information about custom pages, click [here](https://docusaurus.io/docs/en/custom-pages). - -# Full Documentation - -Full documentation can be found on the [website](https://docusaurus.io/). diff --git a/website/core/Footer.js b/website/core/Footer.js deleted file mode 100755 index 0c67792ba..000000000 --- a/website/core/Footer.js +++ /dev/null @@ -1,99 +0,0 @@ -/* eslint-disable @typescript-eslint/no-var-requires */ - -/** - * Copyright (c) 2017-present, Facebook, Inc. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -const React = require('react') - -const styles = { - badgeWrapper: { - textAlign: 'right', - }, -} - -class Footer extends React.Component { - docUrl(doc, language) { - const baseUrl = this.props.config.baseUrl - const docsUrl = this.props.config.docsUrl - const docsPart = `${docsUrl ? `${docsUrl}/` : ''}` - const langPart = `${language ? `${language}/` : ''}` - - return `${baseUrl}${docsPart}${langPart}${doc}` - } - - pageUrl = (doc, language) => - `${this.props.config.baseUrl}${language ? `${language}/` : ''}${doc}` - - render() { - return ( - - ) - } -} - -module.exports = Footer diff --git a/website/i18n/en.json b/website/i18n/en.json deleted file mode 100644 index 13f1b4ec0..000000000 --- a/website/i18n/en.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "_comment": "This file is auto-generated by write-translations.js", - "localized-strings": { - "next": "Next", - "previous": "Previous", - "tagline": "Bull queue UI for inspecting jobs", - "docs": { - "introduction": { - "title": "Introduction", - "sidebar_label": "Introduction" - } - }, - "links": { - "Docs": "Docs" - }, - "categories": { - "Getting started": "Getting started" - } - }, - "pages-strings": { - "Help Translate|recruit community translators for your project": "Help Translate", - "Edit this Doc|recruitment message asking to edit the doc source": "Edit", - "Translate this Doc|recruitment message asking to translate the docs": "Translate" - } -} diff --git a/website/package.json b/website/package.json deleted file mode 100644 index 1f87392a9..000000000 --- a/website/package.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "scripts": { - "examples": "docusaurus-examples", - "start": "docusaurus-start", - "build": "docusaurus-build", - "publish-gh-pages": "docusaurus-publish", - "write-translations": "docusaurus-write-translations", - "version": "docusaurus-version", - "rename-version": "docusaurus-rename-version" - }, - "devDependencies": { - "docusaurus": "^1.14.4" - } -} diff --git a/website/pages/en/index.js b/website/pages/en/index.js deleted file mode 100755 index b542ef4b3..000000000 --- a/website/pages/en/index.js +++ /dev/null @@ -1,122 +0,0 @@ -/** - * Copyright (c) 2017-present, Facebook, Inc. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -/* eslint-disable @typescript-eslint/no-var-requires */ -const React = require('react') -const CompLibrary = require('../../core/CompLibrary.js') - -const Container = CompLibrary.Container -const GridBlock = CompLibrary.GridBlock - -const Button = props => ( -
- - {props.children} - -
-) - -const createLinkGenerator = ({ siteConfig, language = '' }) => { - const { baseUrl, docsUrl } = siteConfig - const docsPart = `${docsUrl ? `${docsUrl}/` : ''}` - const langPart = `${language ? `${language}/` : ''}` - - return doc => `${baseUrl}${docsPart}${langPart}${doc}` -} - -class HomeSplash extends React.Component { - render() { - const { siteConfig } = this.props - const docUrl = createLinkGenerator(this.props) - - const SplashContainer = props => ( -
-
-
{props.children}
-
-
- ) - - const ProjectTitle = () => ( -

- 🎯 - {siteConfig.tagline} -

- ) - - const PromoSection = props => ( -
-
-
{props.children}
-
-
- ) - - return ( - -
- - - - - -
- - ) - } -} - -class Index extends React.Component { - render() { - const { config: siteConfig, language = '' } = this.props - - const Block = props => ( - - - - ) - - const Features = () => ( -
- - {[ - { - title: 'Express & React', - content: 'Built with modern tools', - }, - { - title: 'TypeScript', - content: 'Typed all the way for your convenience', - }, - ]} - -
- ) - - return ( -
- - -
- -
-
- ) - } -} - -module.exports = Index diff --git a/website/sidebars.json b/website/sidebars.json deleted file mode 100644 index 6c7bb0d3e..000000000 --- a/website/sidebars.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "docs": { - "Getting started": ["introduction"] - } -} diff --git a/website/siteConfig.js b/website/siteConfig.js deleted file mode 100644 index 28350c200..000000000 --- a/website/siteConfig.js +++ /dev/null @@ -1,64 +0,0 @@ -/** - * Copyright (c) 2017-present, Facebook, Inc. - * - * This source code is licensed under the MIT license found in the - * LICENSE file in the root directory of this source tree. - */ - -// See https://docusaurus.io/docs/site-config for all the possible -// site configuration options. - -const siteConfig = { - title: 'bull-board', // Title for your website. - tagline: 'Bull queue UI for inspecting jobs', - url: 'https://vcapretz.github.io', // Your website URL - baseUrl: '/bull-board/', // Base URL for your project */ - organizationName: 'vcapretz', - projectName: 'bull-board', - - // For no header links in the top nav bar -> headerLinks: [], - headerLinks: [{ doc: 'introduction', label: 'Docs' }], - - /* path to images for header/footer */ - headerIcon: 'img/logo.png', - footerIcon: 'img/logo.png', - favicon: 'img/logo.png', - - /* Colors for website */ - colors: { - primaryColor: '#55735a', - secondaryColor: '#3b503e', - }, - - // This copyright info is used in /core/Footer.js and blog RSS/Atom feeds. - copyright: `Copyright © ${new Date().getFullYear()} Vitor Capretz`, - - highlight: { - // Highlight.js theme to use for syntax highlighting in code blocks. - theme: 'github', - }, - - // Add custom scripts here that would be placed in