Skip to content

Commit 0c2352b

Browse files
committed
Merge branch 'stable'
2 parents 8ff10c2 + f8c43a3 commit 0c2352b

File tree

3 files changed

+51
-15
lines changed

3 files changed

+51
-15
lines changed

doc/install_and_upgrade.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -410,10 +410,6 @@ executables, which depends on the operating system:
410410
PATH. That can be done by searching for 'Edit Environment variables for your
411411
account' under Start.
412412

413-
If you don't have that directory in your PATH, you may need to update your PATH.
414-
On Unix-like operating systems, that can be done by editing the `~/.bashrc`
415-
file.
416-
417413
## China-based users
418414

419415
If you're attempting to install Stack from within China:

doc/maintainers/haskellstack.org.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@ Stack project, using [Read the Docs](https://readthedocs.org/) with
77
[MkDocs](https://www.mkdocs.org/) and the Material for MkDocs
88
[theme](https://squidfunk.github.io/mkdocs-material/).
99

10+
The domain https://get.haskellstack.org provides URLs that redirect to URLs
11+
used to install the Stack executable.
12+
1013
## Read the Docs
1114

1215
The Read the Docs project is named
@@ -135,9 +138,34 @@ Other extensions to the basic Markdown syntax used include:
135138
versions of Stack. The `material-cloud-download-outline` icon
136139
(:material-cloud-download-outline:) is used to signify a download link.
137140

138-
## Testing
141+
## Testing online documentation
139142

140143
Online documentation can be tested by establishing a branch on the repository
141144
that is then configured on the Read the Docs web site as 'Active' but
142145
'Hidden' - for example branch `mkdocs-test`. As the branch is 'Hidden' it does
143146
not appear in the Read the Docs flyout or search results.
147+
148+
## get.haskellstack.org redirects
149+
150+
The https://get.haskellstack.org redirects are implemented with
151+
[CloudFlare Pages](https://developers.cloudflare.com/pages/platform/redirects/)
152+
and a `_redirects` file in the root of the
153+
`commercialhaskell/get-haskellstack-org` GitHub
154+
[repository](https://github.com/commercialhaskell/get-haskellstack-org).
155+
156+
Each redirect is defined as a line in the file with format:
157+
158+
~~~text
159+
[source] [destination]
160+
~~~
161+
162+
'Splats' are used in redirects. On matching, a splat (asterisk, `*`) will greedily match all characters and the matched value can be used in the redirect location with `:splat`.
163+
164+
For example, for Stack 2.9.1:
165+
166+
~~~text
167+
/stable/* https://github.com/commercialhaskell/stack/releases/download/v2.9.1/stack-2.9.1-:splat
168+
/upgrade/linux-x86_64-static.tar.gz https://github.com/commercialhaskell/stack/releases/download/v2.9.1/stack-2.9.1-linux-x86_64.tar.gz
169+
/upgrade/* https://github.com/commercialhaskell/stack/releases/download/v2.9.1/stack-2.9.1-:splat
170+
/ https://raw.githubusercontent.com/commercialhaskell/stack/stable/etc/scripts/get-stack.sh
171+
~~~

doc/maintainers/releases.md

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -440,20 +440,32 @@ final release.
440440
441441
Ensure that the `stable` documentation has updated.
442442
443-
### F: Update get.haskellstack.org
443+
### F: Update get.haskellstack.org redirects
444444
445-
Update
446-
[get.haskellstack.org /stable and /upgrade rewrite rules](https://gitlab.com/fpco/operations/kube/fpcomplete-sites-project/-/blob/master/fpcomplete-redirects/get-haskellstack_virtualservice.yaml)
447-
with the new version.
445+
Update the https://get.haskellstack.org redirects by updating the
446+
`_redirects` file in the root of the
447+
`commercialhaskell/get-haskellstack-org` GitHub
448+
[repository](https://github.com/commercialhaskell/get-haskellstack-org).
448449
449-
Sync the application in
450-
[ArgoCD](https://v5.fpcomplete.com/argocd/applications/fpcomplete-redirects).
450+
For further information, see the
451+
[get.haskellstack.org redirects](haskellstack.org.md#gethaskellstackorg-redirects)
452+
documentation.
451453
452-
Test with the command:
454+
Test with the commands:
453455
454-
~~~text
455-
curl -vL https://get.haskellstack.org/stable/linux-x86_64.tar.gz >/dev/null
456-
~~~
456+
=== "Unix-like"
457+
458+
~~~text
459+
curl -vL https://get.haskellstack.org/stable/linux-x86_64.tar.gz >/dev/null
460+
curl -vL https://get.haskellstack.org/upgrade/linux-x86_64.tar.gz >/dev/null
461+
~~~
462+
463+
=== "Windows (with PowerShell)"
464+
465+
~~~text
466+
curl -vL https://get.haskellstack.org/stable/linux-x86_64.tar.gz >NUL
467+
curl -vL https://get.haskellstack.org/upgrade/linux-x86_64.tar.gz >NUL
468+
~~~
457469
458470
and make sure it redirects to the new version.
459471

0 commit comments

Comments
 (0)