Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Documentation cleanup #910

Merged
merged 12 commits into from
May 29, 2018
Merged
6 changes: 3 additions & 3 deletions .github/CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
available at [https://www.contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct
2 changes: 1 addition & 1 deletion .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ community.

In order to ensure everyone has a fair, pleasant, and inclusive experience contributing to Neutrino, we ask that you
abide by our [community participation guidelines](./code-of-conduct.md), based on the
[Contributor Covenant](http://contributor-covenant.org/). Please read and understand it for everyone's benefit.
[Contributor Covenant](https://www.contributor-covenant.org/). Please read and understand it for everyone's benefit.

Following these guidelines helps to communicate that you respect the time of the developers managing
and developing Neutrino. In return, we will show you respect in addressing your issue, assessing changes,
Expand Down
1 change: 0 additions & 1 deletion CNAME

This file was deleted.

10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1><p align="center"><a href="https://neutrino.js.org"><img src="https://github.com/mozilla-neutrino/neutrino-dev/master/docs/assets/logo.png" height="150"></a></p></h1>
<h1><p align="center"><a href="https://neutrinojs.org"><img src="https://github.com/mozilla-neutrino/neutrino-dev/master/docs/assets/logo.png" height="150"></a></p></h1>

### Create and build modern JavaScript applications with zero initial configuration
#### Neutrino combines the power of webpack with the simplicity of presets.
Expand All @@ -23,7 +23,7 @@ cover.

## Documentation

See the [Neutrino docs](https://neutrino.js.org/)
See the [Neutrino docs](https://neutrinojs.org/)
for details on installation, getting started, usage, and customizing.

### Contributing
Expand All @@ -32,11 +32,11 @@ Thank you for wanting to help out with Neutrino! We are very happy that you want
this guide to help you get started. We want to do our best to help you make successful contributions and be part of our
community.

- [Contributing to Neutrino](https://neutrino.js.org/contributing/)
- [Participation Guidelines](https://neutrino.js.org/contributing/code-of-conduct/)
- [Contributing to Neutrino](https://neutrinojs.org/contributing/)
- [Participation Guidelines](https://neutrinojs.org/contributing/code-of-conduct/)

[npm-image]: https://img.shields.io/npm/v/neutrino.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino.svg
[npm-url]: https://npmjs.org/package/neutrino
[npm-url]: https://www.npmjs.com/package/neutrino
[travis-image]: https://travis-ci.org/mozilla-neutrino/neutrino-dev.svg?branch=master
[travis-url]: https://travis-ci.org/mozilla-neutrino/neutrino-dev
6 changes: 3 additions & 3 deletions docs/contributing/code-of-conduct.md
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ members of the project's leadership.
## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]
available at [https://www.contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
[homepage]: https://www.contributor-covenant.org
[version]: https://www.contributor-covenant.org/version/1/4/code-of-conduct
2 changes: 1 addition & 1 deletion docs/contributing/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ community.

In order to ensure everyone has a fair, pleasant, and inclusive experience contributing to Neutrino, we ask that you
abide by our [community participation guidelines](./code-of-conduct.md), based on the
[Contributor Covenant](http://contributor-covenant.org/). Please read and understand it for everyone's benefit.
[Contributor Covenant](https://www.contributor-covenant.org/). Please read and understand it for everyone's benefit.

Following these guidelines helps to communicate that you respect the time of the developers managing
and developing Neutrino. In return, we will show you respect in addressing your issue, assessing changes,
Expand Down
File renamed without changes.
9 changes: 2 additions & 7 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<h1><p align="center"><a href="https://neutrino.js.org"><img src="https://github.com/mozilla-neutrino/neutrino-dev/master/docs/assets/logo.png" height="150"></a></p></h1>
<h1><p align="center"><img src="assets/logo.png" height="150"></p></h1>

### Create and build modern JavaScript applications with zero initial configuration
#### Neutrino combines the power of webpack with the simplicity of presets.
Expand All @@ -21,13 +21,8 @@ your own presets by extending the Neutrino core ones to be shared across your ow
Presets can even be manipulated on a project-by-project basis to handle almost any build situation your preset doesn't
cover.

## Documentation

See the [Neutrino docs](https://neutrino.js.org/)
for details on installation, getting started, usage, and customizing.

[npm-image]: https://img.shields.io/npm/v/neutrino.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino.svg
[npm-url]: https://npmjs.org/package/neutrino
[npm-url]: https://www.npmjs.com/package/neutrino
[travis-image]: https://travis-ci.org/mozilla-neutrino/neutrino-dev.svg?branch=master
[travis-url]: https://travis-ci.org/mozilla-neutrino/neutrino-dev
4 changes: 2 additions & 2 deletions docs/learning-resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ community, file an issue or submit a pull request.

#### v5

* [Code Splitting for React Router with webpack and HMR](https://medium.com/@hassanhelfi/code-splitting-for-react-router-with-webpack-and-hmr-bb509968e86f) by [@hassanhelfi](https://twitter.com/hassanhelfi)
* [Code Splitting for React Router with webpack and HMR](https://hackernoon.com/code-splitting-for-react-router-with-webpack-and-hmr-bb509968e86f) by [@hassanhelfi](https://twitter.com/hassanhelfi)

#### v4

Expand All @@ -25,4 +25,4 @@ community, file an issue or submit a pull request.
#### v5

* [Bootstrap a Zero Configuration React App with Neutrino](https://egghead.io/lessons/react-bootstrap-a-zero-configuration-react-app-with-neutrino) by [@markshust](https://twitter.com/markshust)
* [Empower and Simplify JavaScript Development](https://www.youtube.com/watch?v=fz5jMdmKmRI) by [@eliperelman](https://twitter.com/eliperelman) at [@nebraskajs](http://nebraskajs.com)
* [Empower and Simplify JavaScript Development](https://www.youtube.com/watch?v=fz5jMdmKmRI) by [@eliperelman](https://twitter.com/eliperelman) at [@nebraskajs](https://nebraskajs.com)
2 changes: 1 addition & 1 deletion mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ pages:
- Create new project: './installation/create-new-project.md'
- Usage: './usage.md'
- Project Layout: './project-layout.md'
- FAQ: './FAQ.md'
- FAQ: './faq.md'
- Learning Resources: './learning-resources.md'
- CLI: './cli.md'
- API: './api.md'
Expand Down
4 changes: 2 additions & 2 deletions netlify.toml
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
[build]
# Using a non-root base directory combined with `cd ..` to prevent
# Using a non-root base directory/requirements file to prevent
# Netlify from finding package.json and trying to install that:
# https://github.com/netlify/build-image/issues/141
base = "docs"
publish = "build"
command = "cd .. && mkdocs build"
command = "../scripts/build-docs.sh"

# External links aren't supported in the sidebar, so we use
# placeholder pages that are then HTTP 301 redirected below.
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
"private": true,
"author": "Eli Perelman <eli@eliperelman.com>",
"license": "MPL-2.0",
"homepage": "https://neutrino.js.org",
"homepage": "https://neutrinojs.org",
"bugs": "https://github.com/mozilla-neutrino/neutrino-dev/issues",
"repository": "mozilla-neutrino/neutrino-dev",
"engines": {
Expand Down
20 changes: 10 additions & 10 deletions packages/airbnb-base/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ another Neutrino preset for building your application source code.

## Project Layout

`@neutrinojs/airbnb-base` follows the standard [project layout](https://neutrino.js.org/project-layout) specified by Neutrino. This
`@neutrinojs/airbnb-base` follows the standard [project layout](https://neutrinojs.org/project-layout/) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project.

Expand Down Expand Up @@ -152,7 +152,7 @@ module.exports = {

## Middleware options

This preset uses the same middleware options as [@neutrinojs/eslint](https://neutrino.js.org/packages/eslint).
This preset uses the same middleware options as [@neutrinojs/eslint](https://neutrinojs.org/packages/eslint/).
If you wish to customize what is included, excluded, or any ESLint options, you can provide an options object with the
middleware and this will be merged with our internal defaults for this preset. Use an array pair instead of a string
to supply these options.
Expand All @@ -175,7 +175,7 @@ module.exports = {

## Customizing

To override the build configuration, start with the documentation on [customization](https://neutrino.js.org/customization).
To override the build configuration, start with the documentation on [customization](https://neutrinojs.org/customization/).
`@neutrinojs/airbnb-base` creates some conventions to make overriding the configuration easier once you are ready to
make changes.

Expand All @@ -195,7 +195,7 @@ middleware.

### Override configuration

By following the [customization guide](https://neutrino.js.org/customization) and knowing the rule and loader IDs above,
By following the [customization guide](https://neutrinojs.org/customization/) and knowing the rule and loader IDs above,
you can also override or augment the build by providing a function to your `.neutrinorc.js` use array. You can also
make this change from the Neutrino API when using the `use` method.

Expand Down Expand Up @@ -244,7 +244,7 @@ If you cannot or do not wish to use Neutrino to execute one-off linting, you can
`@neutrinojs/eslint`, from which this preset inherits, also provides a method for getting the ESLint
configuration suitable for use in an eslintrc file. Typically this is used for providing hints or fix solutions to the
development environment, e.g. IDEs and text editors. Doing this requires
[creating an instance of the Neutrino API](https://neutrino.js.org/api) and providing the middleware it uses. If you keep all
[creating an instance of the Neutrino API](https://neutrinojs.org/api/) and providing the middleware it uses. If you keep all
this information in a `.neutrinorc.js`, this should be relatively straightforward. By providing all the middleware used
to Neutrino, you can ensure all the linting options used across all middleware will be merged together for your
development environment, without the need for copying, duplication, or loss of organization and separation.
Expand Down Expand Up @@ -291,8 +291,8 @@ or fixes.
Projects may face a problem when their editor or IDE lints all files and highlights errors that were normally excluded
from source, i.e. Neutrino's `include` and `exclude` options. This is because the ESLint CLI does not have a way to
specify included and excluded files from configuration. If you still wish to use ESLint's CLI for linting, consider
setting [CLI flags](http://eslint.org/docs/user-guide/command-line-interface#options) or using an
[eslintignore](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to choose which files to
setting [CLI flags](https://eslint.org/docs/user-guide/command-line-interface#options) or using an
[eslintignore](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to choose which files to
include or exclude from linting.

Unfortunately ESLint does not provide the possibility to configure ignored paths from Neutrino configuration and exclude them
Expand All @@ -309,14 +309,14 @@ configuration and boilerplate.

ESLint will exclude built files and any files in the root directory (e.g. custom Neutrino configuration) but `src` and
`test` folders will be still checked. `node_modules` are ignored by default in ESLint. More information can be found
in the [ESLint user guide](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories).
in the [ESLint user guide](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories).

## Contributing

This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets and middleware. Follow the
[contributing guide](https://neutrino.js.org/contributing) for details.
[contributing guide](https://neutrinojs.org/contributing/) for details.

[npm-image]: https://img.shields.io/npm/v/@neutrinojs/airbnb-base.svg
[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/airbnb-base.svg
[npm-url]: https://npmjs.org/package/@neutrinojs/airbnb-base
[npm-url]: https://www.npmjs.com/package/@neutrinojs/airbnb-base
2 changes: 1 addition & 1 deletion packages/airbnb-base/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"author": "Eli Perelman <eli@eliperelman.com>",
"license": "MPL-2.0",
"repository": "https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/airbnb-base",
"homepage": "https://neutrino.js.org",
"homepage": "https://neutrinojs.org",
"bugs": "https://github.com/mozilla-neutrino/neutrino-dev/issues",
"publishConfig": {
"access": "public"
Expand Down
20 changes: 10 additions & 10 deletions packages/airbnb/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ another Neutrino preset for building your application source code.

## Project Layout

`@neutrinojs/airbnb` follows the standard [project layout](https://neutrino.js.org/project-layout) specified by Neutrino. This
`@neutrinojs/airbnb` follows the standard [project layout](https://neutrinojs.org/project-layout/) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project.

Expand Down Expand Up @@ -149,7 +149,7 @@ module.exports = {

## Middleware options

This preset uses the same middleware options as [@neutrinojs/eslint](https://neutrino.js.org/packages/eslint).
This preset uses the same middleware options as [@neutrinojs/eslint](https://neutrinojs.org/packages/eslint/).
If you wish to customize what is included, excluded, or any ESLint options, you can provide an options object with the
middleware and this will be merged with our internal defaults for this preset. Use an array pair instead of a string
to supply these options.
Expand All @@ -172,7 +172,7 @@ module.exports = {

## Customizing

To override the build configuration, start with the documentation on [customization](https://neutrino.js.org/customization).
To override the build configuration, start with the documentation on [customization](https://neutrinojs.org/customization/).
`@neutrinojs/airbnb` creates some conventions to make overriding the configuration easier once you are ready to
make changes.

Expand All @@ -192,7 +192,7 @@ middleware.

### Override configuration

By following the [customization guide](https://neutrino.js.org/customization) and knowing the rule and loader IDs above,
By following the [customization guide](https://neutrinojs.org/customization/) and knowing the rule and loader IDs above,
you can also override or augment the build by providing a function to your `.neutrinorc.js` use array. You can also
make this change from the Neutrino API when using the `use` method.

Expand Down Expand Up @@ -241,7 +241,7 @@ If you cannot or do not wish to use Neutrino to execute one-off linting, you can
`@neutrinojs/eslint`, from which this preset inherits, also provides a method for getting the ESLint
configuration suitable for use in an eslintrc file. Typically this is used for providing hints or fix solutions to the
development environment, e.g. IDEs and text editors. Doing this requires
[creating an instance of the Neutrino API](https://neutrino.js.org/api) and providing the middleware it uses. If you keep all
[creating an instance of the Neutrino API](https://neutrinojs.org/api/) and providing the middleware it uses. If you keep all
this information in a `.neutrinorc.js`, this should be relatively straightforward. By providing all the middleware used
to Neutrino, you can ensure all the linting options used across all middleware will be merged together for your
development environment, without the need for copying, duplication, or loss of organization and separation.
Expand Down Expand Up @@ -288,8 +288,8 @@ or fixes.
Projects may face a problem when their editor or IDE lints all files and highlights errors that were normally excluded
from source, i.e. Neutrino's `include` and `exclude` options. This is because the ESLint CLI does not have a way to
specify included and excluded files from configuration. If you still wish to use ESLint's CLI for linting, consider
setting [CLI flags](http://eslint.org/docs/user-guide/command-line-interface#options) or using an
[eslintignore](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to choose which files to
setting [CLI flags](https://eslint.org/docs/user-guide/command-line-interface#options) or using an
[eslintignore](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories) to choose which files to
include or exclude from linting.

Unfortunately ESLint does not provide the possibility to configure ignored paths from Neutrino configuration and exclude them
Expand All @@ -306,14 +306,14 @@ configuration and boilerplate.

ESLint will exclude built files and any files in the root directory (e.g. custom Neutrino configuration) but `src` and
`test` folders will be still checked. `node_modules` are ignored by default in ESLint. More information can be found
in the [ESLint user guide](http://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories).
in the [ESLint user guide](https://eslint.org/docs/user-guide/configuring#ignoring-files-and-directories).

## Contributing

This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets and middleware. Follow the
[contributing guide](https://neutrino.js.org/contributing) for details.
[contributing guide](https://neutrinojs.org/contributing/) for details.

[npm-image]: https://img.shields.io/npm/v/@neutrinojs/airbnb.svg
[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/airbnb.svg
[npm-url]: https://npmjs.org/package/@neutrinojs/airbnb
[npm-url]: https://www.npmjs.com/package/@neutrinojs/airbnb
2 changes: 1 addition & 1 deletion packages/airbnb/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
"author": "Eli Perelman <eli@eliperelman.com>",
"license": "MPL-2.0",
"repository": "https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/airbnb",
"homepage": "https://neutrino.js.org",
"homepage": "https://neutrinojs.org",
"bugs": "https://github.com/mozilla-neutrino/neutrino-dev/issues",
"publishConfig": {
"access": "public"
Expand Down
4 changes: 2 additions & 2 deletions packages/banner/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,8 +95,8 @@ The following is a list of plugins and their identifiers which can be overridden

This middleware is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets and middleware. Follow the
[contributing guide](https://neutrino.js.org/contributing) for details.
[contributing guide](https://neutrinojs.org/contributing/) for details.

[npm-image]: https://img.shields.io/npm/v/@neutrinojs/banner.svg
[npm-downloads]: https://img.shields.io/npm/dt/@neutrinojs/banner.svg
[npm-url]: https://npmjs.org/package/@neutrinojs/banner
[npm-url]: https://www.npmjs.com/package/@neutrinojs/banner
2 changes: 1 addition & 1 deletion packages/banner/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
"author": "Eli Perelman <eli@eliperelman.com>",
"license": "MPL-2.0",
"repository": "https://github.com/mozilla-neutrino/neutrino-dev/tree/master/packages/banner",
"homepage": "https://neutrino.js.org",
"homepage": "https://neutrinojs.org",
"bugs": "https://github.com/mozilla-neutrino/neutrino-dev/issues",
"publishConfig": {
"access": "public"
Expand Down
Loading