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

Move http:// to https:// for (mostly) external references #77

Merged
merged 3 commits into from
May 26, 2021
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.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

[![Netlify Status](https://api.netlify.com/api/v1/badges/7f9a24ea-990d-40de-88c5-a4c64d90c155/deploy-status)](https://app.netlify.com/sites/rebar3/deploys)

[Hugo](https://gohugo.io/) site for [Rebar3](rebar3.org) documentation.
[Hugo](https://gohugo.io/) site for [Rebar3](https://rebar3.org) documentation.

### Initial Setup

Expand Down
2 changes: 1 addition & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ footer_about_disable = false
# End user relevant links. These will show up on left side of footer and in the community page if you have one.
[[params.links.user]]
name = "User mailing list"
url = "http://lists.basho.com/mailman/listinfo/rebar_lists.basho.com"
url = "https://lists.basho.com/mailman/listinfo/rebar_lists.basho.com"
icon = "fa fa-envelope"
desc = "Discussion and help from your fellow users"
[[params.links.user]]
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/about/about-us.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ excerpt: ""
## Community

- [Issue Tracker](https://github.com/erlang/rebar3/issues)
- [Mailing List](http://lists.basho.com/mailman/listinfo/rebar_lists.basho.com)
- [Mailing List](https://lists.basho.com/mailman/listinfo/rebar_lists.basho.com)
- Slack: #rebar3 on [Erlang Slack](https://erlef.org/slack-invite/erlanger)
- IRC: #rebar on freenode
- [Contribution guidelines](https://github.com/erlang/rebar3/blob/master/CONTRIBUTING.md)
Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/about/security-policy.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ If you have not received a reply to your query within 48 hours, or have not hear
- Open a GitHub issue directly
- Ask on #rebar3 on the [official Erlang Slack team](https://erlef.org/slack-invite/erlanger)
- Ask on #rebar on IRC on freenode
- Ask on the [rebar mailing list](http://lists.basho.com/mailman/listinfo/rebar_lists.basho.com)
- Ask on the [rebar mailing list](https://lists.basho.com/mailman/listinfo/rebar_lists.basho.com)

Please note that the GitHub issues, mailing list, and chat channels are public areas. When escalating in these venues, please do not discuss details of your issue. Simply say that you’re trying to get a hold of someone from the maintainer team.

Expand Down
22 changes: 11 additions & 11 deletions content/en/docs/commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,15 +35,15 @@ The `clean` command by default removes the BEAM files for top-level applications

Runs common tests for the project located under the `test/` directory.

Most Common Test [options](http://www.erlang.org/doc/man/ct_run.html) as described in the Erlang documentation for `ct_run` are available. Some common ones are described below:
Most Common Test [options](https://www.erlang.org/doc/man/ct_run.html) as described in the Erlang documentation for `ct_run` are available. Some common ones are described below:

| Option | Type | Description |
| ----------------------------- | -------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| `--dir` | Comma separated list of strings | Compile and run all test suites in the specified directories. |
| `--suite` | Comma separated list of strings | Compile and run all test suites specified. Must be specified by full path, either absolute or relative to the current directory. |
| `--group` | Comma separated list of strings | Test groups to run. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html) |
| `--case` | Comma separated list of strings | List of test cases to run. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html) |
| `--spec` | Comma separated list of strings | List of [Test Specifications](http://erlang.org/doc/apps/common_test/run_test_chapter.html#test_specifications) |
| `--group` | Comma separated list of strings | Test groups to run. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html) |
| `--case` | Comma separated list of strings | List of test cases to run. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html) |
| `--spec` | Comma separated list of strings | List of [Test Specifications](https://erlang.org/doc/apps/common_test/run_test_chapter.html#test_specifications) |
| `--join_specs` | Comma separated list of strings | Like `--spec` but merges all the specifications into one and does a single run. |
| `--repeat` | Integer | How often to repeat the tests |
| `--duration` | String (format: HHMMSS) | Max allowed duration of the test run |
Expand All @@ -53,12 +53,12 @@ Most Common Test [options](http://www.erlang.org/doc/man/ct_run.html) as describ
| `--scale_timetraps` | Boolean | Enables automatic timeout value scaling, when using code coverage or tracing |
| `--abort_if_missing_suites` | Boolean | Abort the test run if a test suite is missing (Default: true) |
| `--sys_config` | String | List of OTP application config files (like `sys.config`) that should be applied by Rebar3 before the test run. |
| `--config` | Comma separated list of strings | Config files to use when running tests. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html) |
| `--allow_user_terms` | Boolean | Allow user defined config values in config files. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html) |
| `--config` | Comma separated list of strings | Config files to use when running tests. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html |
| `--allow_user_terms` | Boolean | Allow user defined config values in config files. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html) |
| `--decrypt_key` | String | If the configuration file is encrypted, set the key to decrypt it |
| `--decrypt_file` | String | If the configuration file is encrypted, point to the file containing the key to decrypt it |
| `--logdir` | String | The directory in which test logs will be written. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html)<br>Default: `_build/test/logs` |
| `--logopts` | Comma separated list of strings | Set common test logging options. See the [Common Test Documentation.](http://erlang.org/doc/apps/common_test/index.html)<br>Default: `_build/test/logs` |
| `--logdir` | String | The directory in which test logs will be written. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html)<br>Default: `_build/test/logs` |
| `--logopts` | Comma separated list of strings | Set common test logging options. See the [Common Test Documentation.](https://erlang.org/doc/apps/common_test/index.html)<br>Default: `_build/test/logs` |
| `--readable` | Boolean | Adds test names with results on a per-test basis, and only displays common-test logs in the terminal on failing tests.<br>Default: `true` |
| `--verbose`, `-v` | Boolean | Enable verbose output. Default: false |
| `--verbosity` | Integer | Set the level of Common Test verbosity |
Expand Down Expand Up @@ -106,7 +106,7 @@ Builds and keeps up-to-date a suitable PLT (Persistent Lookup Table), and uses i
| `--update-plt`, `-u` | boolean | Enable updating the PLT. | true |
| `--succ-typings`, `-s` | boolean | Enable success typing analysis. | true |

For instructions on suppressing warnings read the [Requesting or Suppressing Warnings in Source Files](http://erlang.org/doc/man/dialyzer.html) section of the Dialyzer documentation.
For instructions on suppressing warnings read the [Requesting or Suppressing Warnings in Source Files](https://erlang.org/doc/man/dialyzer.html) section of the Dialyzer documentation.

PLT files are named `<prefix>_<otp_release>_plt`; The base PLT is a PLT containing the core applications often required for a project's PLT. One base PLT is created per OTP version and stored in `base_plt_location`. A base PLT is then used to build project PLTs.

Expand All @@ -132,7 +132,7 @@ Runs in the `docs` profile.

## escriptize

Generates an [escript](http://www.erlang.org/doc/man/escript.html) executable containing the project's and its dependencies' BEAM files.
Generates an [escript](https://www.erlang.org/doc/man/escript.html) executable containing the project's and its dependencies' BEAM files.

| Config Option | Type | Description |
| ------------------- | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
Expand Down Expand Up @@ -226,7 +226,7 @@ Runs a shell with project apps and deps in path. Intended for development use on

| Option | Type | Description |
| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------- |
| `--config` | string | Allows to load a [config file](http://www.erlang.org/doc/man/config.html), if any. Defaults to the sys_config entry defined for relx if present. |
| `--config` | string | Allows to load a [config file](https://www.erlang.org/doc/man/config.html), if any. Defaults to the sys_config entry defined for relx if present. |
| `--name`, `--sname` | atom | Starts the node in network mode. Equivalent to erl's `-name` and `-sname` options. |
| `--setcookie` | string | Sets the cookie for a distributed node. Equivalent to erl's `-setcookie` option |
| `--script` | string | path to an escript to be evaluated before applications are started |
Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/configuration/config_script.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@ excerpt: ""
weight: 10
---

With `rebar.config` and `*.app.src` you can make use of dynamic configuration based on [file:script/2](http://www.erlang.org/doc/man/file.html#script-2).
With `rebar.config` and `*.app.src` you can make use of dynamic configuration based on [file:script/2](https://www.erlang.org/doc/man/file.html#script-2).

If a `<name>.script` exists in the same directory as the original file (in the case of `rebar.config` that would be `rebar.config.script`), the script file will be evaluated and the result used as configuration.

For convenience two bindings (variables) are available in a script during evaluation:

- `CONFIG` - the result of [file:consult/1](http://www.erlang.org/doc/man/file.html#consult-1) if the script file being evaluated also exists
- `CONFIG` - the result of [file:consult/1](https://www.erlang.org/doc/man/file.html#consult-1) if the script file being evaluated also exists

without the ``.script`` extension. Otherwise, `[]`.

Expand Down
18 changes: 9 additions & 9 deletions content/en/docs/configuration/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -92,7 +92,7 @@ The artifact is define on the application `eleveldb` so it is relative to the ou

## Compilation

Compiler options can be set with `erl_opts`, available options are listed in the Erlang compile module's [documentation](http://www.erlang.org/doc/man/compile.html).
Compiler options can be set with `erl_opts`, available options are listed in the Erlang compile module's [documentation](https://www.erlang.org/doc/man/compile.html).

```erlang
{erl_opts, []}.
Expand Down Expand Up @@ -134,9 +134,9 @@ And some other general options exist:

Other Erlang-related compilers are supported with their own configuration options:

- [Leex compiler](http://erlang.org/doc/man/leex.html) with `{xrl_opts, [...]}`
- [SNMP MIB Compiler](http://www.erlang.org/doc/apps/snmp/snmp_mib_compiler.html) with `{mib_opts, [...]}`
- [Yecc compiler](http://erlang.org/doc/man/yecc.html) with `{yrl_opts, [...]}`
- [Leex compiler](https://erlang.org/doc/man/leex.html) with `{xrl_opts, [...]}`
- [SNMP MIB Compiler](https://www.erlang.org/doc/apps/snmp/snmp_mib_compiler.html) with `{mib_opts, [...]}`
- [Yecc compiler](https://erlang.org/doc/man/yecc.html) with `{yrl_opts, [...]}`

### Rebar3 compiler options

Expand Down Expand Up @@ -197,7 +197,7 @@ Disable recursive compiling on test and other dirs:
{ct_readable, true | false}. % disable Rebar3 modifying CT output in the shell
```

Reference of common test options for `ct_opts`: [http://www.erlang.org/doc/man/ct.html#run_test-1](http://www.erlang.org/doc/man/ct.html#run_test-1)
Reference of common test options for `ct_opts`: [https://www.erlang.org/doc/man/ct.html#run_test-1](https://www.erlang.org/doc/man/ct.html#run_test-1)

A special option allows to load a default `sys.config` set of entries using `{ct_opts, [{sys_config, ["name.of.config"]}]}`

Expand All @@ -223,7 +223,7 @@ Enable code coverage in [tests](/docs/running-tests) with `{cover_enabled, true}
{base_plt_prefix, string()}]}.
```

For information on suppressing warnings in modules see the [Requesting or Suppressing Warnings in Source Files](http://erlang.org/doc/man/dialyzer.html) section of the Dialyzer documentation.
For information on suppressing warnings in modules see the [Requesting or Suppressing Warnings in Source Files](https://erlang.org/doc/man/dialyzer.html) section of the Dialyzer documentation.

## Distribution

Expand Down Expand Up @@ -268,11 +268,11 @@ Furthermore, Rebar3 stores some of its configuration data in `~/.config/rebar3`

## EDoc

All options supported by [EDoc](http://www.erlang.org/doc/man/edoc.html#run-3) can be put in `{edoc_opts, [...]}`.
All options supported by [EDoc](https://www.erlang.org/doc/man/edoc.html#run-3) can be put in `{edoc_opts, [...]}`.

## Escript

Full details at the [escriptize command](http://www.rebar3.org/docs/commands#escriptize). Example configuration values below.
Full details at the [escriptize command](/docs/commands#escriptize). Example configuration values below.

```erlang
{escript_main_app, AppName}. % specify which app is the escript app
Expand All @@ -293,7 +293,7 @@ Because of the structure of escript building, options at the top-level `rebar.co
{eunit_tests, [...]}. % same as Tests argument in eunit:test(Tests, ...)
```

Eunit Options reference: [http://www.erlang.org/doc/man/eunit.html#test-2](http://www.erlang.org/doc/man/eunit.html#test-2)
Eunit Options reference: [https://www.erlang.org/doc/man/eunit.html#test-2](https://www.erlang.org/doc/man/eunit.html#test-2)

## Hex Repos and Indexes

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/configuration/dependencies.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Dependencies will always be compiled with the `prod` profile applied to their co

## Dependency Version Handling

Rebar3 considers dependency versions to be informational only. Given the existing open source landscape in the Erlang community when Rebar3 was added, trying to impose [semantic versioning](http://semver.org/) or any other similar scheme was considered unpractical:
Rebar3 considers dependency versions to be informational only. Given the existing open source landscape in the Erlang community when Rebar3 was added, trying to impose [semantic versioning](https://semver.org/) or any other similar scheme was considered unpractical:

- People update *some* versions but not all of them (Git tags vs. branch names vs. OTP application versions) and they may contradict each other;
- Some people never update their versions and publish many times under them;
Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/configuration/plugins.md
Original file line number Diff line number Diff line change
Expand Up @@ -185,7 +185,7 @@ Configuration variables available:

### Alias

The alias plugin has been added to Rebar3 starting with version 3.5.0. See <http://rebar3.org/v3/docs/configuration#section-alias> for instructions.
The alias plugin has been added to Rebar3 starting with version 3.5.0. See </docs/workflow/#create-aliases-for-common-tasks> for instructions.

For prior versions, the plugin for aliasing a single command to run multiple tasks can be found at [GitHub](https://github.com/tsloughter/rebar_alias) and [Hex.pm](https://hex.pm/packages/rebar_alias).

Expand All @@ -199,7 +199,7 @@ Arguments (as with a command line) can be passed by replacing `Provider` with `{

### QuickCheck

A Rebar3 plugin to enable the execution of [Erlang QuickCheck](http://www.quviq.com/products/erlang-quickcheck/) properties. Found on [GitHub](https://github.com/kellymclaughlin/rebar3-eqc-plugin) and [Hex.pm](https://hex.pm/packages/rebar3_eqc).
A Rebar3 plugin to enable the execution of [Erlang QuickCheck](https://www.quviq.com/products/erlang-quickcheck/) properties. Found on [GitHub](https://github.com/kellymclaughlin/rebar3-eqc-plugin) and [Hex.pm](https://hex.pm/packages/rebar3_eqc).

```erlang
{plugins, [rebar3_eqc]}.
Expand All @@ -222,7 +222,7 @@ Similarly configuration can be passed on the command line:

### PropEr

[PropEr](http://proper.softlab.ntua.gr/) is a free alternative to Quviq QuickCheck. The plugin is available [on Hex as a package](https://hex.pm/packages/rebar3_proper) or [GitHub](https://github.com/ferd/rebar3_proper/)
[PropEr](https://proper.softlab.ntua.gr/) is a free alternative to Quviq QuickCheck. The plugin is available [on Hex as a package](https://hex.pm/packages/rebar3_proper) or [GitHub](https://github.com/ferd/rebar3_proper/)

```erlang
%% the plugin itself
Expand Down
Loading