Skip to content

Commit

Permalink
Update links to Control Plane documentation (#158)
Browse files Browse the repository at this point in the history
* feat: also check documentation links

* fix: incorrect outgoing links to Control Plane docs
  • Loading branch information
samueldemoura authored Apr 19, 2024
1 parent 9e73fc5 commit 97d4dca
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ For the typical Rails app, this means:

3. Install [Ruby](https://www.ruby-lang.org/en/) (required for these helpers).

4. Install Control Plane CLI, and configure access ([docs here](https://docs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli)).
4. Install Control Plane CLI, and configure access ([docs here](https://shakadocs.controlplane.com/quickstart/quick-start-3-cli#getting-started-with-the-cli)).

```sh
# Install CLI
Expand Down Expand Up @@ -446,7 +446,7 @@ development purposes.

## Scheduled Jobs

Control Plane supports scheduled jobs via [cron workloads](https://docs.controlplane.com/reference/workload#cron).
Control Plane supports scheduled jobs via [cron workloads](https://shakadocs.controlplane.com/reference/workload#cron).

Here's a partial example of a template for a cron workload, using the app image:

Expand Down
2 changes: 1 addition & 1 deletion docs/dns.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

## Docs

https://docs.controlplane.com/guides/configure-domain#dns-records
https://shakadocs.controlplane.com/guides/configure-domain#dns-records

## Example

Expand Down
2 changes: 1 addition & 1 deletion docs/tips.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ The actual remote IP of the workload container is in the 127.0.0.x network, so t
`REMOTE_ADDR` env var.

However, Control Plane additionally sets the `x-forwarded-for` and `x-envoy-external-address` headers (and others - see:
https://docs.controlplane.com/concepts/security#headers). On Rails, the `ActionDispatch::RemoteIp` middleware should
https://shakadocs.controlplane.com/concepts/security#headers). On Rails, the `ActionDispatch::RemoteIp` middleware should
pick those up and automatically populate `request.remote_ip`.

So `REMOTE_ADDR` should not be used directly, only `request.remote_ip`.
Expand Down
6 changes: 3 additions & 3 deletions script/check_cpln_links
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#!/usr/bin/env bash

bad_links=("controlplane.com/shakacode")
proper_links=("shakacode.controlplane.com")
bad_links=("controlplane.com/shakacode" "https://docs.controlplane.com")
proper_links=("shakacode.controlplane.com" "https://shakadocs.controlplane.com")

bold=$(tput bold)
normal=$(tput sgr0)
Expand All @@ -19,7 +19,7 @@ for ((idx = 0; idx < ${#bad_links[@]}; idx++)); do
--heading \
--color=always -- \
"${bad_links[idx]}" \
':!script/check_cpln_links')
':!script/check_cpln_links' '*.md')

# Line would become really unwieldly if everything was mushed into the
# conditional, so let's ignore this check here.
Expand Down

0 comments on commit 97d4dca

Please sign in to comment.