Skip to content
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.

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

[docs] Move links to the master branch #15830

Merged
merged 3 commits into from May 24, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/1.bug.md
Expand Up @@ -30,10 +30,10 @@ about: Create a bug report for Material-UI
Include code to reproduce, if relevant (which it most likely is).

This codesandbox.io template _may_ be a good starting point:
https://codesandbox.io/s/github/mui-org/material-ui/tree/next/examples/create-react-app
https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app

If you're using typescript a better starting point would be
https://codesandbox.io/s/github/mui-org/material-ui/tree/next/examples/create-react-app-with-typescript
https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app-with-typescript

If YOU DO NOT take time to provide a codesandbox.io reproduction, should the COMMUNITY take time to help you?

Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
@@ -1,3 +1,3 @@
<!-- Thanks so much for your PR, your contribution is appreciated! ❤️ -->

- [ ] I have followed (at least) the [PR section of the contributing guide](https://github.com/mui-org/material-ui/blob/next/CONTRIBUTING.md#submitting-a-pull-request).
- [ ] I have followed (at least) the [PR section of the contributing guide](https://github.com/mui-org/material-ui/blob/master/CONTRIBUTING.md#submitting-a-pull-request).
23 changes: 9 additions & 14 deletions CONTRIBUTING.md
Expand Up @@ -10,31 +10,26 @@ When in doubt, keep your pull requests small. To give a PR the best chance of ge

As with issues, please begin the title with [ComponentName].

When adding new features or modifying existing, please attempt to include tests to confirm the new behaviour. You can read more about our test setup in our test [README](https://github.com/mui-org/material-ui/blob/next/test/README.md).
When adding new features or modifying existing, please attempt to include tests to confirm the new behaviour. You can read more about our test setup in our test [README](https://github.com/mui-org/material-ui/blob/master/test/README.md).

When submitting a new component, please add it to the [lab](https://github.com/mui-org/material-ui/tree/next/packages/material-ui-lab).
When submitting a new component, please add it to the [lab](https://github.com/mui-org/material-ui/tree/master/packages/material-ui-lab).

### Branch Structure

All stable releases are tagged ([view tags](https://github.com/mui-org/material-ui/tags)).
At any given time, `next` represents the latest development version of the library.
At any given time, `master` represents the latest development version of the library.
Patches or hotfix releases are prepared on an independent branch.

#### `next` is unsafe
#### `master` is for 4.x

We will do our best to keep `next` in good shape, with tests passing at all times.
We will do our best to keep `master` in good shape, with tests passing at all times.
However, in order to move fast, we will make API changes that your application might not be compatible with.
Copy link
Member

Choose a reason for hiding this comment

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

Is that true for master?

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh no, we don't 🙏!


#### `master` is for 3.x

Only important bug fixes should be applied to `master` at this point.

### How to increase the chance of being accepted?

We will only accept a pull request for which all tests pass. Make sure the following is true:
- The branch is targeted at:
- `master` for important fixes.
- `next` for everything else including breaking changes.
- `master` for ongoing development.
- The branch is not behind its target.
- If a breaking change is introduced:
Copy link
Member

Choose a reason for hiding this comment

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

?

- There is an open RFC issue that the PR addresses.
Expand Down Expand Up @@ -67,8 +62,8 @@ Please create a new branch from an up to date master on your fork. (Note, urgent
If you have an existing local repository, please update it before you start, to minimise the chance of merge conflicts.
```sh
git remote add upstream git@github.com:mui-org/material-ui.git
git checkout next
git pull upstream next
git checkout master
git pull upstream master
git checkout -b my-topic-branch
yarn
```
Expand Down Expand Up @@ -201,7 +196,7 @@ these changes across the localized versions.

## Roadmap

To get a sense of where Material-UI is heading, or for ideas on where you could contribute, take a look at the [ROADMAP](https://github.com/mui-org/material-ui/blob/next/ROADMAP.md).
To get a sense of where Material-UI is heading, or for ideas on where you could contribute, take a look at the [ROADMAP](https://github.com/mui-org/material-ui/blob/master/ROADMAP.md).

## License

Expand Down
2 changes: 1 addition & 1 deletion GOVERNANCE.md
Expand Up @@ -39,7 +39,7 @@ also contribute in the following ways.
and [issues](https://github.com/mui-org/material-ui/issues).
- Reporting bugs or missing features by [creating an issue](https://github.com/mui-org/material-ui/issues/new).
- Fixing bugs, adding features, and
[improving our documentation](https://github.com/mui-org/material-ui/tree/next/docs) by
[improving our documentation](https://github.com/mui-org/material-ui/tree/master/docs) by
[submitting a pull request](https://github.com/mui-org/material-ui/pulls).

### Committers
Expand Down
10 changes: 5 additions & 5 deletions README.md
Expand Up @@ -10,15 +10,15 @@

[![npm package](https://img.shields.io/npm/v/@material-ui/core/latest.svg)](https://www.npmjs.com/package/@material-ui/core)
[![npm downloads](https://img.shields.io/npm/dm/@material-ui/core.svg)](https://www.npmjs.com/package/@material-ui/core)
[![CircleCI](https://img.shields.io/circleci/project/github/mui-org/material-ui/next.svg)](https://circleci.com/gh/mui-org/material-ui/tree/next)
[![CircleCI](https://img.shields.io/circleci/project/github/mui-org/material-ui/master.svg)](https://circleci.com/gh/mui-org/material-ui/tree/master)
[![Join the community on Spectrum](https://withspectrum.github.io/badge/badge.svg)](https://spectrum.chat/material-ui)
[![Coverage Status](https://img.shields.io/codecov/c/github/mui-org/material-ui/next.svg)](https://codecov.io/gh/mui-org/material-ui/branch/next)
[![Coverage Status](https://img.shields.io/codecov/c/github/mui-org/material-ui/master.svg)](https://codecov.io/gh/mui-org/material-ui/branch/master)
[![CII Best Practices](https://bestpractices.coreinfrastructure.org/projects/1320/badge)](https://bestpractices.coreinfrastructure.org/projects/1320)
![Code style](https://img.shields.io/badge/code_style-prettier-ff69b4.svg)
[![Follow on Twitter](https://img.shields.io/twitter/follow/MaterialUI.svg?label=follow+Material-UI)](https://twitter.com/MaterialUI)
[![PeerDependencies](https://david-dm.org/mui-org/material-ui/next/peer-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/next?type=peer&path=packages/material-ui)
[![Dependencies](https://david-dm.org/mui-org/material-ui/next/status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/next?path=packages/material-ui)
[![DevDependencies](https://david-dm.org/mui-org/material-ui/next/dev-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/next?type=dev)
[![PeerDependencies](https://david-dm.org/mui-org/material-ui/master/peer-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=peer&path=packages/material-ui)
[![Dependencies](https://david-dm.org/mui-org/material-ui/master/status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?path=packages/material-ui)
[![DevDependencies](https://david-dm.org/mui-org/material-ui/master/dev-status.svg?path=packages/material-ui)](https://david-dm.org/mui-org/material-ui/master?type=dev)
[![Average time to resolve an issue](http://isitmaintained.com/badge/resolution/mui-org/material-ui.svg)](http://isitmaintained.com/project/mui-org/material-ui "Average time to resolve an issue")
[![Crowdin](https://d322cqt584bo4o.cloudfront.net/material-ui-docs/localized.svg?cache=v1)](https://translate.material-ui.com/project/material-ui-docs)

Expand Down
2 changes: 1 addition & 1 deletion docs/README.md
Expand Up @@ -14,7 +14,7 @@ If you do not have yarn installed, select your OS and follow the instructions on

## How can I add a new demo to the documentation?

[You can follow this guide](https://github.com/mui-org/material-ui/blob/next/CONTRIBUTING.md)
[You can follow this guide](https://github.com/mui-org/material-ui/blob/master/CONTRIBUTING.md)
on how to get started contributing to Material-UI.

## How do I help improve to the translations?
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/AppSearch.js
Expand Up @@ -52,7 +52,7 @@ function initDocsearch(userLanguage) {
indexName: 'material-ui',
inputSelector: '#docsearch-input',
algoliaOptions: {
facetFilters: ['version:next', `language:${userLanguage}`],
facetFilters: ['version:master', `language:${userLanguage}`],
},
handleSelected: (input, event, suggestion) => {
event.button = 0;
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/EditPage.js
Expand Up @@ -5,7 +5,7 @@ import Button from '@material-ui/core/Button';

const LOCALES = { zh: 'zh-CN', pt: 'pt-BR', es: 'es-ES' };
const CROWDIN_ROOT_URL = 'https://translate.material-ui.com/project/material-ui-docs/';
const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/edit/next';
const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/edit/master';

function EditPage(props) {
const { markdownLocation, t, userLanguage } = props;
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/Head.js
Expand Up @@ -32,7 +32,7 @@ function Head(props) {
<meta property="og:ttl" content="604800" />
{/* Algolia */}
<meta name="docsearch:language" content={userLanguage} />
<meta name="docsearch:version" content="next" />
<meta name="docsearch:version" content="master" />
</NextHead>
);
}
Expand Down
4 changes: 2 additions & 2 deletions docs/src/modules/components/HomeFooter.js
Expand Up @@ -60,7 +60,7 @@ function HomeFooter(props) {
<li className={classes.listItem}>
<Link
color="inherit"
href="https://github.com/mui-org/material-ui/tree/next/examples"
href="https://github.com/mui-org/material-ui/tree/master/examples"
>
{t('examples')}
</Link>
Expand Down Expand Up @@ -99,7 +99,7 @@ function HomeFooter(props) {
license: (
<Link
color="inherit"
href="https://github.com/mui-org/material-ui/blob/next/LICENSE"
href="https://github.com/mui-org/material-ui/blob/master/LICENSE"
>
{t('license')}
</Link>
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/HomeSteps.js
Expand Up @@ -122,7 +122,7 @@ function HomeSteps(props) {
variant="subtitle1"
component="div"
color="inherit"
href="https://github.com/mui-org/material-ui/tree/next/examples/cdn-next"
href="https://github.com/mui-org/material-ui/tree/master/examples/cdn-next"
gutterBottom
>
{t('cdn')}
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/components/MarkdownDocs.js
Expand Up @@ -85,7 +85,7 @@ const styles = theme => ({
},
});

const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/blob/next/docs/src';
const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/blob/master/docs/src';

function flattenPages(pages, current = []) {
return pages.reduce((items, item) => {
Expand Down
2 changes: 1 addition & 1 deletion docs/src/modules/utils/generateMarkdown.js
Expand Up @@ -7,7 +7,7 @@ import { Router } from 'next/router';
import { pageToTitle } from './helpers';
import { LANGUAGES_IN_PROGRESS } from 'docs/src/modules/constants';

const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/blob/next';
const SOURCE_CODE_ROOT_URL = 'https://github.com/mui-org/material-ui/blob/master';
const PATH_REPLACE_REGEX = /\\/g;
const PATH_SEPARATOR = '/';
const DEMO_IGNORE = LANGUAGES_IN_PROGRESS.map(language => `-${language}.md`);
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/components/portal/portal.md
Expand Up @@ -9,7 +9,7 @@ components: Portal

The children of the portal component will be appended to the `container` specified.

The component is used internally by the [`Modal`](/utils/modal/) and [`Popper`](/utils/popper/) components.
The component is used internally by the [`Modal`](/components/modal/) and [`Popper`](/components/popper/) components.
On the server, the content won't be rendered.
You have to wait for the client side hydratation to see the children.

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/customization/globals/globals.md
Expand Up @@ -24,7 +24,7 @@ const theme = createMuiTheme({

The list of these customization points for each component is documented under the **Component API** section.
For instance, you can have a look at the [Button](/api/button/#css).
Alternatively, you can always have a look at the [implementation](https://github.com/mui-org/material-ui/blob/next/packages/material-ui/src/Button/Button.js).
Alternatively, you can always have a look at the [implementation](https://github.com/mui-org/material-ui/blob/master/packages/material-ui/src/Button/Button.js).

## Default props

Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/discover-more/changelog/changelog.md
Expand Up @@ -2,4 +2,4 @@

<p class="description">Material-UI strictly follows Semantic Versioning 2.0.0.</p>

All notable changes are described in the [CHANGELOG.md file](https://github.com/mui-org/material-ui/blob/next/CHANGELOG.md).
All notable changes are described in the [CHANGELOG.md file](https://github.com/mui-org/material-ui/blob/master/CHANGELOG.md).
2 changes: 1 addition & 1 deletion docs/src/pages/discover-more/showcase/showcase.md
Expand Up @@ -2,7 +2,7 @@

<p class="description">The following is a list of some of the public apps using Material-UI.</p>

Want to add your app? Found an app that no longer works or no longer uses Material-UI? Please submit a pull request on [GitHub](https://github.com/mui-org/material-ui) to update [this page](https://github.com/mui-org/material-ui/blob/next/docs/src/pages/discover-more/showcase/appList.js)! We are looking for websites that rank well within these dimensions:
Want to add your app? Found an app that no longer works or no longer uses Material-UI? Please submit a pull request on [GitHub](https://github.com/mui-org/material-ui) to update [this page](https://github.com/mui-org/material-ui/blob/master/docs/src/pages/discover-more/showcase/appList.js)! We are looking for websites that rank well within these dimensions:

- Non-Material Design customization
- High traffic
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/discover-more/team/team.md
Expand Up @@ -7,6 +7,6 @@ Material-UI is maintained by a small group of invaluable core contributors, with
{{"demo": "pages/discover-more/team/Team.js", "hideHeader": true}}

Get involved with Material-UI development by [opening an issue](https://github.com/mui-org/material-ui/issues/new) or submitting a pull request.
Read our [contributing guidelines](https://github.com/mui-org/material-ui/blob/next/CONTRIBUTING.md) for information on how we develop.
Read our [contributing guidelines](https://github.com/mui-org/material-ui/blob/master/CONTRIBUTING.md) for information on how we develop.

[Join the Material-UI Community!](/discover-more/community/)
Expand Up @@ -2,22 +2,22 @@

<p class="description">Are you looking for an example project to get started?</p>

We host some example projects which you can find in the [GitHub repository](https://github.com/mui-org/material-ui) under the [`/examples`](https://github.com/mui-org/material-ui/tree/next/examples) folder:

- [Create React App](https://github.com/mui-org/material-ui/tree/next/examples/create-react-app-next)
- [Gatsby](https://github.com/mui-org/material-ui/tree/next/examples/gatsby-next)
- [Next.js](https://github.com/mui-org/material-ui/tree/next/examples/nextjs-next)
- [Parcel](https://github.com/mui-org/material-ui/tree/next/examples/parcel-next)
- [CDN](https://github.com/mui-org/material-ui/tree/next/examples/cdn-next)
- [Plain server-side](https://github.com/mui-org/material-ui/tree/next/examples/ssr-next)
We host some example projects which you can find in the [GitHub repository](https://github.com/mui-org/material-ui) under the [`/examples`](https://github.com/mui-org/material-ui/tree/master/examples) folder:

- [Create React App](https://github.com/mui-org/material-ui/tree/master/examples/create-react-app)
- [Gatsby](https://github.com/mui-org/material-ui/tree/master/examples/gatsby)
- [Next.js](https://github.com/mui-org/material-ui/tree/master/examples/nextjs)
- [Parcel](https://github.com/mui-org/material-ui/tree/master/examples/parcel)
- [CDN](https://github.com/mui-org/material-ui/tree/master/examples/cdn)
- [Plain server-side](https://github.com/mui-org/material-ui/tree/master/examples/ssr)
- And more

Create React App is an awesome project for learning React.
Have a look at [the alternatives available](https://github.com/facebook/create-react-app/blob/master/README.md#popular-alternatives) to see which project best fits your needs.

The source code for this documentation site is also included in the repository.
This is a slightly more complex project.
Check out the [`/docs`](https://github.com/mui-org/material-ui/tree/next/docs) folder for
Check out the [`/docs`](https://github.com/mui-org/material-ui/tree/master/docs) folder for
build instructions.

## More advanced example projects
Expand Down
2 changes: 1 addition & 1 deletion docs/src/pages/getting-started/faq/faq.md
Expand Up @@ -325,7 +325,7 @@ page](/customization/themes/) to learn about theme customization.

There are many ways to support Material-UI:

- Improve [the documentation](https://github.com/mui-org/material-ui/tree/next/docs).
- Improve [the documentation](https://github.com/mui-org/material-ui/tree/master/docs).
- Help others to get started.
- [Spread the word](https://twitter.com/MaterialUI).
- Answer questions on [StackOverflow](https://stackoverflow.com/questions/tagged/material-ui) or on [Spectrum](https://spectrum.chat/material-ui).
Expand Down