From 30dac07817e1655eca1b1d2cf5a9cfc34e6994d7 Mon Sep 17 00:00:00 2001 From: dy3l Date: Thu, 24 Jun 2021 22:42:02 +0100 Subject: [PATCH] Fix case style --- README.md | 6 +++--- bootstrap.sh | 2 +- docs/community/plugins.md | 2 +- .../deployment/continuous-integration/gitlab-ci.md | 4 ++-- docs/deployment/methods/git.md | 4 ++-- docs/development/release-process.md | 14 +++++++------- docs/development/testing.md | 2 +- docs/getting-started/upgrading.md | 2 +- docs/getting-started/where-to-get-help.md | 2 +- docs/template.html | 2 +- tests/unit/client.bats | 2 +- 11 files changed, 21 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index 00eba90d4..824242551 100644 --- a/README.md +++ b/README.md @@ -14,7 +14,7 @@ Docker powered mini-Heroku. The smallest PaaS implementation you've ever seen. ## Sponsors -Become a sponsor and get your logo on our README on Github with a link to your site. [[Become a sponsor](https://opencollective.com/dokku#sponsor)] +Become a sponsor and get your logo on our README on GitHub with a link to your site. [[Become a sponsor](https://opencollective.com/dokku#sponsor)] @@ -117,11 +117,11 @@ Full documentation - including advanced installation docs - are available online ## Support -You can use [Github Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](https://dokku.com/docs/getting-started/troubleshooting/) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku). +You can use [GitHub Issues](https://github.com/dokku/dokku/issues), check [Troubleshooting](https://dokku.com/docs/getting-started/troubleshooting/) in the documentation, or join us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku). ## Contribution -After checking [Github Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](https://dokku.com/docs/getting-started/troubleshooting/) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request. +After checking [GitHub Issues](https://github.com/dokku/dokku/issues), the [Troubleshooting Guide](https://dokku.com/docs/getting-started/troubleshooting/) or having a chat with us on [freenode in #dokku](https://webchat.freenode.net/?channels=%23dokku), feel free to fork and create a Pull Request. While we may not merge your PR as is, they serve to start conversations and improve the general Dokku experience for all users. diff --git a/bootstrap.sh b/bootstrap.sh index 0842535a6..874d41547 100755 --- a/bootstrap.sh +++ b/bootstrap.sh @@ -5,7 +5,7 @@ set -eo pipefail # A script to bootstrap dokku. # It expects to be run on Ubuntu 18.04/20.04, or CentOS 7 via 'sudo' # If installing a tag higher than 0.3.13, it may install dokku via a package (so long as the package is higher than 0.3.13) -# It checks out the dokku source code from Github into ~/dokku and then runs 'make install' from dokku source. +# It checks out the dokku source code from GitHub into ~/dokku and then runs 'make install' from dokku source. # We wrap this whole script in functions, so that we won't execute # until the entire script is downloaded. diff --git a/docs/community/plugins.md b/docs/community/plugins.md index 0682e5d56..9d8730959 100644 --- a/docs/community/plugins.md +++ b/docs/community/plugins.md @@ -212,7 +212,7 @@ The following plugins are available and provided by Dokku maintainers. Please f 3 Adds the ability to add custom hosts to the containers known_hosts file to be able to ssh them easily (useful with deployment keys) -4 Adds the ability to sync an application repo with a remote Github repo (useful for automated rebuilds without needing a git push from an external system +4 Adds the ability to sync an application repo with a remote GitHub repo (useful for automated rebuilds without needing a git push from an external system 5 Adds the ability to invoke a post-deploy webhook with the IP, port and app name, all with a single config:set). diff --git a/docs/deployment/continuous-integration/gitlab-ci.md b/docs/deployment/continuous-integration/gitlab-ci.md index 29b8c917e..5a782855d 100644 --- a/docs/deployment/continuous-integration/gitlab-ci.md +++ b/docs/deployment/continuous-integration/gitlab-ci.md @@ -1,6 +1,6 @@ -# Gitlab CI +# GitLab CI -Gitlab-CI can be used to automatically deploy a Dokku application via the official the [dokku/ci-docker-image](https://github.com/dokku/ci-docker-image). The simplest example is as follows: +GitLab CI can be used to automatically deploy a Dokku application via the official the [dokku/ci-docker-image](https://github.com/dokku/ci-docker-image). The simplest example is as follows: ``` --- diff --git a/docs/deployment/methods/git.md b/docs/deployment/methods/git.md index 385d2e332..bac2cbc6e 100644 --- a/docs/deployment/methods/git.md +++ b/docs/deployment/methods/git.md @@ -155,7 +155,7 @@ See the [dockerfile documentation](/docs/deployment/builders/dockerfiles.md) to > New as of 0.24.0 -A Dokku app repository can be initialized or updated from the contents of an archive file via the `git:from-archive` command. This is an excellent way of tracking changes when deploying pre-built binary archives, such as java jars or go binaries. This can also be useful when deploying directly from a Github repository at a specific commit. +A Dokku app repository can be initialized or updated from the contents of an archive file via the `git:from-archive` command. This is an excellent way of tracking changes when deploying pre-built binary archives, such as java jars or go binaries. This can also be useful when deploying directly from a GitHub repository at a specific commit. ```shell dokku git:from-archive node-js-app https://github.com/dokku/smoke-test-app/releases/download/2.0.0/smoke-test-app.tar @@ -233,7 +233,7 @@ dokku git:auth github.com username personal-access-token dokku git:auth github.com ``` -For syncing to a private repository stored on a remote Git product such as Github or Gitlab, Dokku's recommendation is to use a personal access token on a bot user where possible. Please see your service's documentation for information regarding the recommended best practices. +For syncing to a private repository stored on a remote Git product such as GitHub or GitLab, Dokku's recommendation is to use a personal access token on a bot user where possible. Please see your service's documentation for information regarding the recommended best practices. ### Allowing remote repository hosts diff --git a/docs/development/release-process.md b/docs/development/release-process.md index 546385726..6263ebf31 100644 --- a/docs/development/release-process.md +++ b/docs/development/release-process.md @@ -12,7 +12,7 @@ contrib/release-dokku > If you are a maintainer and need the PACKAGECLOUD_TOKEN in order to make a release, please contact @josegonzalez to get this information. -As well, the ArchLinux package description *must* be updated via `vagrant up build-arch` (needs to be done after the tag is pushed to GitHub, because it is based on that) +As well, the Arch Linux package description *must* be updated via `vagrant up build-arch` (needs to be done after the tag is pushed to GitHub, because it is based on that) ## Versioning @@ -20,9 +20,9 @@ Dokku follows semver standards. As we are not yet at a stable release, breaking At the moment, tags need not be signed, though that may change in the future. -## ArchLinux Packages +## Arch Linux Packages -ArchLinux packages are not really build, because all that is needed for an Arch User Repo (AUR) package is the description of how to build the package. To make this process as easy as possible there is a vagrant box called `build-arch` that updates the version of this build description (a file called `PKGBUILD`), then runs some helper scripts to fill all additional information and does test if the package could be build. Then only those changes need to be pushed to the AUR repo and an updated version of the package is ready for usage for our ArchLinux users. For detailed information see the section below. +Arch Linux packages are not really build, because all that is needed for an Arch User Repo (AUR) package is the description of how to build the package. To make this process as easy as possible there is a vagrant box called `build-arch` that updates the version of this build description (a file called `PKGBUILD`), then runs some helper scripts to fill all additional information and does test if the package could be build. Then only those changes need to be pushed to the AUR repo and an updated version of the package is ready for usage for our Arch Linux users. For detailed information see the section below. The workflow looks like this: @@ -38,17 +38,17 @@ git push aur master > If you are a maintainer and need access to the AUR repositories in order to make a release, please contact @morrisjobke or @josegonzalez to get this co-maintainership. -### Detailed information for ArchLinux packages +### Detailed information for Arch Linux packages -All of the information to build the ArchLinux package is in the AUR git repository (see [dokku AUR page](https://aur.archlinux.org/packages/dokku/)). The release of a AUR package only consists of pushing the package information into the AUR git repo. Then users could use that information to build the package on their machines. +All of the information to build the Arch Linux package is in the AUR git repository (see [dokku AUR page](https://aur.archlinux.org/packages/dokku/)). The release of a AUR package only consists of pushing the package information into the AUR git repo. Then users could use that information to build the package on their machines. To update the package clone the repository and adjust the files in the repository. Then a helper script - `updpkgsums` - to update the SHA sum could be called (check against the original SHA sum). Another helper script - `mksrcinfo` - needs to be called to update the meta information of the package in a file called `.SRCINFO`. The next step builds the package locally for verification - `makepkg`. As last step commit your changes and push the commit. * dependencies are defined in the `depends` attribute in `PKGBUILD` * build steps during package build time are defined in the `package()` method in `PKGBUILD` * steps that should be executed during install/update/remove time are defined in the file `dokku.install` -* detailed information about all attributes in `PKGBUILD` could be found in the [ArchLinux wiki](https://wiki.archlinux.org/index.php/PKGBUILD) -* detailed information about the AUR workflow could be found in the [AUR article](https://wiki.archlinux.org/index.php/Arch_User_Repository) in the ArchLinux wiki +* detailed information about all attributes in `PKGBUILD` could be found in the [Arch Linux wiki](https://wiki.archlinux.org/index.php/PKGBUILD) +* detailed information about the AUR workflow could be found in the [AUR article](https://wiki.archlinux.org/index.php/Arch_User_Repository) in the Arch Linux wiki That is the usual workflow: diff --git a/docs/development/testing.md b/docs/development/testing.md index e146260e5..fc32963a0 100644 --- a/docs/development/testing.md +++ b/docs/development/testing.md @@ -9,7 +9,7 @@ We maintain the Dokku test harness within the `tests` directory: ## Continuous Integration -All pull requests have tests run against them on [Github Actions](https://github.com/features/actions), a continuous integration platform that provides Docker support for Ubuntu Trusty 18.04. +All pull requests have tests run against them on [GitHub Actions](https://github.com/features/actions), a continuous integration platform that provides Docker support for Ubuntu Trusty 18.04. If you wish to skip tests for a particular commit, e.g. documentation changes, you may add the `[ci skip]` designator to your commit message. Commits that _should_ be tested but have the above designator will not be merged. diff --git a/docs/getting-started/upgrading.md b/docs/getting-started/upgrading.md index 69c3775b9..460a56add 100644 --- a/docs/getting-started/upgrading.md +++ b/docs/getting-started/upgrading.md @@ -9,7 +9,7 @@ For any security related updates, please follow our [Twitter account](https://tw Your operating system may occasionally provide security updates. We recommend setting unattended upgrades for your operating system. Here are some helpful links: - [Arch Linux System Maintenance](https://wiki.archlinux.org/index.php/System_maintenance) -- [Centos Automatic Security Updates](https://serversforhackers.com/c/automatic-security-updates-centos) +- [CentOS Automatic Security Updates](https://serversforhackers.com/c/automatic-security-updates-centos) - [Debian Unattended Upgrades](https://wiki.debian.org/UnattendedUpgrades) - [Ubuntu Unattended Upgrades](https://help.ubuntu.com/community/AutomaticSecurityUpdates) diff --git a/docs/getting-started/where-to-get-help.md b/docs/getting-started/where-to-get-help.md index cd5b11857..c3c610b44 100644 --- a/docs/getting-started/where-to-get-help.md +++ b/docs/getting-started/where-to-get-help.md @@ -14,7 +14,7 @@ The [Code Of Conduct](https://github.com/dokku/.github/blob/master/CODE_OF_CONDU ### Forums -- [Github Discussions](https://github.com/dokku/dokku/discussions) +- [GitHub Discussions](https://github.com/dokku/dokku/discussions) GitHub Discussions is a new way for the Dokku community to interact with each other! This is a place to ask questions to the community or discuss potential feature requests before filing issues. diff --git a/docs/template.html b/docs/template.html index de412f0d0..067144620 100644 --- a/docs/template.html +++ b/docs/template.html @@ -172,7 +172,7 @@ Release Process Continuous Integration - Github Actions + GitHub Actions Gitlab CI Generic diff --git a/tests/unit/client.bats b/tests/unit/client.bats index fbbf8010e..965cda8b9 100644 --- a/tests/unit/client.bats +++ b/tests/unit/client.bats @@ -23,7 +23,7 @@ teardown() { } @test "(client) no args should print help" { - # dokku container is not run with a TTY on Github Actions so we don't get normal output + # dokku container is not run with a TTY on GitHub Actions so we don't get normal output # https://github.com/actions/runner/issues/241 run /bin/bash -c "${BATS_TEST_DIRNAME}/../../contrib/dokku_client.sh" echo "output: $output"