diff --git a/README.md b/README.md index d2013a56..d4a128b6 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,4 @@ -# Renuo Applications Setup Guide +# Renuo Application Setup Guide This repo is the [Renuo](https://www.renuo.ch) collection of best-practices to set-up apps. We are a [Rails company](https://rubyonrails.org/foundation), so the most value probably diff --git a/gitflow.md b/gitflow.md index 61fcad13..fd1b810e 100644 --- a/gitflow.md +++ b/gitflow.md @@ -8,7 +8,7 @@ Since we follow gitflow, we have two main branches connected, via CD, to two ser ```mermaid graph LR -A[master] --> CI1(CI) --> CD1(CD) +A[main] --> CI1(CI) --> CD1(CD) CD1(CD) --> S11(server) CD1(CD) --> S12(server) @@ -28,7 +28,7 @@ sequenceDiagram rect rgb(191, 223, 255) - Developer->>G: git push origin develop or master + Developer->>G: git push origin develop or main G->>CI: notify about code change CI->>G: checkout code CI->>CI: run tests diff --git a/go_live.md b/go_live.md index 95209277..182eb33a 100644 --- a/go_live.md +++ b/go_live.md @@ -35,7 +35,7 @@ When preparing your app for production on Deploio, ensure the following: * Confirm the configured application size in the application configuration tab. * Ensure the application replica count is correctly set in the application configuration tab. -For detailed instructions and best practices, including quick start guides for a variety of frameworks, please refer to the [Deploio deployment documentation](https://docs.deploio.com/user-guide/network-and-deployment.html#network-deployment). +For detailed instructions and best practices, including quick start guides for a variety of frameworks, please refer to the [Deploio deployment documentation](https://guides.deplo.io/user-guide/network-and-deployment.html#network-deployment). ## Heroku diff --git a/ruby_on_rails/app_initialisation.md b/ruby_on_rails/app_initialisation.md index db4d304e..2194d30d 100644 --- a/ruby_on_rails/app_initialisation.md +++ b/ruby_on_rails/app_initialisation.md @@ -15,7 +15,7 @@ You can do this with `gem update rails`. Beware of beta versions. * Start a new Rails project using ``` -rails new [project-name] --database=postgresql --skip-kamal --skip-ci --skip-action-mailbox --template https://raw.githubusercontent.com/renuo/applications-setup-guide/main/ruby_on_rails/template.rb +rails new [project-name] --database=postgresql --skip-kamal --skip-ci --skip-action-mailbox --template https://raw.githubusercontent.com/renuo/application-setup-guide/main/ruby_on_rails/template.rb ``` where the `project-name` is exactly the one you chose before. @@ -145,7 +145,7 @@ Check existing projects for an example of the usage. end ``` -* The default [Content Security Policies](https://github.com/renuo/applications-setup-guide/blob/master/ruby_on_rails/content_security_policy.md) should not always be activated, but rather only where there are platform secrets that need to be secured. This rule can be overwritten by a customer, if he opted into CSP when selecting his maintenance plans. +* The default [Content Security Policies](./content_security_policy.md) should not always be activated, but rather only where there are platform secrets that need to be secured. This rule can be overwritten by a customer, if he opted into CSP when selecting his maintenance plans. * If you're using a js-bundling tool, let's clean up after asset precompilation to reduce the size of your deployment. Although deplo.io doesn't have Heroku slugs, it is still good to set up. Add this to the `Rakefile`: diff --git a/ruby_on_rails/cloudflare.md b/ruby_on_rails/cloudflare.md index e212f301..89053032 100644 --- a/ruby_on_rails/cloudflare.md +++ b/ruby_on_rails/cloudflare.md @@ -4,7 +4,6 @@ Setup Cloudflare: * Now open * - * * Check that you: diff --git a/ruby_on_rails/content_security_policy.md b/ruby_on_rails/content_security_policy.md index 3d52d682..5b07ee31 100644 --- a/ruby_on_rails/content_security_policy.md +++ b/ruby_on_rails/content_security_policy.md @@ -32,7 +32,7 @@ Rails.application.config.content_security_policy do |policy| end ``` -Details on how to setup Sentry reporting can be found in the [Sentry guide](https://github.com/renuo/applications-setup-guide/blob/master/ruby_on_rails/sentry.md#backend-rails). +Details on how to setup Sentry reporting can be found in the [Sentry guide](https://github.com/renuo/application-setup-guide/blob/main/ruby_on_rails/sentry.md#backend-rails). ## Common Rules diff --git a/ruby_on_rails/create_application_server_deploio.md b/ruby_on_rails/create_application_server_deploio.md index cf7efd1c..7b8168c7 100644 --- a/ruby_on_rails/create_application_server_deploio.md +++ b/ruby_on_rails/create_application_server_deploio.md @@ -33,7 +33,7 @@ In particular, you might need only one of the two environments if you decided to If you think that the script is outdated, please open a Pull Request on the [renuo-cli](https://github.com/renuo/renuo-cli) project. -For further configuration and best practices, please refer to the [Deploio documentation](https://docs.deplo.io). You can also view a Ruby on Rails specific guide [here](https://docs.deplo.io/quick_start/Ruby%20on%20Rails/create_app/). +For further configuration and best practices, please refer to the [Deploio documentation](https://guides.deplo.io). You can also view a Ruby on Rails specific guide [here](https://guides.deplo.io/ruby/quick-start.html). ## Next Steps diff --git a/ruby_on_rails/object_storage.md b/ruby_on_rails/object_storage.md index 9a9ef088..728d325a 100644 --- a/ruby_on_rails/object_storage.md +++ b/ruby_on_rails/object_storage.md @@ -26,7 +26,7 @@ You'll need to run them by yourself after reviewing the output. If you think that the script is outdated, please open a Pull Request on the [renuo-cli](https://github.com/renuo/renuo-cli) project. -For further configuration and best practices, please refer to the [Deploio documentation](https://docs.deplo.io/ruby/object-storage.html#setup-object-storage). +For further configuration and best practices, please refer to the [Deploio documentation](https://guides.deplo.io/ruby/object-storage.html#setup-object-storage). ## AWS diff --git a/templates/pull_requests_template.md b/templates/pull_requests_template.md index 66286b00..5cc3194b 100644 --- a/templates/pull_requests_template.md +++ b/templates/pull_requests_template.md @@ -16,5 +16,5 @@ To install the template copy this file into a `.github` folder in your project o simply run the following command from the root folder of the project: ```bash -mkdir -p .github && curl https://raw.githubusercontent.com/renuo/applications-setup-guide/master/templates/PULL_REQUEST_TEMPLATE.md > .github/PULL_REQUEST_TEMPLATE.md +mkdir -p .github && curl https://raw.githubusercontent.com/renuo/application-setup-guide/main/templates/PULL_REQUEST_TEMPLATE.md > .github/PULL_REQUEST_TEMPLATE.md ```