docs: v1 updates (#181)

Author: petethepig

.github/workflows/deploy.yml

@@ -35,23 +35,6 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: 16
-      - uses: actions/checkout@v3
-        with:
-          repository: 'pyroscope-io/docs-private'
-          ref: 'master'
-          path: 'docs-private'
-          token: ${{ secrets.DOCS_PRIVATE_ACCESS_TOKEN }}
-      - name: copy Makefile
-        run: mv docs-private/Makefile Makefile
-      - name: copy generate-pdfs.rb
-        run: mv docs-private/generate-pdfs.rb generate-pdfs.rb
-      - name: copy extra-plugins.js
-        run: mv docs-private/extra-plugins.js extra-plugins.js
-      # For PRs we just build
-      # for merges we deploy
-      - name: build
-        if: ${{ github.event_name == 'pull_request' }}
-        run: make build
       - name: deploy
         if: ${{ github.event_name != 'pull_request' }}
         run: make deploy

.tool-versions

@@ -1 +1 @@
-nodejs 14.17.0
+nodejs 16.18.0

Makefile

@@ -0,0 +1,51 @@
+# updates slack url
+SLACK_INVITE_URL="https://join.slack.com/t/pyroscope/shared_invite/zt-188djmr07-fGVF19hFTPZrLCFJAgwPyw"
+
+API_ADDRESS=https://pyroscope.io
+
+.PHONY: install
+install:
+	yarn install
+
+.PHONY: build-info
+build-info:
+	git show-ref --head --hash=8 2> /dev/null | head -n1 > static/build-info.txt
+	date >> static/build-info.txt
+
+.PHONY: build
+build: install build-info
+	yarn build
+
+.PHONY: generate-pdfs
+generate-pdfs: invalidate-cache
+	ruby generate-pdfs.rb
+
+.PHONY: create-redirects
+create-redirects:
+	ruby create-redirects.rb
+
+.PHONY: slack-url
+slack-url:
+	aws s3api put-object --bucket pyroscope.io --key slack/index.html --body static/slack/index.html --website-redirect-location ${SLACK_INVITE_URL}
+	aws cloudfront create-invalidation --distribution-id E35O9P6VNL3Z5X --paths '/*'
+
+.PHONY: upload
+upload:
+	# This bucket is set up with a static website endpoint and no public-read.
+	# There's a cloudfront distribution in front of it.
+	# Access is set up to only allow reads with a special refferer header that's
+	#   set on cloudfront side. This way it's only accessible via cloudfront.
+	aws s3 sync --exclude 'videos/*' --exclude 'storybook/*' build/ s3://pyroscope.io/
+	aws s3 cp --acl public-read static/img/favicon.ico s3://pyroscope.io/favicon.ico
+
+.PHONY: invalidate-cache
+invalidate-cache:
+	aws cloudfront wait invalidation-completed --distribution-id E35O9P6VNL3Z5X --id $(shell aws cloudfront create-invalidation --distribution-id E35O9P6VNL3Z5X --paths '/*' | jq .Invalidation.Id)
+
+.PHONY: deploy
+deploy:
+	$(MAKE) build
+	$(MAKE) upload
+	$(MAKE) create-redirects
+	$(MAKE) slack-url
+	$(MAKE) invalidate-cache

create-redirects.rb

@@ -0,0 +1,14 @@
+require 'json'
+
+JSON.parse(File.read("redirects.json")).each_pair do |from, to|
+  from = from.sub(/^\//, "").sub(/\/$/, "")
+  next if to == ""
+
+  puts "Redirect 301 #{from} #{to}"
+  system(
+    "aws", "s3api", "put-object",
+    "--bucket", "pyroscope.io",
+    "--key", "#{from}/index.html",
+    "--body", "static/slack/index.html",
+    "--website-redirect-location", to)
+end

docs/agent-install-linux.mdx

@@ -94,7 +94,7 @@ Pyroscope team maintain and sign packages for the following Linux distributions:
 </Tabs>
 
 :::tip
-To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](/downloads) page.
+To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](https://github.com/grafana/pyroscope/releases) page.
 :::
 
 **Pyroscope Agent** is not installed as `systemd` service. If you need to profile a process which is running as a service,

docs/agent-install-macos.mdx

@@ -22,7 +22,7 @@ brew install pyroscope-io/brew/pyroscope
 ```
 
 :::tip
-To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](/downloads) page.
+To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](https://github.com/grafana/pyroscope/releases) page.
 :::
 
 ## Verify the installation

docs/agent-install-windows.mdx

@@ -45,7 +45,7 @@ Install MSI package with `msiexec`:
 <br/>
 
 :::tip
-To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](/downloads) page.
+To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](https://github.com/grafana/pyroscope/releases) page.
 :::
 
 ## Verify the installation

docs/architecture.mdx

@@ -62,7 +62,7 @@ Location for various helper programs / scripts.
 
 ### `scripts/packages`
 
-Helper code / files we use to make releases and generate packages for Linux / macOS. See [Downloads](/downloads) page for more information.
+Helper code / files we use to make releases and generate packages for Linux / macOS. See [Downloads](https://github.com/grafana/pyroscope/releases) page for more information.
 
 ### `third_party/rustdeps`
 

docs/developer-guide.mdx

@@ -248,7 +248,7 @@ Location for various helper programs / scripts.
 
 ### /scripts/packages
 
-Helper code / files we use to make releases and generate packages for Linux / macOS. See [Downloads](/downloads) page for more information.
+Helper code / files we use to make releases and generate packages for Linux / macOS. See [Downloads](https://github.com/grafana/pyroscope/releases) page for more information.
 
 ### /third_party/rustdeps
 

docs/installing-pyroscope-overview.mdx

@@ -29,7 +29,7 @@ export const Video = () => (
 
 ### Step 1: Install Pyroscope Server
 
-We provide a few different ways for you to install Pyroscope Server on [Linux](server-install-linux.mdx), [macOS](server-install-macos.mdx) or run it in <FontAwesomeIcon color="#0db7ed" icon={faDocker}/> [Docker](docker-guide.mdx). To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](/downloads) page.
+We provide a few different ways for you to install Pyroscope Server on [Linux](server-install-linux.mdx), [macOS](server-install-macos.mdx) or run it in <FontAwesomeIcon color="#0db7ed" icon={faDocker}/> [Docker](docker-guide.mdx). To find out about other ways of installing Pyroscope, or to find packages for other CPU architectures (e.g ARM) visit our [Downloads](https://github.com/grafana/pyroscope/releases) page.
 
 After you start the server you should be able to open [http://localhost:4040/](http://localhost:4040/) and see that pyroscope server is profiling itself (`pyroscope.server.cpu` application).