Skip to content

Commit 1aa8edb

Browse files
authored
Update docs (#434)
1 parent 15272c7 commit 1aa8edb

File tree

9 files changed

+10
-11
lines changed

9 files changed

+10
-11
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Renuo Applications Setup Guide
1+
# Renuo Application Setup Guide
22

33
This repo is the [Renuo](https://www.renuo.ch) collection of best-practices to set-up apps.
44
We are a [Rails company](https://rubyonrails.org/foundation), so the most value probably

gitflow.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Since we follow gitflow, we have two main branches connected, via CD, to two ser
88

99
```mermaid
1010
graph LR
11-
A[master] --> CI1(CI) --> CD1(CD)
11+
A[main] --> CI1(CI) --> CD1(CD)
1212
CD1(CD) --> S11(server)
1313
CD1(CD) --> S12(server)
1414
@@ -28,7 +28,7 @@ sequenceDiagram
2828
2929
rect rgb(191, 223, 255)
3030
31-
Developer->>G: git push origin develop or master
31+
Developer->>G: git push origin develop or main
3232
G->>CI: notify about code change
3333
CI->>G: checkout code
3434
CI->>CI: run tests

go_live.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ When preparing your app for production on Deploio, ensure the following:
3535
* Confirm the configured application size in the application configuration tab.
3636
* Ensure the application replica count is correctly set in the application configuration tab.
3737

38-
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).
38+
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).
3939

4040
## Heroku
4141

ruby_on_rails/app_initialisation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ You can do this with `gem update rails`. Beware of beta versions.
1515

1616
* Start a new Rails project using
1717
```
18-
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
18+
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
1919
```
2020
where the `project-name` is exactly the one you chose before.
2121

@@ -145,7 +145,7 @@ Check existing projects for an example of the usage.
145145
end
146146
```
147147

148-
* 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.
148+
* 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.
149149

150150
* If you're using a js-bundling tool, let's clean up after asset precompilation
151151
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`:

ruby_on_rails/cloudflare.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@ Setup Cloudflare: <https://www.cloudflare.com/a/dns/renuoapp.ch>
44

55
* Now open
66
* <http://[project-name]-main.renuoapp.ch/home/check>
7-
* <http://[project-name]-master.renuoapp.ch/home/check>
87
* <http://[project-name]-develop.renuoapp.ch/home/check>
98

109
Check that you:

ruby_on_rails/content_security_policy.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ Rails.application.config.content_security_policy do |policy|
3232
end
3333
```
3434

35-
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).
35+
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).
3636

3737
## Common Rules
3838

ruby_on_rails/create_application_server_deploio.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ In particular, you might need only one of the two environments if you decided to
3333

3434
If you think that the script is outdated, please open a Pull Request on the [renuo-cli](https://github.com/renuo/renuo-cli) project.
3535

36-
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/).
36+
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).
3737

3838
## Next Steps
3939

ruby_on_rails/object_storage.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ You'll need to run them by yourself after reviewing the output.
2626
2727
If you think that the script is outdated, please open a Pull Request on the [renuo-cli](https://github.com/renuo/renuo-cli) project.
2828
29-
For further configuration and best practices, please refer to the [Deploio documentation](https://docs.deplo.io/ruby/object-storage.html#setup-object-storage).
29+
For further configuration and best practices, please refer to the [Deploio documentation](https://guides.deplo.io/ruby/object-storage.html#setup-object-storage).
3030
3131
## AWS
3232

templates/pull_requests_template.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,5 +16,5 @@ To install the template copy this file into a `.github` folder in your project o
1616
simply run the following command from the root folder of the project:
1717

1818
```bash
19-
mkdir -p .github && curl https://raw.githubusercontent.com/renuo/applications-setup-guide/master/templates/PULL_REQUEST_TEMPLATE.md > .github/PULL_REQUEST_TEMPLATE.md
19+
mkdir -p .github && curl https://raw.githubusercontent.com/renuo/application-setup-guide/main/templates/PULL_REQUEST_TEMPLATE.md > .github/PULL_REQUEST_TEMPLATE.md
2020
```

0 commit comments

Comments
 (0)