Skip to content

Commit a4685a1

Browse files
Christopher A. DhanarajGitHub Enterprise
Christopher A. Dhanaraj
authored and
GitHub Enterprise
committed
fix(release): remove most of the outdated docs and github.ibm.com references (#2465)
1 parent 5f6a46a commit a4685a1

File tree

82 files changed

+26
-5643
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

82 files changed

+26
-5643
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,18 @@
1-
# Bluemix Components
1+
# Carbon Components
22

3-
[![Build Status](https://travis.innovate.ibm.com/Bluemix/bluemix-components.svg?token=PscWax4p1FECdA5aCxvd&branch=master)](https://travis.innovate.ibm.com/Bluemix/bluemix-components)
3+
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.
44

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

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

9-
- 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.
9+
Using npm,
1010

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

13-
## :books: Documentation
15+
# :books: Documentation
1416

15-
* [Install](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/install.md): How to install bluemix-components
16-
* [Update](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/update.md): Info for updating bluemix-components
17-
* [Styles](https://github.ibm.com/Bluemix/bluemix-components/tree/master/docs/styles): How to use styles from bluemix-components
18-
- [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
19-
* [Contributing](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/contributing.md): Guidelines for making contributions to this repo.
20-
* [Core Team](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/core-team.md): Guidelines for repo maintainers (Bluemix Design System Team).
21-
* [FAQ](https://github.ibm.com/Bluemix/bluemix-components/blob/master/docs/getting-started/faq.md): Solutions for common errors and answers to common questions
17+
* See our documentation site [here](http://carbondesignsystem.com/getting-started/developers) for full how-to docs and guidelines
18+
* [Contributing](blob/master/docs/contributing.md): Guidelines for making contributions to this repo.

docs/contributing.md

Lines changed: 13 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@
44

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

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

1111
## Class names
1212

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

3838
```scss
39+
.bx--block
3940
.bx--block__element
4041
.bx--block--modifier
4142
```
4243

43-
For bluemix-components, `block` would be a component-based name.
44-
45-
```scss
46-
.bx--component__element
47-
.bx--component--modifier
48-
```
49-
5044
### Start a new `block` or `element`?
5145

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

86-
87-
8880
## 1. Fork The Repo:
8981

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

9484
## 2. Clone Your Fork:
9585

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

10292
```sh
103-
git clone git@github.ibm.com:{ YOUR_USERNAME }/bluemix-components.git
104-
cd bluemix-components
93+
git clone [email protected]:{ YOUR_USERNAME }/carbon-components.git
94+
cd carbon-components
10595
```
10696

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

109-
11099
## 3. Add Remotes
111100

112101
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.
113102

114103
```sh
115-
git remote add upstream git@github.ibm.com:Bluemix/bluemix-components.git
116-
git remote add {{YOUR_NAME_HERE}} git@github.ibm.com:{{YOUR_NAME_HERE}}/bluemix-components.git
104+
git remote add upstream [email protected]:carbon-design-system/carbon-components.git
105+
git remote add {{YOUR_NAME_HERE}} [email protected]:{{YOUR_NAME_HERE}}/carbon-components.git
117106

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

127116
## 4. Work in a Branch
128117

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

214-
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.
203+
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.
215204

216205
## 7. Make a Pull Request
217206

218-
**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.
207+
**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.
219208

220209
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**:
221210

222211
```
223212
git push origin { YOUR_BRANCH_NAME }
224213
```
225214

226-
In your browser, navigate to [Bluemix/bluemix-components](https://github.ibm.com/Bluemix/bluemix-components) and click the button that reads "Compare & pull request"
227-
228-
![pull request](https://uploads.github.ibm.com/github-enterprise-assets/0000/0076/0000/9135/2dadf224-ca8e-11e5-8eba-bdbe6d698b08.png)
215+
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"
229216

230217
> **Is it a Breaking Change?**
231218
@@ -246,14 +233,10 @@ Before you create a pull request, change the base branch depending on what kind
246233
* Pull requests with **non-breaking changes** like patches and minor updates use the `master` as the base branch.
247234
* 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).
248235

249-
![base-branch](https://media.github.ibm.com/user/76/files/897f441c-16ca-11e6-9704-eb6f8ac4452a)
250-
251236
Write a title and description then click "Create pull request"
252237

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

256-
257240
## 8. Updating a Pull Request
258241

259242
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.
@@ -262,6 +245,4 @@ Stay up to date with the activity in your pull request. Maintainers from the Des
262245

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

265-
Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.
266-
267-
248+
Once all revisiions to your pull request are complete, someone from Design Systems will squash and merge your commits for you.

docs/core-team.md

Lines changed: 0 additions & 56 deletions
This file was deleted.

docs/getting-started/faq.md

Lines changed: 0 additions & 70 deletions
This file was deleted.

docs/getting-started/install.md

Lines changed: 0 additions & 101 deletions
This file was deleted.

0 commit comments

Comments
 (0)