diff options
Diffstat (limited to 'nightly/contribution')
5 files changed, 21 insertions, 21 deletions
diff --git a/nightly/contribution/development/build_process/index.html b/nightly/contribution/development/build_process/index.html index f9595072..313a2960 100644 --- a/nightly/contribution/development/build_process/index.html +++ b/nightly/contribution/development/build_process/index.html @@ -1370,14 +1370,14 @@ <p>This section is intended for people who wish to work on/build/distribute bottom, not general users.</p> </div> <h2 id="overview"><a class="toclink" href="#overview">Overview</a></h2> -<p>bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>, called by a wrapper workflow for <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml">nightly</a> and <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml">stable</a> releases. Builds take place via GitHub Actions.</p> +<p>bottom manages its own binary builds for nightly and stable release purposes. The core build workflow is handled by <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a>, called by a wrapper workflow for <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml">nightly</a> and <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml">stable</a> releases. Builds take place via GitHub Actions.</p> <p>The main things built are:</p> <ul> <li>Binaries for various platforms</li> <li>MSI installer for Windows</li> <li><code>.deb</code> package for Debian and its derivatives</li> </ul> -<p>This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> file.</p> +<p>This documentation gives a high-level overview of the build process for each part. For the most up-to-date and detailed reference, definitely refer back to the <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> file.</p> <h2 id="binaries"><a class="toclink" href="#binaries">Binaries</a></h2> <p>Binaries are built currently for various targets. Note that not all of these are officially supported. The following general steps are performed:</p> <ul> diff --git a/nightly/contribution/development/deploy_process/index.html b/nightly/contribution/development/deploy_process/index.html index f7a03fe1..369024e0 100644 --- a/nightly/contribution/development/deploy_process/index.html +++ b/nightly/contribution/development/deploy_process/index.html @@ -1385,9 +1385,9 @@ <h2 id="overview"><a class="toclink" href="#overview">Overview</a></h2> <p>bottom currently has two main deploy processes to worry about:</p> <ul> -<li><a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/nightly.yml">Nightly</a>: a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the <a href="https://github.com/ClementTsang/bottom/releases/tag/nightly">nightly release</a>. It can also be triggered manually as either a proper nightly release or a mock release.</li> +<li><a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/nightly.yml">Nightly</a>: a daily (00:00 UTC) GitHub action to build binary/installer files, and upload them to the <a href="https://github.com/ClementTsang/bottom/releases/tag/nightly">nightly release</a>. It can also be triggered manually as either a proper nightly release or a mock release.</li> <li> -<p><a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/deployment.yml">Stable</a>: a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.</p> +<p><a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/deployment.yml">Stable</a>: a stable deployment, triggered manually or upon creation of a valid tag. This is a GitHub action that builds binary/installer files and uploads them to a new GitHub release.</p> <p>Furthermore, this workflow does not handle the following deployments, which must be manually handled:</p> <ul> <li><a href="https://community.chocolatey.org/packages/bottom">Chocolatey</a></li> diff --git a/nightly/contribution/documentation/index.html b/nightly/contribution/documentation/index.html index 0df7643c..4e78cfc5 100644 --- a/nightly/contribution/documentation/index.html +++ b/nightly/contribution/documentation/index.html @@ -1363,10 +1363,10 @@ <h2 id="what-pages-need-documentation"><a class="toclink" href="#what-pages-need-documentation">What pages need documentation?</a></h2> <p>There are a few areas where documentation changes are often needed:</p> <ul> -<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a></li> -<li>The help menu inside of the application (located <a href="https://github.com/ClementTsang/bottom/blob/master/src/constants.rs">here</a>)</li> +<li>The <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a></li> +<li>The help menu inside of the application (located <a href="https://github.com/ClementTsang/bottom/blob/main/src/constants.rs">here</a>)</li> <li>The <a href="https://clementtsang.github.io/bottom/nightly/">extended documentation</a> (here)</li> -<li>The <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a></li> +<li>The <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a></li> </ul> <h2 id="how-should-i-addupdate-documentation"><a class="toclink" href="#how-should-i-addupdate-documentation">How should I add/update documentation?</a></h2> <ol> @@ -1377,17 +1377,17 @@ <p>Where you're adding documentation will probably affect what you need to do:</p> <h3><code>README.md</code> or <code>CHANGELOG.md</code></h3> -<p>For changes to <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a> and <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a>, just follow the formatting provided and use any editor.</p> -<p>Generally, changes to <a href="https://github.com/ClementTsang/bottom/blob/master/CHANGELOG.md"><code>CHANGELOG.md</code></a> will be handled - by a maintainer, and changes should follow the <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a> format, as - well as link to the relevant PR or issue.</p> +<p>For changes to <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a> and <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a>, just follow the formatting provided and use any editor.</p> +<p>Generally, changes to <a href="https://github.com/ClementTsang/bottom/blob/main/CHANGELOG.md"><code>CHANGELOG.md</code></a> will be handled + by a maintainer, and the contents of the file should follow the <a href="https://keepachangelog.com/en/1.0.0/">Keep a Changelog</a> + format, as well as link to the relevant PR or issues.</p> <h3>Help menu</h3> -<p>For changes to the help menu, try to refer to the existing code within <a href="https://github.com/ClementTsang/bottom/blob/master/src/constants.rs"><code>src/constants.rs</code></a> on how the help menu is generated.</p> +<p>For changes to the help menu, try to refer to the existing code within <a href="https://github.com/ClementTsang/bottom/blob/main/src/constants.rs"><code>src/constants.rs</code></a> on how the help menu is generated.</p> <h3>Extended documentation</h3> -<p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older versions should be fine - though), <a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>, +<p>For changes to the extended documentation, you'll probably want at least Python 3.11 (older and newer versions + should be fine), <a href="https://www.mkdocs.org/">MkDocs</a>, <a href="https://squidfunk.github.io/mkdocs-material/">Material for MkDocs</a>, <code>mdx_truly_sane_lists</code>, and optionally <a href="https://github.com/jimporter/mike">Mike</a> installed. These can help with validating your changes locally.</p> <p>You can do so through <code>pip</code> or your system's package managers. If you use <code>pip</code>, you can use venv to cleanly install diff --git a/nightly/contribution/issues-and-pull-requests/index.html b/nightly/contribution/issues-and-pull-requests/index.html index 65f5340c..61a3fa68 100644 --- a/nightly/contribution/issues-and-pull-requests/index.html +++ b/nightly/contribution/issues-and-pull-requests/index.html @@ -1392,7 +1392,7 @@ <li>Fork the project.</li> <li>Make your changes.</li> <li>Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See <a href="../documentation/">here</a> for tips on documentation.</li> -<li>Commit and create a pull request to merge into the <code>master</code> branch. <strong>Please fill out the pull request template</strong>.</li> +<li>Commit and create a pull request to merge into the <code>main</code> branch. <strong>Please fill out the pull request template</strong>.</li> <li>Ask a maintainer to review your pull request.<ul> <li>Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first-time contributor, you may need to wait for a maintainer to let CI run.</li> diff --git a/nightly/contribution/packaging-and-distribution/index.html b/nightly/contribution/packaging-and-distribution/index.html index 6c3efebd..7b5824ce 100644 --- a/nightly/contribution/packaging-and-distribution/index.html +++ b/nightly/contribution/packaging-and-distribution/index.html @@ -1375,9 +1375,9 @@ find pre-built binaries in either a <code>tar.gz</code> or <code>zip</code> form completion files for zsh, bash, fish, and Powershell, which you may want to also install during the packaging process.</p> <p>You can also find a nightly build in the <a href="https://github.com/ClementTsang/bottom/releases">releases page</a>, built every -day at 00:00 UTC off of the master branch.</p> +day at 00:00 UTC off of the <code>main</code> branch.</p> <p>In both cases, we use a combination of GitHub Actions and CirrusCI (mainly for FreeBSD and macOS M1) to create our -release binaries. <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> +release binaries. <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml"><code>build_releases.yml</code></a> contains the GitHub Action workflow used to do both of these, if reference is needed.</p> <h2 id="building-manually"><a class="toclink" href="#building-manually">Building manually</a></h2> <p>If you want to manually build bottom rather than distributing a pre-built binary, you'll need the most recent version @@ -1388,7 +1388,7 @@ of stable Rust, which you can get with:</p> <div class="highlight"><pre><span></span><code>cargo<span class="w"> </span>build<span class="w"> </span>--release<span class="w"> </span>--locked </code></pre></div> <h3 id="manpage-and-completion-generation"><a class="toclink" href="#manpage-and-completion-generation">Manpage and completion generation</a></h3> -<p>bottom uses a <a href="https://github.com/ClementTsang/bottom/blob/master/build.rs"><code>build.rs</code></a> script to automatically generate +<p>bottom uses a <a href="https://github.com/ClementTsang/bottom/blob/main/build.rs"><code>build.rs</code></a> script to automatically generate a manpage and shell completions for the following shells:</p> <ul> <li>Bash</li> @@ -1404,11 +1404,11 @@ example, run something like this:</p> <p>This will automatically generate completion and manpage files in <code>target/tmp/bottom/</code>. If you wish to regenerate the files, modify/delete either these files or set <code>BTM_GENERATE</code> to some other non-empty value to retrigger the build script.</p> -<p>For more information, you may want to look at either the <a href="https://github.com/ClementTsang/bottom/blob/master/build.rs"><code>build.rs</code></a> -file or the <a href="https://github.com/ClementTsang/bottom/blob/master/.github/workflows/build_releases.yml">binary build CI workflow</a>.</p> +<p>For more information, you may want to look at either the <a href="https://github.com/ClementTsang/bottom/blob/main/build.rs"><code>build.rs</code></a> +file or the <a href="https://github.com/ClementTsang/bottom/blob/main/.github/workflows/build_releases.yml">binary build CI workflow</a>.</p> <h2 id="adding-an-installation-source"><a class="toclink" href="#adding-an-installation-source">Adding an installation source</a></h2> <p>Once you've finished your installation source, if you want to mention it in the main bottom repo, fork the repo and add -the installation method and any details to the <a href="https://github.com/ClementTsang/bottom/blob/master/README.md"><code>README.md</code></a> +the installation method and any details to the <a href="https://github.com/ClementTsang/bottom/blob/main/README.md"><code>README.md</code></a> file under the <a href="https://github.com/ClementTsang/bottom#installation">Installation</a> section, as well as a corresponding table of contents entry. Once that's done, open a pull request - these will usually be approved of very quickly.</p> <p>You can find more info on the contribution process <a href="../issues-and-pull-requests/#pull-requests">here</a>.</p> |