Skip to content

Commit

Permalink
fix(release): remove most of the outdated docs and github.ibm.com ref…
Browse files Browse the repository at this point in the history
…erences (#2465)
  • Loading branch information
Christopher A. Dhanaraj authored and GitHub Enterprise committed Mar 30, 2017
1 parent 5f6a46a commit a4685a1
Show file tree
Hide file tree
Showing 82 changed files with 26 additions and 5,643 deletions.
25 changes: 11 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,18 @@
# Bluemix Components
# Carbon Components

[![Build Status](https://travis.innovate.ibm.com/Bluemix/bluemix-components.svg?token=PscWax4p1FECdA5aCxvd&branch=master)](https://travis.innovate.ibm.com/Bluemix/bluemix-components)
The Carbon Design System is a series of individual styles and components, that when combined make beautiful, intuitive designs. These designs are systemic and logical, as they all follow the same universal principles.

##### Component library for building Bluemix
The component library gives developers a collection of re-usable HTML and SCSS partials for building their products.

> Browse component library on our [Design System](http://design-system.stage1.mybluemix.net/) website.
# How to install

- Bluemix Components gives developers (FEDs & Engineers) a collection of re-usable HTML and Sass partials they can use for building websites and user-interfaces for Bluemix.
Using npm,

- The aim is for every developer to use consistent markup, styles, and behavior in their prototype and production work.
```
npm install -S carbon-components
```

## :books: Documentation
# :books: Documentation

* [Install](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/install.md): How to install bluemix-components
* [Update](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/update.md): Info for updating bluemix-components
* [Styles](https://github.ibm.com/Bluemix/bluemix-components/tree/master/docs/styles): How to use styles from bluemix-components
- [Using SCSS with Gulp](https://github.ibm.com/Bluemix/bluemix-components/tree/master/docs/styles/gulp): Tutorial for setting up a project that compiles SCSS from bluemix-components using gulp
* [Contributing](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/contributing.md): Guidelines for making contributions to this repo.
* [Core Team](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/core-team.md): Guidelines for repo maintainers (Bluemix Design System Team).
* [FAQ](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/faq.md): Solutions for common errors and answers to common questions
* See our documentation site [here](http://carbondesignsystem.com/getting-started/developers) for full how-to docs and guidelines
* [Contributing](blob/master/docs/contributing.md): Guidelines for making contributions to this repo.
45 changes: 13 additions & 32 deletions docs/contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@

Set up your SSH Key GitHub Enterprise account and install node.js 4 or higher.
* [Generating SSH Keys - GitHub](https://help.github.com/articles/generating-ssh-keys/)
* [`NVM` (node version manager)](https://github.com/creationix/nvm) to use the latest version of `node.js` (4 or higher).
* [`NVM` (node version manager)](https://github.com/creationix/nvm) to use the `Node 6`.

Contributing to bluemix-components requires that you can run this repo locally on your computer.
Contributing to carbon-components requires that you can run this repo locally on your computer.

## Class names

Expand Down Expand Up @@ -36,17 +36,11 @@ __SCSS__
Follow BEM naming convention for classes. Again, the only thing we do differently is prefix all classes with `bx--`.

```scss
.bx--block
.bx--block__element
.bx--block--modifier
```

For bluemix-components, `block` would be a component-based name.

```scss
.bx--component__element
.bx--component--modifier
```

### Start a new `block` or `element`?

A nested element can use a new block name as long as the styles are independent of the parent.
Expand Down Expand Up @@ -83,13 +77,9 @@ button
Also note that all variants of a component can live in a single HTML, SCSS and JS file respectively.
For example, while there are many button variants (primary, secondary, etc.), they're all contained in those single source files in the button folder.



## 1. Fork The Repo:

Go to [bluemix-components](https://github.ibm.com/Bluemix/bluemix-components) and click the "Fork" button in the top-right corner.

![fork](https://uploads.github.ibm.com/github-enterprise-assets/0000/0076/0000/9136/2dbf657c-ca8e-11e5-9558-605d0e372cbd.png)
Go to [bluemix-components](https://github.com/carbon-design-system/carbon-components) and click the "Fork" button in the top-right corner.

## 2. Clone Your Fork:

Expand All @@ -100,20 +90,19 @@ Go to [bluemix-components](https://github.ibm.com/Bluemix/bluemix-components) an
In your terminal:

```sh
git clone git@github.ibm.com:{ YOUR_USERNAME }/bluemix-components.git
cd bluemix-components
git clone git@github.com:{ YOUR_USERNAME }/carbon-components.git
cd carbon-components
```

See [GitHub docs](https://help.github.com/articles/fork-a-repo/) for more details.


## 3. Add Remotes

When you clone your personal repo, you will see `origin` is set up for you already by default. This should be pointing to your personal repo.

```sh
git remote add upstream git@github.ibm.com:Bluemix/bluemix-components.git
git remote add {{YOUR_NAME_HERE}} git@github.ibm.com:{{YOUR_NAME_HERE}}/bluemix-components.git
git remote add upstream git@github.com:carbon-design-system/carbon-components.git
git remote add {{YOUR_NAME_HERE}} git@github.com:{{YOUR_NAME_HERE}}/carbon-components.git

# List all your remotes
git remote -v
Expand All @@ -122,7 +111,7 @@ git remote -v
When you do `git remote -v`, you'll see these remotes:
* `origin`: connection to your fork
* `upstream`: connection to the original project.
* `bthan`: connection to [Brian Han's](https://github.ibm.com/bthan/bluemix-components) fork.
* `bthan`: connection to [Brian Han's](https://github.com/bthan/carbon-components) fork.

## 4. Work in a Branch

Expand Down Expand Up @@ -211,21 +200,19 @@ If you are very sure that your change affects a specific set of components, you
gulp test:a11y -f consumables/html/components/fab/fab.html
```

The a11y test may report potential issues that should be handled in application-level, not in bluemix-components code. In such case, you can ignore those issues by adding an item to `shouldIssueBeIgnoredForRule` table in [tests/a11y/global-ignore-aat-issues.js](https://github.ibm.com/Bluemix/bluemix-components/blob/master/tests/a11y/global-ignore-aat-issues.js). The table is keyed by something like `wcag20.tech.h59.linkValid` which helps indentifying what RPT rule to ignore. You can specify `true` to the value which ignores all violations of the rule, or a function which takes the DOM element violating the rule and returns `true` if such violation should be ignored.
The a11y test may report potential issues that should be handled in application-level, not in bluemix-components code. In such case, you can ignore those issues by adding an item to `shouldIssueBeIgnoredForRule` table in [tests/a11y/global-ignore-aat-issues.js](https://github.com/carbon-design-system/carbon-components/blob/master/tests/a11y/global-ignore-aat-issues.js). The table is keyed by something like `wcag20.tech.h59.linkValid` which helps indentifying what RPT rule to ignore. You can specify `true` to the value which ignores all violations of the rule, or a function which takes the DOM element violating the rule and returns `true` if such violation should be ignored.

## 7. Make a Pull Request

**Note:** Before you make a pull request, [search](https://github.ibm.com/Bluemix/bluemix-components/issues) the issues to see if a similar issue has already been submitted. If a similar issue has been submitted, assign yourself or ask to be assigned to the issue by posting a comment. If the issue does not exist, create a new issue.
**Note:** Before you make a pull request, [search](https://github.com/carbon-design-system/carbon-components/issues) the issues to see if a similar issue has already been submitted. If a similar issue has been submitted, assign yourself or ask to be assigned to the issue by posting a comment. If the issue does not exist, create a new issue.

When you're at a good stopping place and you're ready for feedback from other contributors and maintainers, **push your commits to your fork**:

```
git push origin { YOUR_BRANCH_NAME }
```

In your browser, navigate to [Bluemix/bluemix-components](https://github.ibm.com/Bluemix/bluemix-components) and click the button that reads "Compare & pull request"

![pull request](https://uploads.github.ibm.com/github-enterprise-assets/0000/0076/0000/9135/2dadf224-ca8e-11e5-8eba-bdbe6d698b08.png)
In your browser, navigate to [Bluemix/bluemix-components](https://github.com/carbon-design-system/carbon-components) and click the button that reads "Compare & pull request"

> **Is it a Breaking Change?**
Expand All @@ -246,14 +233,10 @@ Before you create a pull request, change the base branch depending on what kind
* Pull requests with **non-breaking changes** like patches and minor updates use the `master` as the base branch.
* Pull requests with **breaking changes** use the latest `major version number` branch as the base branch (i.e. `7.0.0` or whatever the next major version is).

![base-branch](https://media.github.ibm.com/user/76/files/897f441c-16ca-11e6-9704-eb6f8ac4452a)

Write a title and description then click "Create pull request"

![write pull request](https://uploads.github.ibm.com/github-enterprise-assets/0000/0076/0000/9126/099cd824-ca88-11e5-89d7-94458a4d9ae3.png)
* [How to write the perfect pull request](https://github.com/blog/1943-how-to-write-the-perfect-pull-request)


## 8. Updating a Pull Request

Stay up to date with the activity in your pull request. Maintainers from the Design System team will be reviewing your work and making comments, asking questions and suggesting changes to be made before they merge your code.
Expand All @@ -262,6 +245,4 @@ Stay up to date with the activity in your pull request. Maintainers from the Des

When you need to make a change, add, commit and push to your branch normally.

Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.


Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.
56 changes: 0 additions & 56 deletions docs/core-team.md

This file was deleted.

70 changes: 0 additions & 70 deletions docs/getting-started/faq.md

This file was deleted.

101 changes: 0 additions & 101 deletions docs/getting-started/install.md

This file was deleted.

Loading

0 comments on commit a4685a1

Please sign in to comment.