Skip to content
This repository has been archived by the owner on Jan 13, 2025. It is now read-only.

Commit

Permalink
docs: Rewrite all instances of "MDC-Web" as "MDC Web" (#1960)
Browse files Browse the repository at this point in the history
Resolves #1924
  • Loading branch information
chaficnajjar authored and lynnmercier committed Jan 17, 2018
1 parent e87c110 commit 6078784
Show file tree
Hide file tree
Showing 31 changed files with 172 additions and 172 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ feature requests.
If you'd like to work on a component, please ensure that you *submit an Engineering Outline before
submitting a pull request*. You can read more about this in our [contributing docs](https://github.com/material-components/material-components-web/blob/master/CONTRIBUTING.md#building-components).

MDC-Web is still under active development. You can see our current progress on [master](https://github.com/material-components/material-components-web/tree/master) as well as an overview of our [architecture and practices](https://github.com/material-components/material-components-web/blob/master/docs/code).
MDC Web is still under active development. You can see our current progress on [master](https://github.com/material-components/material-components-web/tree/master) as well as an overview of our [architecture and practices](https://github.com/material-components/material-components-web/blob/master/docs/code).

If you're interested in information for a specific component, check out our [component issues](https://github.com/material-components/material-components-web/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aopen%20label%3Av2-component) to see which milestone it's associated with and subscribe to updates to it. If an issue has the `in-tracker` label, you can also take a look at our [public Pivotal Tracker](https://www.pivotaltracker.com/n/projects/1664011) for a rough estimate of when we'll get to it.

Expand All @@ -25,7 +25,7 @@ Our team prioritizes responding to as many engineering and user experience quest

Follow the template below to ensure the quickest and most accurate response to your issue.

### What MDC-Web Version are you using?
### What MDC Web Version are you using?

> Please be specific, e.g. _major.minor.patch_
Expand Down
14 changes: 7 additions & 7 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Contributing to Material Components Web (MDC-Web)
# Contributing to Material Components Web (MDC Web)

We'd love for you to contribute and make Material Components for the web even better than it is today!
Here are the guidelines we'd like you to follow:
Expand All @@ -8,7 +8,7 @@ Here are the guidelines we'd like you to follow:
- [Setting up your development environment](#setting-up-your-development-environment)
- [Building Components](#building-components)
- [Running the development server](#running-the-development-server)
- [Building MDC-Web](#building-mdc-web)
- [Building MDC Web](#building-mdc-web)
- [Linting / Testing / Coverage Enforcement](#linting--testing--coverage-enforcement)
- [Running Tests across browsers](#running-tests-across-browsers)
- [Coding Style](#coding-style)
Expand All @@ -20,11 +20,11 @@ The Material Components contributing policies and procedures can be found in the

## Development Process

We strive to make developing Material Components Web as frictionless as possible, both for ourselves and for our community. This section should get you up and running working on the MDC-Web codebase. Before beginning development, you may want to read through our overview on [architecture and best practices](./docs/code) to get a better understanding of our overall structure.
We strive to make developing Material Components Web as frictionless as possible, both for ourselves and for our community. This section should get you up and running working on the MDC Web codebase. Before beginning development, you may want to read through our overview on [architecture and best practices](./docs/code) to get a better understanding of our overall structure.

### Setting up your development environment

You'll need a recent version of [nodejs](https://nodejs.org/en/) to work on MDC-Web. We [test our builds](https://travis-ci.org/material-components/material-components-web) using both the latest and LTS node versions, so use of one of those is recommended. You can use [nvm](https://github.com/creationix/nvm) to easily install and manage different versions of node on your system.
You'll need a recent version of [nodejs](https://nodejs.org/en/) to work on MDC Web. We [test our builds](https://travis-ci.org/material-components/material-components-web) using both the latest and LTS node versions, so use of one of those is recommended. You can use [nvm](https://github.com/creationix/nvm) to easily install and manage different versions of node on your system.

> **NOTE**: If you expect to commit updated or new dependencies, please ensure you are using npm 5, which will
> also update `package-lock.json` correctly when you install or upgrade packages.
Expand Down Expand Up @@ -75,12 +75,12 @@ MDC_ENV=development npm run build && gcloud app deploy app.yaml --project google
gcloud app browse
```

The above script will build and deploy the app to mdc-web's dev server with your userid as its version number, you can switch to your version by prepending `$USER-dot-` to the URL opened when you run `gcloud app browse`. This would be helpful if we need to share work-in-progress work within teams and designers.
The above script will build and deploy the app to MDC Web's dev server with your userid as its version number, you can switch to your version by prepending `$USER-dot-` to the URL opened when you run `gcloud app browse`. This would be helpful if we need to share work-in-progress work within teams and designers.

### Building MDC-Web
### Building MDC Web

```
npm run build # Builds an unminified version of MDC-Web within build/
npm run build # Builds an unminified version of MDC Web within build/
npm run build:min # Same as above, but enables minification
npm run dist # Cleans out build/ and runs both of the above commands sequentially
```
Expand Down
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

# Material Components for the web

Material Components for the web (MDC-Web) helps developers execute [Material Design](https://www.material.io).
Material Components for the web (MDC Web) helps developers execute [Material Design](https://www.material.io).
Developed by a core team of engineers and UX designers at Google, these components enable a reliable development workflow to build beautiful and functional web projects.

Material Components for the web is the successor to [Material Design Lite](https://getmdl.io/), and has 3 high-level goals:
Expand All @@ -16,11 +16,11 @@ Material Components for the web is the successor to [Material Design Lite](https
- [RMWC: React Material Web Components](https://github.com/jamesmfriedman/rmwc)
- [Angular MDC](https://github.com/trimox/angular-mdc-web)
- [Blox Material](https://blox.src.zone/material): Angular Integration Library.
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC-Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).)
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC-Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components))
- [Vue MDC Adapter](https://github.com/stasson/vue-mdc-adapter): MDC Web Integration for Vue.js (using [foundation/adapters](./docs/integrating-into-frameworks.md#the-advanced-approach-using-foundations-and-adapters).)
- [Material Components Vue](https://github.com/matsp/material-components-vue): MDC Web Integration for Vue.js (using [vanilla components](./docs/integrating-into-frameworks.md#the-simple-approach-wrapping-mdc-web-vanilla-components))
- More coming soon! Feel free to submit a pull request adding your library to this list, so long as you meet our [criteria](docs/integrating-into-frameworks.md).

MDC-Web strives to seamlessly incorporate into a wider range of usage contexts, from simple static websites to complex, JavaScript-heavy applications to hybrid client/server rendering systems. In short, whether you're already heavily invested in another framework or not, it should be easy to incorporate Material Components into your site in a lightweight, idiomatic fashion.
MDC Web strives to seamlessly incorporate into a wider range of usage contexts, from simple static websites to complex, JavaScript-heavy applications to hybrid client/server rendering systems. In short, whether you're already heavily invested in another framework or not, it should be easy to incorporate Material Components into your site in a lightweight, idiomatic fashion.

**[Demos](https://material-components-web.appspot.com/)** (updated with every release)

Expand Down Expand Up @@ -61,7 +61,7 @@ introduction to the library.

## Installing individual components

MDC-Web is modular by design. Each component lives within its own packages under the
MDC Web is modular by design. Each component lives within its own packages under the
[@material npm org](https://www.npmjs.com/org/material).

```
Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,4 +11,4 @@ This section includes supporting documentation aimed to both improve the onboard

To jump right in and begin using the library, check out our [Getting Started Guide](./getting-started.md)

If you're interested in a general overview of MDC-Web, check out [the MDC Repository README](../README.md).
If you're interested in a general overview of MDC Web, check out [the MDC Repository README](../README.md).
28 changes: 14 additions & 14 deletions docs/authoring-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ path: /docs/authoring-components/

# Authoring Components

This document serves as a reference for developing components either directly for MDC-Web or
external components that would like to interface with the MDC-Web ecosystem.
This document serves as a reference for developing components either directly for MDC Web or
external components that would like to interface with the MDC Web ecosystem.

> Please note that since this project is still in its early stages of development, these practices
may be subject to change. They will stabilize as we near towards a full release.
Expand All @@ -31,7 +31,7 @@ may be subject to change. They will stabilize as we near towards a full release.
* [Design adapter interfaces to be simple and intuitive](#design-adapter-interfaces-to-be-simple-and-intuitive)
* [Do not reference host objects within foundation code.](#do-not-reference-host-objects-within-foundation-code)
* [Clean up all references on destruction](#clean-up-all-references-on-destruction)
* [Authoring components for MDC-Web](#authoring-components-for-mdc-web)
* [Authoring components for MDC Web](#authoring-components-for-mdc-web)
* [File Structure](#file-structure)
* [License Stanzas](#license-stanzas)
* [Scss](#scss)
Expand All @@ -57,9 +57,9 @@ may be subject to change. They will stabilize as we near towards a full release.

The first two sections of this document describe general guidelines for how to think about building
a component, as well as criteria for what makes a good component. Anyone interested in building
components either directly for MDC-Web or as an external component that plays well within the
MDC-Web ecosystem should find it useful. The third section talks about authoring components
specifically for MDC-Web, and is best suited for those looking to contribute directly to the
components either directly for MDC Web or as an external component that plays well within the
MDC Web ecosystem should find it useful. The third section talks about authoring components
specifically for MDC Web, and is best suited for those looking to contribute directly to the
project.

Note that this document assumes you are familiar with the library and its
Expand All @@ -68,7 +68,7 @@ are brand new to the project, we recommend starting with our [Getting Started Gu

## How to build a component

This section outlines the thought process behind authoring new components for MDC-Web. It is
This section outlines the thought process behind authoring new components for MDC Web. It is
inspired by React's [Thinking in React](https://facebook.github.io/react/docs/thinking-in-react.html) article.

Starting out from nothing and going straight to a component/adapter/foundation implementation can be
Expand All @@ -79,7 +79,7 @@ following steps.

To demonstrate this approach, we will build a **red-blue toggle**, very simple toggle button that
toggles between a red background with blue text, and vice versa. While not a Material Design
component, it demonstrates the concepts of how to think about building for MDC-Web.
component, it demonstrates the concepts of how to think about building for MDC Web.

### Start with a simple component prototype

Expand Down Expand Up @@ -144,10 +144,10 @@ class RedblueTogglePrototype {
new RedblueTogglePrototype(document.querySelector('.redblue-toggle'));
```

Note how the JS Component does not reference MDC-Web in any way, nor does it have any notion
Note how the JS Component does not reference MDC Web in any way, nor does it have any notion
of foundations or adapters. By omitting this work, you can rapidly experiment with your component,
incorporating changes quickly and easily. Nonetheless, the way the component is prototype looks
quite similar to the way that the MDC-Web component will eventually be built.
quite similar to the way that the MDC Web component will eventually be built.

### Identify host environment interactions

Expand Down Expand Up @@ -457,9 +457,9 @@ may be retained. There are two accurate litmus tests to ensure this is being don
is kept track of, and cleaned up within destroy. For example, every `setTimeout()` call should have its ID retained by the foundation/component, and have `clearTimeout()` called on it within
destroy.

## Authoring components for MDC-Web
## Authoring components for MDC Web

The following guidelines are for those who wish to contribute directly to MDC-web. In addition to
The following guidelines are for those who wish to contribute directly to MDC Web. In addition to
adhering to all of the practices above, we have additional conventions we expect contributors to
adhere to. It's worth noting that most of these conventions - including our coding style, commit
message format, and test coverage - are _automatically enforced via linters_, both so that
Expand Down Expand Up @@ -761,13 +761,13 @@ Concretely:
> NOTE: This section was introduced as part of our [closure compatibility milestone](https://github.com/material-components/material-components-web/milestone/4). Our
currently existing components are in the process of being made compatible with closure.

All core MDC-Web components must be fully compatible with the Google Closure Compiler using its
All core MDC Web components must be fully compatible with the Google Closure Compiler using its
advanced compilation mechanisms. We've provided a thorough explanation of this, as well as
conventions, examples, and common closure patterns you may not be used to, in our [closure compiler documentation](./closure-compiler.md).

### Testing

The following guidelines should be used to help write tests for MDC-Web code. Our tests are written
The following guidelines should be used to help write tests for MDC Web code. Our tests are written
using [mocha](https://mochajs.org/) with the [qunit UI](https://mochajs.org/#qunit), and are driven by [karma](https://karma-runner.github.io/1.0/index.html). We use the [chai assert API](http://chaijs.com/api/assert/)
for assertions, and [testdouble](https://github.com/testdouble/testdouble.js/) for mocking and stubbing.

Expand Down
24 changes: 12 additions & 12 deletions docs/closure-compiler.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,26 +5,26 @@ section: docs
path: /docs/closure-compiler/
-->

# Annotating MDC-Web for the Closure Compiler
# Annotating MDC Web for the Closure Compiler

> TL;DR read the section on our [type system](#mdc-web-type-system) and our [closure compiler conventions](#mdc-web-closure-conventions).
## Who this document is for

This document is for _core contributors to MDC-Web, as well as contributors who wish to author
This document is for _core contributors to MDC Web, as well as contributors who wish to author
new components, or make non-trivial changes to existing components._ It assumes you're familiar with
our codebase, and have read through most of our [Authoring Components guide](./authoring-components.md).

## Why this is needed

MDC-Web - and Material Design in general - was created by Google. Therefore, it is not only a top
priority that MDC-Web works seamlessly for our external community, but also that _MDC-Web works
MDC Web - and Material Design in general - was created by Google. Therefore, it is not only a top
priority that MDC Web works seamlessly for our external community, but also that _MDC Web works
seamlessly for all Google applications_.

At Google, all Javascript is processed and minified by the
[Closure Compiler](https://github.com/google/closure-compiler) (which will be referred to as
**closure**, the **compiler**, or any combination of those terms). Thus, _in order for every Google
application to deem MDC-Web viable for use within it, the library must be compilable using
application to deem MDC Web viable for use within it, the library must be compilable using
closure's [advanced compilation](https://developers.google.com/closure/compiler/docs/api-tutorial3)
mechanisms_.

Expand Down Expand Up @@ -68,12 +68,12 @@ accessor properties).
You can use [this starter template](https://goo.gl/YSQkDi) to help debug your closure code, which
has all of the above settings pre-configured (Even though the UI shows optimization is simple).

## MDC-Web Type System
## MDC Web Type System

The following UML-like diagram shows a conceptual overview of the basic type system for MDC-Web. The
The following UML-like diagram shows a conceptual overview of the basic type system for MDC Web. The
diagram uses closure-esque type syntax, and represents what's in [mdc-base](../packages/mdc-base).

![MDC-Web Type System UML(-like) diagram](https://docs.google.com/drawings/d/1mJBPiUkdFiXkU5A6kAdpZD5nXr6NkHIIW_vMNVdIvYY/pub?w=960&h=720)
![MDC Web Type System UML(-like) diagram](https://docs.google.com/drawings/d/1mJBPiUkdFiXkU5A6kAdpZD5nXr6NkHIIW_vMNVdIvYY/pub?w=960&h=720)

> Note that the actual code to express this parameterization will vary slightly from the UML above,
since closure does not support bounded generics.
Expand All @@ -90,13 +90,13 @@ The overall type system is relatively straightforward, and boils down to 3 main
`MDCRippleAdapter`. Thus, when declaring the `MDCRipple` class, the proper JSDoc to specify this
would be included: `@extends MDCComponent<!MDCRippleFoundation>`.

## MDC-Web Closure Conventions
## MDC Web Closure Conventions

The following guidelines outline the general conventions for writing closurized code for MDC-Web.
The following guidelines outline the general conventions for writing closurized code for MDC Web.
This section should contain most - if not all - of what you need to get up and running writing
closure for our codebase. It also includes an [example component skeleton](#an-example-component-skeleton).

### Making MDC-Web aware of closure components (temporary)
### Making MDC Web aware of closure components (temporary)

Until our [closure compatibility milestone](https://github.com/material-components/material-components-web/milestone/4) has been reached, please ensure that whenever a
component is annotated, it's directory name under `packages/` is added to the `"closureWhitelist"`
Expand Down Expand Up @@ -772,6 +772,6 @@ be found within that file.
## Where to go for more help
If you're working on an issue for MDC-Web and find yourself wrestling with closure, please don't
If you're working on an issue for MDC Web and find yourself wrestling with closure, please don't
hesitate to [reach out on our discord channel](https://discord.gg/pRKaJB9) and we'll try and help
you out.
2 changes: 1 addition & 1 deletion docs/codelabs/building-beautiful-sites/README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
This directory hosts a [Google Codelab](https://codelabs.developers.google.com/) demonstrating how
to use MDC-Web to easily build beautiful sites. It will be publicly available shortly.
to use MDC Web to easily build beautiful sites. It will be publicly available shortly.
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>Shrine (MDC-Web Example App)</title>
<title>Shrine (MDC Web Example App)</title>
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" sizes="192x192" href="https://material.io/static/images/simple-lp/favicons/components-192x192.png">
<link rel="shortcut icon" href="https://material.io/static/images/simple-lp/favicons/components-72x72.png">
Expand Down
Loading

0 comments on commit 6078784

Please sign in to comment.