repos / pico

commit

85ad4b8

parent

bc702c2

author

securepub

date

2024-01-08 20:12:50 +0000 UTC

doc suggestion from IRC #pico.sh @ libera.chat (#67)

[10:25am] pareidoliac: I have had problem with the docs apart from the minor detail that the "-> yourusername"
          should be "-> {username}-myproject" in the https://pgs.sh/help#custom-domain section.
[10:25am] pareidoliac: thinking of making a PR to suggest that
[10:29am] pareidoliac: also suggest mentioning the CSP policy pico.sh vs custom domain in the https://pgs.sh/help#spa section
[10:44am] erock: happy to accept PRs

Co-authored-by: jungle <jungle@night.local>

 1@@ -136,6 +136,13 @@
 2       pgs supports SPAs!  Upload a <code>_redirects</code> file your project:
 3     </p>
 4     <pre>/*  /index.html  200</pre>
 5+
 6+    <p>
 7+      Note that the Content Security Policy (CSP) for pages in the pgs.sh domain
 8+      prohibits javascript from connecting to other origins.
 9+      Pages served by custom domains do not have this restriction.
10+    </p>
11+
12   </section>
13 
14   <section id="custom-domain">
15@@ -154,10 +161,11 @@
16     <pre>CNAME subdomain.yourcustomdomain.com -> {{.Site.Domain}}</pre>
17     <p>Resulting in:</p>
18     <pre>subdomain.yourcustomdomain.com.         300     IN      CNAME   {{.Site.Domain}}.</pre>
19-    <p>And a TXT record to tell Prose what blog is hosted on that domain at the subdomain entry _pgs</p>
20-    <pre>TXT _pgs.subdomain.yourcustomdomain.com -> yourusername</pre>
21+    <p>And a TXT record to tell Prose what project is hosted on that domain at the subdomain entry _pgs</p>
22+    <pre>TXT _pgs.subdomain.yourcustomdomain.com -> username-myproject</pre>
23+    <p>E.g. for user 'erock' and project 'kittens' the result would be:</p>
24     <p>Resulting in:</p>
25-    <pre>_pgs.subdomain.yourcustomdomain.com.         300     IN      TXT     "hey"</pre>
26+    <pre>_pgs.subdomain.yourcustomdomain.com.         300     IN      TXT     "erock-kittens"</pre>
27   </section>
28 </main>
29 {{template "marketing-footer" .}}