Skip to content

Commit eb87009

Browse files
akalipetisakalipetis
authored
Merge pull request #254 from platformsh/253-update-docs-links
Updates links to docs
2 parents 4c9f603 + e81e2fd commit eb87009

File tree

8 files changed

+145
-145
lines changed

8 files changed

+145
-145
lines changed

‎cmd/platformify/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func main() {
2020
assets := &vendorization.VendorAssets{
2121
Binary: "platform",
2222
ConfigFlavor: "platform",
23-
DocsBaseURL: "https://docs.platform.sh/",
23+
DocsBaseURL: "https://docs.upsun.com/anchors/fixed",
2424
EnvPrefix: "PLATFORM",
2525
ServiceName: "Platform.sh",
2626
Use: "platformify",

‎cmd/upsunify/main.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ func main() {
2020
assets := &vendorization.VendorAssets{
2121
Binary: "upsun",
2222
ConfigFlavor: "upsun",
23-
DocsBaseURL: "https://docs.upsun.com",
23+
DocsBaseURL: "https://docs.upsun.com/anchors",
2424
EnvPrefix: "PLATFORM",
2525
ServiceName: "Upsun",
2626
Use: "upsunify",

‎platformifier/templates/generic/.platform.app.yaml‎

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,18 @@
55
name: "{{ .Name }}"
66

77
# The runtime the application uses.
8-
# Complete list of available runtimes: {{ .Assets.Docs.AppReference }}#types
8+
# Complete list of available runtimes: {{ .Assets.Docs.AppReference }}type/
99
type: "{{ .Type }}"
1010

1111
# How many resources to devote to the app. Defaults to AUTO in production environments.
12-
# More information: {{ .Assets.Docs.AppReference }}#sizes
12+
# More information: {{ .Assets.Docs.AppReference }}sizes/
1313
# size:
1414

1515
# The relationships of the application with services or other applications.
1616
# The left-hand side is the name of the relationship as it will be exposed
1717
# to the application in the {{ .Assets.EnvPrefix }}_RELATIONSHIPS variable. The right-hand
1818
# side is in the form `<service name>:<endpoint name>`.
19-
# More information: {{ .Assets.Docs.AppReference }}#relationships
19+
# More information: {{ .Assets.Docs.AppReference }}relationships/
2020
{{ if .Relationships -}}
2121
relationships:
2222
{{ range $key, $value := .Relationships }}
@@ -35,7 +35,7 @@ disk: {{ .Disk }}
3535
{{- end }}
3636

3737
# Mounts define directories that are writable after the build is complete. If set as a local source, disk property is required.
38-
# More information: {{ .Assets.Docs.AppReference }}#mounts
38+
# More information: {{ .Assets.Docs.AppReference }}mounts/
3939
{{ if .Mounts -}}
4040
mounts:
4141
{{ range $key, $value := .Mounts -}}
@@ -52,10 +52,10 @@ mounts:
5252
{{- end }}
5353

5454
# The web key configures the web server running in front of your app.
55-
# More information: {{ .Assets.Docs.AppReference }}#web
55+
# More information: {{ .Assets.Docs.AppReference }}web/
5656
web:
5757
# Commands are run once after deployment to start the application process.
58-
# More information: {{ .Assets.Docs.AppReference }}#web-commands
58+
# More information: {{ .Assets.Docs.AppReference }}web/commands/
5959
{{- if .WebCommand }}
6060
commands:
6161
# The command to launch your app. If it terminates, it’s restarted immediately.
@@ -67,7 +67,7 @@ web:
6767
# You can use the $PORT or the $SOCKET environment variable depending on the socket family of your upstream
6868
{{- if eq "php" .Runtime }}
6969
# PHP applications run PHP-fpm by default
70-
# Read about alternative commands here: {{ .Assets.Docs.PHP }}#alternate-start-commands
70+
# Read about alternative commands here: {{ .Assets.Docs.PHP }}alternate-start-commands/
7171
{{- end }}
7272
# start: echo 'Put your start command here'
7373
{{- end }}
@@ -76,11 +76,11 @@ web:
7676
# For PHP, the defaults are configured for PHP-FPM and shouldn't need adjustment.
7777
{{- end }}
7878
# Whether your app should speak to the webserver via TCP or Unix socket. Defaults to tcp
79-
# More information: {{ .Assets.Docs.AppReference }}#where-to-listen
79+
# More information: {{ .Assets.Docs.AppReference }}web/upstream/socket-family/
8080
{{- if .SocketFamily }}
8181
upstream:
8282
# Whether your app should speak to the webserver via TCP or Unix socket. Defaults to tcp
83-
# More information: {{ .Assets.Docs.AppReference }}#where-to-listen
83+
# More information: {{ .Assets.Docs.AppReference }}web/upstream/socket-family/
8484
socket_family: {{ .SocketFamily }}
8585
{{- else }}
8686
# upstream:
@@ -89,7 +89,7 @@ web:
8989

9090
{{- if .Locations }}
9191
# Each key in locations is a path on your site with a leading /.
92-
# More information: {{ .Assets.Docs.AppReference }}#locations
92+
# More information: {{ .Assets.Docs.AppReference }}web/locations/
9393
locations:
9494
{{ range $key, $value := .Locations -}}
9595
"{{ $key }}":
@@ -113,18 +113,18 @@ web:
113113
{{ end }}
114114

115115
# Alternate copies of the application to run as background processes.
116-
# More information: {{ .Assets.Docs.AppReference }}#workers
116+
# More information: {{ .Assets.Docs.AppReference }}workers/
117117
# workers:
118118

119119
# The timezone for crons to run. Format: a TZ database name. Defaults to UTC, which is the timezone used for all logs
120120
# no matter the value here. More information: {{ .Assets.Docs.TimeZone }}
121121
# timezone: <time-zone>
122122

123123
# Access control for roles accessing app environments.
124-
# More information: {{ .Assets.Docs.AppReference }}#access
124+
# More information: {{ .Assets.Docs.AppReference }}access/
125125
# access:
126126

127-
# Variables to control the environment. More information: {{ .Assets.Docs.AppReference }}#variables
127+
# Variables to control the environment. More information: {{ .Assets.Docs.AppReference }}variables/
128128
{{ if .Environment -}}
129129
variables:
130130
env:
@@ -148,11 +148,11 @@ variables:
148148
{{- end }}
149149
{{- end }}
150150

151-
# Outbound firewall rules for the application. More information: {{ .Assets.Docs.AppReference }}#firewall
151+
# Outbound firewall rules for the application. More information: {{ .Assets.Docs.AppReference }}firewall/
152152
# firewall:
153153

154154
# Specifies a default set of build tasks to run. Flavors are language-specific.
155-
# More information: {{ .Assets.Docs.AppReference }}#build
155+
# More information: {{ .Assets.Docs.AppReference }}build/
156156
{{ if .BuildFlavor -}}
157157
build:
158158
flavor: {{ .BuildFlavor }}
@@ -164,7 +164,7 @@ build:
164164
# Installs global dependencies as part of the build process. They’re independent of your app’s dependencies and
165165
# are available in the PATH during the build process and in the runtime environment. They’re installed before
166166
# the build hook runs using a package manager for the language.
167-
# More information: {{ .Assets.Docs.AppReference }}#dependencies
167+
# More information: {{ .Assets.Docs.AppReference }}dependencies/
168168
{{ if .Dependencies -}}
169169
dependencies:
170170
{{- range $depGroupKey, $depGroupValue := .Dependencies }}
@@ -192,10 +192,10 @@ dependencies:
192192
{{- end }}
193193

194194
# Hooks allow you to customize your code/environment as the project moves through the build and deploy stages
195-
# More information: {{ .Assets.Docs.AppReference }}#hooks
195+
# More information: {{ .Assets.Docs.AppReference }}hooks/
196196
hooks:
197197
# The build hook is run after any build flavor.
198-
# More information: {{ .Assets.Docs.Hooks }}#build-hook
198+
# More information: {{ .Assets.Docs.Hooks }}compare/build/
199199
build: |
200200
set -eux
201201
{{ range $step := .BuildSteps }}
@@ -205,7 +205,7 @@ hooks:
205205
# echo 'I am a build step'
206206
{{ end }}
207207
# The deploy hook is run after the app container has been started, but before it has started accepting requests.
208-
# More information: {{ .Assets.Docs.Hooks }}#deploy-hook
208+
# More information: {{ .Assets.Docs.Hooks }}compare/deploy/
209209
deploy: |
210210
set -eux
211211
{{ range $deploycmd := .DeployCommand }}
@@ -215,15 +215,15 @@ hooks:
215215
{{ end }}
216216
217217
# The post_deploy hook is run after the app container has been started and after it has started accepting requests.
218-
# More information: {{ .Assets.Docs.Hooks }}#deploy-hook
218+
# More information: {{ .Assets.Docs.Hooks }}compare/post-deploy/
219219
# post_deploy: |
220220

221221
# Scheduled tasks for the app.
222-
# More information: {{ .Assets.Docs.AppReference }}#crons
222+
# More information: {{ .Assets.Docs.AppReference }}crons/
223223
# crons:
224224

225-
# Customizations to your PHP or Lisp runtime. More information: {{ .Assets.Docs.AppReference }}#runtime
225+
# Customizations to your PHP or Lisp runtime. More information: {{ .Assets.Docs.AppReference }}runtime/
226226
# runtime:
227227

228-
# More information: {{ .Assets.Docs.AppReference }}#additional-hosts
228+
# More information: {{ .Assets.Docs.AppReference }}additional-hosts/
229229
# additional_hosts:

‎platformifier/templates/generic/.platform/routes.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
upstream: "{{ .Name }}:http"
99

1010
# A basic redirect definition
11-
# More information: {{ .Assets.Docs.Routes }}#basic-redirect-definition
11+
# More information: {{ .Assets.Docs.Routes }}examples/redirect/
1212
"https://www.{{ "{default}" }}":
1313
type: redirect
1414
to: "https://{{ "{default}" }}/"

‎platformifier/templates/generic/.platform/services.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
# Each service listed will be deployed
44
# to power your {{ .Assets.ServiceName }} project.
55
# More information: {{ .Assets.Docs.Services }}
6-
# Full list of available services: {{ .Assets.Docs.Services }}#available-services
6+
# Full list of available services: {{ .Assets.Docs.Services }}available/
77
{{- if .Services -}}
88
{{- range $value := .Services }}
99
{{ $value.Name }}:

‎platformifier/templates/upsun/.upsun/config.yaml‎

Lines changed: 25 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -6,18 +6,18 @@ applications:
66
root: "{{ .ApplicationRoot }}"
77

88
# The runtime the application uses.
9-
# Complete list of available runtimes: {{ .Assets.Docs.AppReference }}#types
9+
# Complete list of available runtimes: {{ .Assets.Docs.AppReference }}type/
1010
type: "{{ .Type }}"
1111

1212
# Choose which container profile (ratio CPU+RAM) your app will use. Default value comes from the image itself.
13-
# More information: https://docs.upsun.com/manage-resources/adjust-resources.html#adjust-a-container-profile
13+
# More information: https://docs.upsun.com/anchors/resources/manage/configuration/profiles/adjust/
1414
# container_profile:
1515

1616
# The relationships of the application with services or other applications.
1717
# The left-hand side is the name of the relationship as it will be exposed
1818
# to the application in the {{ .Assets.EnvPrefix }}_RELATIONSHIPS variable. The right-hand
1919
# side is in the form `<service name>:<endpoint name>`.
20-
# More information: {{ .Assets.Docs.AppReference }}#relationships
20+
# More information: {{ .Assets.Docs.AppReference }}relationships/
2121
{{ if .Relationships -}}
2222
relationships:
2323
{{ range $key, $value := .Relationships }}
@@ -29,7 +29,7 @@ applications:
2929
{{ end }}
3030

3131
# Mounts define directories that are writable after the build is complete.
32-
# More information: {{ .Assets.Docs.AppReference }}#mounts
32+
# More information: {{ .Assets.Docs.AppReference }}mounts/
3333
{{ if .Mounts -}}
3434
mounts:
3535
{{ range $key, $value := .Mounts -}}
@@ -47,10 +47,10 @@ applications:
4747
{{- end }}
4848

4949
# The web key configures the web server running in front of your app.
50-
# More information: {{ .Assets.Docs.AppReference }}#web
50+
# More information: {{ .Assets.Docs.AppReference }}web/
5151
web:
5252
# Commands are run once after deployment to start the application process.
53-
# More information: {{ .Assets.Docs.AppReference }}#web-commands
53+
# More information: {{ .Assets.Docs.AppReference }}web/commands/
5454
{{- if .WebCommand }}
5555
commands:
5656
# The command to launch your app. If it terminates, it’s restarted immediately.
@@ -62,7 +62,7 @@ applications:
6262
# You can use the $PORT or the $SOCKET environment variable depending on the socket family of your upstream
6363
{{- if eq "php" .Runtime }}
6464
# PHP applications run PHP-fpm by default
65-
# Read about alternative commands here: {{ .Assets.Docs.PHP }}#alternate-start-commands
65+
# Read about alternative commands here: {{ .Assets.Docs.PHP }}alternate-start-commands/
6666
{{- end }}
6767
# start: echo 'Put your start command here'
6868
{{- end }}
@@ -71,11 +71,11 @@ applications:
7171
# For PHP, the defaults are configured for PHP-FPM and shouldn't need adjustment.
7272
{{- end }}
7373
# Whether your app should speak to the webserver via TCP or Unix socket. Defaults to tcp
74-
# More information: {{ .Assets.Docs.AppReference }}#where-to-listen
74+
# More information: {{ .Assets.Docs.AppReference }}web/upstream/socket-family/
7575
{{- if .SocketFamily }}
7676
upstream:
7777
# Whether your app should speak to the webserver via TCP or Unix socket. Defaults to tcp
78-
# More information: {{ .Assets.Docs.AppReference }}#where-to-listen
78+
# More information: {{ .Assets.Docs.AppReference }}web/upstream/socket-family/
7979
socket_family: {{ .SocketFamily }}
8080
{{- else }}
8181
# upstream:
@@ -84,7 +84,7 @@ applications:
8484

8585
{{- if .Locations }}
8686
# Each key in locations is a path on your site with a leading /.
87-
# More information: {{ .Assets.Docs.AppReference }}#locations
87+
# More information: {{ .Assets.Docs.AppReference }}web/locations/
8888
locations:
8989
{{ range $key, $value := .Locations -}}
9090
"{{ $key }}":
@@ -108,18 +108,18 @@ applications:
108108
{{ end }}
109109

110110
# Alternate copies of the application to run as background processes.
111-
# More information: {{ .Assets.Docs.AppReference }}#workers
111+
# More information: {{ .Assets.Docs.AppReference }}workers/
112112
# workers:
113113

114114
# The timezone for crons to run. Format: a TZ database name. Defaults to UTC, which is the timezone used for all logs
115115
# no matter the value here. More information: {{ .Assets.Docs.TimeZone }}
116116
# timezone: <time-zone>
117117

118118
# Access control for roles accessing app environments.
119-
# More information: {{ .Assets.Docs.AppReference }}#access
119+
# More information: {{ .Assets.Docs.AppReference }}access/
120120
# access:
121121

122-
# Variables to control the environment. More information: {{ .Assets.Docs.AppReference }}#variables
122+
# Variables to control the environment. More information: {{ .Assets.Docs.AppReference }}variables/
123123
{{ if .Environment -}}
124124
variables:
125125
env:
@@ -143,11 +143,11 @@ applications:
143143
{{- end }}
144144
{{- end }}
145145

146-
# Outbound firewall rules for the application. More information: {{ .Assets.Docs.AppReference }}#firewall
146+
# Outbound firewall rules for the application. More information: {{ .Assets.Docs.AppReference }}firewall/
147147
# firewall:
148148

149149
# Specifies a default set of build tasks to run. Flavors are language-specific.
150-
# More information: {{ .Assets.Docs.AppReference }}#build
150+
# More information: {{ .Assets.Docs.AppReference }}build/
151151
{{ if .BuildFlavor -}}
152152
build:
153153
flavor: {{ .BuildFlavor }}
@@ -159,7 +159,7 @@ applications:
159159
# Installs global dependencies as part of the build process. They’re independent of your app’s dependencies and
160160
# are available in the PATH during the build process and in the runtime environment. They’re installed before
161161
# the build hook runs using a package manager for the language.
162-
# More information: {{ .Assets.Docs.AppReference }}#dependencies
162+
# More information: {{ .Assets.Docs.AppReference }}dependencies/
163163
{{ if .Dependencies -}}
164164
dependencies:
165165
{{- range $key, $value := .Dependencies }}
@@ -187,10 +187,10 @@ applications:
187187
{{- end }}
188188

189189
# Hooks allow you to customize your code/environment as the project moves through the build and deploy stages
190-
# More information: {{ .Assets.Docs.AppReference }}#hooks
190+
# More information: {{ .Assets.Docs.AppReference }}hooks/
191191
hooks:
192192
# The build hook is run after any build flavor.
193-
# More information: {{ .Assets.Docs.Hooks }}#build-hook
193+
# More information: {{ .Assets.Docs.Hooks }}compare/build/
194194
build: |
195195
set -eux
196196
{{ range $step := .BuildSteps }}
@@ -200,7 +200,7 @@ applications:
200200
# echo 'I am a build step'
201201
{{ end }}
202202
# The deploy hook is run after the app container has been started, but before it has started accepting requests.
203-
# More information: {{ .Assets.Docs.Hooks }}#deploy-hook
203+
# More information: {{ .Assets.Docs.Hooks }}compare/deploy/
204204
deploy: |
205205
set -eux
206206
{{ range $deploycmd := .DeployCommand }}
@@ -210,25 +210,25 @@ applications:
210210
{{ end }}
211211
212212
# The post_deploy hook is run after the app container has been started and after it has started accepting requests.
213-
# More information: {{ .Assets.Docs.Hooks }}#deploy-hook
213+
# More information: {{ .Assets.Docs.Hooks }}compare/post-deploy/
214214
# post_deploy: |
215215

216216
# Scheduled tasks for the app.
217-
# More information: {{ .Assets.Docs.AppReference }}#crons
217+
# More information: {{ .Assets.Docs.AppReference }}crons/
218218
# crons:
219219

220-
# Customizations to your PHP or Lisp runtime. More information: {{ .Assets.Docs.AppReference }}#runtime
220+
# Customizations to your PHP or Lisp runtime. More information: {{ .Assets.Docs.AppReference }}runtime/
221221
# runtime:
222222

223-
# More information: {{ .Assets.Docs.AppReference }}#additional-hosts
223+
# More information: {{ .Assets.Docs.AppReference }}additional-hosts/
224224
# additional_hosts:
225225

226226
# The services of the project.
227227
#
228228
# Each service listed will be deployed
229229
# to power your {{ .Assets.ServiceName }} project.
230230
# More information: {{ .Assets.Docs.Services }}
231-
# Full list of available services: {{ .Assets.Docs.Services }}#available-services
231+
# Full list of available services: {{ .Assets.Docs.Services }}available/
232232
{{- if .Services }}
233233
services:
234234
{{ range $value := .Services }}
@@ -252,7 +252,7 @@ routes:
252252
type: upstream
253253
upstream: "{{ .Name }}:http"
254254
# A basic redirect definition
255-
# More information: {{ .Assets.Docs.Routes }}#basic-redirect-definition
255+
# More information: {{ .Assets.Docs.Routes }}examples/redirect/
256256
"https://www.{{ "{default}" }}":
257257
type: redirect
258258
to: "https://{{ "{default}" }}/"

0 commit comments

Comments
 (0)