Skip to content

Added homepage, description & keywords #6969

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 2 commits into from
Jun 4, 2019
Merged

Added homepage, description & keywords #6969

merged 2 commits into from
Jun 4, 2019

Conversation

bromso
Copy link
Contributor

@bromso bromso commented Jun 4, 2019

Issue:

What I did

For better marketing of your wonderful app I've added your homepage (https://storybook.js.org/), description (text copied & pasted from your website) & keywords into the package.json file. Hopefully those changes will make your app more accessible/searchable thru eg.: https://www.npmjs.com/.

How to test

  • Is this testable with Jest or Chromatic screenshots? I don't know. Don't think so.
  • Does this need a new example in the kitchen sink apps? No.
  • Does this need an update to the documentation? No.

If your answer is yes to any of these, please make sure to include it in your PR.

@vercel vercel bot had a problem deploying to staging June 4, 2019 13:05 Failure
@vercel
Copy link

vercel bot commented Jun 4, 2019 •
edited
Loading

This pull request is automatically deployed with Now.
To access deployments, click Details below or on the icon next to each push.

Latest deployment for this branch: https://monorepo-git-fork-bromso-patch-1.storybook.now.sh

@vercel
Copy link

vercel bot commented Jun 4, 2019

Now could not deploy this pull request since the package.json file does not contain valid JSON.

Click here to see the contents of `package.json` 
{
  "name": "@storybook/root",
  "description": "Storybook is an open source tool for developing UI components in isolation for React, Vue and Angular. It makes building stunning UIs organized and efficient.",
  "homepage": "https://storybook.js.org/",
  "version": "5.1.0-rc.0",
  "private": true,
  "repository": {
    "type": "git",
    "url": "https://github.com/storybookjs/storybook.git"
  },
  "workspaces": [
    "addons/*",
    "addons/storyshots/*",
    "app/*",
    "lib/*",
    "examples/*",
    "examples-native/*",
    "lib/cli/test/run/*"
  ],
  "scripts": {
    "bootstrap": "node ./scripts/bootstrap.js",
    "bootstrap:docs": "yarn install --cwd docs",
    "build-packs": "lerna exec --scope '@storybook/*' -- \\$LERNA_ROOT_PATH/scripts/build-pack.sh \\$LERNA_ROOT_PATH/packs",
    "build-storybooks": "./scripts/build-storybooks.sh",
    "changelog": "pr-log --sloppy --cherry-pick",
    "changelog:next": "pr-log --sloppy --since-prerelease",
    "chromatic": "npm --prefix examples/official-storybook run chromatic",
    "coverage": "codecov",
    "danger": "danger",
    "dev": "concurrently --kill-others \"yarn dev:tsc\" \"yarn dev:babel\"",
    "dev:babel": "lerna exec --scope @storybook/* --parallel -- cross-env-shell node \\$LERNA_ROOT_PATH/scripts/watch-babel.js",
    "dev:check-types": "tsc --noEmit",
    "dev:js": "echo 'DEPRECATED: Please use yarn dev:babel' && yarn dev:babel",
    "dev:ts": "echo 'DEPRECATED: Please use yarn dev:tsc' && yarn dev:tsc",
    "dev:tsc": "lerna exec --scope @storybook/* --parallel -- cross-env-shell node \\$LERNA_ROOT_PATH/scripts/watch-tsc.js",
    "docs:build": "npm --prefix docs run build",
    "docs:dev": "npm --prefix docs run dev",
    "github-release": "github-release-from-changelog",
    "lint": "yarn lint:js . && yarn lint:md .",
    "lint:js": "cross-env NODE_ENV=production eslint --cache --cache-location=.cache/eslint --ext .js,.jsx,.json,.html,.ts,.tsx,.mjs --report-unused-disable-directives",
    "lint:md": "remark -q",
    "lint:package": "sort-package-json",
    "publish:crna": "yarn --cwd examples-native/crna-kitchen-sink expo publish",
    "publish:debug": "npm run publish:latest -- --npm-tag=debug --no-push",
    "publish:latest": "lerna publish --exact --concurrency 1 --force-publish",
    "publish:next": "npm run publish:latest -- --npm-tag=next",
    "repo-dirty-check": "node ./scripts/repo-dirty-check",
    "start": "yarn --cwd examples/official-storybook storybook",
    "test": "node ./scripts/test.js",
    "test-latest-cra": "yarn --prefix --cwd lib/cli run test-latest-cra",
    "test:cli": "npm --prefix lib/cli run test"
  },
  "husky": {
    "hooks": {
      "pre-commit": "yarn lint-staged"
    }
  },
  "lint-staged": {
    "linters": {
      "*.js": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.jsx": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.mjs": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.html": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.ts": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.tsx": [
        "yarn lint:js --fix",
        "git add"
      ],
      "*.json": [
        "yarn lint:js --fix",
        "git add"
      ],
      "package.json": [
        "yarn lint:package",
        "git add"
      ]
    }
  },
  "browserslist": "defaults",
  "dependencies": {
    "@babel/plugin-syntax-dynamic-import": "^7.2.0",
    "@typescript-eslint/eslint-plugin": "^1.7.0",
    "babel-plugin-add-react-displayname": "^0.0.5",
    "common-tags": "^1.8.0",
    "detect-port": "^1.3.0",
    "eslint-plugin-html": "^5.0.3",
    "jest-matcher-utils": "^24.7.0",
    "node-cleanup": "^2.1.2",
    "react-testing-library": "^7.0.0"
  },
  "devDependencies": {
    "@angular/common": "^7.2.6",
    "@angular/compiler": "^7.2.6",
    "@angular/core": "^7.2.6",
    "@angular/forms": "^7.2.6",
    "@angular/platform-browser": "^7.2.6",
    "@angular/platform-browser-dynamic": "^7.2.6",
    "@babel/cli": "^7.2.3",
    "@babel/core": "^7.3.4",
    "@babel/plugin-proposal-class-properties": "^7.3.3",
    "@babel/plugin-proposal-decorators": "^7.3.0",
    "@babel/plugin-proposal-export-default-from": "^7.2.0",
    "@babel/plugin-proposal-object-rest-spread": "^7.2.0",
    "@babel/plugin-transform-react-constant-elements": "^7.2.0",
    "@babel/preset-env": "^7.4.1",
    "@babel/preset-flow": "^7.0.0",
    "@babel/preset-react": "^7.0.0",
    "@babel/preset-typescript": "^7.3.3",
    "@emotion/snapshot-serializer": "^0.8.2",
    "@types/common-tags": "^1.8.0",
    "@types/jest": "^24.0.11",
    "@types/lodash": "^4.14.129",
    "@types/node": "~12.0.2",
    "@types/react": "^16.8.14",
    "@types/webpack": "^4.4.25",
    "@types/webpack-env": "^1.13.7",
    "babel-core": "^7.0.0-bridge.0",
    "babel-eslint": "^10.0.1",
    "babel-jest": "^24.7.1",
    "babel-loader": "^8.0.5",
    "babel-plugin-add-react-displayname": "^0.0.5",
    "babel-plugin-dynamic-import-node": "^2.2.0",
    "babel-plugin-emotion": "^10.0.9",
    "babel-plugin-macros": "^2.4.5",
    "babel-plugin-require-context-hook": "^1.0.0",
    "babel-preset-vue": "^2.0.2",
    "chalk": "^2.4.2",
    "codecov": "^3.5.0",
    "codelyzer": "^5.0.0",
    "commander": "^2.19.0",
    "concurrently": "^4.0.1",
    "core-js": "^3.0.1",
    "cross-env": "^5.2.0",
    "danger": "^7.0.15",
    "enzyme": "^3.9.0",
    "enzyme-adapter-react-16": "^1.9.1",
    "eslint": "^5.14.1",
    "eslint-config-airbnb": "^17.0.0",
    "eslint-config-prettier": "^4.3.0",
    "eslint-plugin-import": "^2.16.0",
    "eslint-plugin-jest": "^22.4.1",
    "eslint-plugin-json": "^1.4.0",
    "eslint-plugin-jsx-a11y": "^6.2.1",
    "eslint-plugin-prettier": "^3.0.1",
    "eslint-plugin-react": "^7.12.4",
    "esm": "^3.2.25",
    "github-release-from-changelog": "^1.3.2",
    "glob": "^7.1.3",
    "husky": "^2.3.0",
    "inquirer": "^6.2.0",
    "jest": "^24.7.1",
    "jest-cli": "^24.7.1",
    "jest-config": "^24.0.0",
    "jest-diff": "^24.7.0",
    "jest-emotion": "^10.0.10",
    "jest-environment-jsdom": "^24.7.1",
    "jest-environment-jsdom-thirteen": "^1.0.1",
    "jest-enzyme": "^7.0.2",
    "jest-image-snapshot": "^2.8.2",
    "jest-jasmine2": "^24.7.1",
    "jest-preset-angular": "^6.0.1",
    "jest-raw-loader": "^1.0.1",
    "jest-vue-preprocessor": "^1.5.0",
    "jest-watch-typeahead": "^0.3.0",
    "lerna": "^3.14.1",
    "lint-staged": "^8.1.7",
    "lodash": "^4.17.11",
    "node-fetch": "^2.6.0",
    "npmlog": "^4.1.2",
    "prettier": "^1.16.4",
    "raf": "^3.4.0",
    "react": "^16.8.4",
    "react-dom": "^16.8.4",
    "react-test-renderer": "^16.8.4",
    "regenerator-runtime": "^0.12.1",
    "remark-cli": "^6.0.1",
    "remark-lint": "^6.0.4",
    "remark-preset-lint-recommended": "^3.0.2",
    "riot-jest-transformer": "^2.0.0",
    "shelljs": "^0.8.3",
    "sort-package-json": "^1.21.0",
    "svelte": "^3.4.1",
    "svelte-jest": "^0.2.0",
    "ts-jest": "^24.0.2",
    "typescript": "^3.4.1",
    "weak": "^1.0.1"
  },
  "engines": {
    "node": ">=8.6.0",
    "yarn": ">=1.3.2"
  },
  "collective": {
    "type": "opencollective",
    "url": "https://opencollective.com/storybook"
  },
  "pr-log": {
    "skipLabels": [
      "cleanup",
      "doc-dependencies:update"
    ],
    "validLabels": [
      [
        "BREAKING CHANGE",
        "Breaking Changes"
      ],
      [
        "feature request",
        "Features"
      ],
      [
        "bug",
        "Bug Fixes"
      ],
      [
        "documentation",
        "Documentation"
      ],
      [
        "maintenance",
        "Maintenance"
      ],
      [
        "dependencies:update",
        "Dependency Upgrades"
      ],
      [
        "dependencies",
        "Dependency Upgrades"
      ],
      [
        "other",
        "Other"
      ]
    ]
  },
  "keywords": [
    "ui",
    "user interface",
    "components",
    "storybook",
    "storybookjs",
    "react",
    "reactjs",
    "angular",
    "angularjs",
    "vue",
    "vuejs",
    "babel",
    "eslint",
    "frontend",
    "jamstack",
    "documentation",
    "tool",
    "templated",
    "reuseable",
    "markup",
  ]
}

bromso
bromso commented Jun 4, 2019
View reviewed changes
Copy link
Contributor Author

@bromso bromso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Forgot to delete the last comma.

bromso
bromso commented Jun 4, 2019
View reviewed changes
Copy link
Contributor Author

@bromso bromso left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Deleted the last comma and labeled the PR "documentation"

shilman
shilman approved these changes Jun 4, 2019
View reviewed changes
Copy link
Member

@shilman shilman left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome!!!!!

@shilman shilman added this to the 5.1.0 milestone Jun 4, 2019
@shilman shilman merged commit cd824c3 into storybookjs:next Jun 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@shilman shilman shilman approved these changes

Assignees
No one assigned
Labels
documentation
Projects
None yet
Milestone
5.1.0
Development

Successfully merging this pull request may close these issues.
2 participants
@bromso @shilman