fix merge conflict

Author: ceorourke

.dockerignore

@@ -13,3 +13,6 @@ node_modules
 .nvmrc
 Dockerfile
 bin
+
+gatsby/public
+gatsby/node_modules

.envrc

@@ -0,0 +1,3 @@
+set -e
+
+layout node

.github/workflows/test.yml

@@ -0,0 +1,20 @@
+name: Test
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: volta-cli/action@v1
+    - run: yarn install
+      working-directory: gatsby
+    - run: yarn test
+      working-directory: gatsby

.gitignore

@@ -1,15 +1,84 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Typescript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# dotenv environment variables file
+.env
+.env.development
+
+# gatsby files
+.cache/
+public
+
+# Mac files
+.DS_Store
+
+# Yarn
+package-lock.json
+yarn-error.log
+.pnp/
+.pnp.js
+# Yarn Integrity file
+.yarn-integrity
+
+# jekyll output
 _site
-.sass-cache
 .jekyll-metadata
 .jekyll-cache
+.sass-cache
 .link-checker
 .asset-cache
-/node_modules/
-/apidocs
-package-lock.json
-.DS_Store
 src/_assets/js/bundle.js*
+
+/apidocs
+
 tmp
-coverage/
-.yarn-error
-yarn-error.log

.nvmrc

@@ -1 +1 @@
-8.11.3
+10.14.2

.pre-commit-config.yaml

@@ -0,0 +1,24 @@
+exclude: '\.snap|node_modules$'
+repos:
+  - repo: git://github.com/pre-commit/pre-commit-hooks
+    rev: v1.4.0
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-symlinks
+      - id: check-xml
+      - id: check-yaml
+      - id: detect-private-key
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+      - id: debug-statements
+      - id: flake8
+      - id: fix-encoding-pragma
+        args: ["--remove"]
+  - repo: git://github.com/getsentry/pre-commit-hooks
+    rev: f3237d2d65af81d435c49dee3593dc8f03d23c2d
+    hooks:
+      - id: prettier
+        entry: gatsby/node_modules/.bin/prettier
+      # - id: eslint
+      #   entry: gatsby/node_modules/.bin/eslint

.prettierrc

@@ -1 +0,0 @@
-singleQuote: true

.travis.yml

@@ -10,6 +10,6 @@ cache:
   directories:
     - node_modules
 script:
-  - bin/test
+  - yarn test-jekyll
   - yarn run snyk-protect
 dist: trusty

.vscode/settings.json

@@ -3,6 +3,10 @@
   "files.trimTrailingWhitespace": false,
   "prettier.disableLanguages": ["markdown", "html", "scss"],
 
+  "files.associations": {
+    "*.js": "javascriptreact"
+  },
+
   "liquid.format": false,
 
   "[ruby]": {

.yarnrc

@@ -1,3 +1,28 @@
 ARG VERSION=2020.01.23
+
 FROM getsentry/jekyll-base:builder-${VERSION} AS builder
+
+# we have to use a diff base image than jekyll due to the node version requirements
+# XXX(dcramer): when jekyll is gone, there's a base imagine we can use if gatsby lives at document root
+FROM node:12-buster as gatsby
+
+ARG BUILD_CONF={}
+ENV BUILD_CONF="$BUILD_CONF"
+
+ARG ALGOLIA_INDEX=
+ENV ALGOLIA_INDEX=$ALGOLIA_INDEX
+
+ARG ALGOLIA_ADMIN_KEY=
+ENV ALGOLIA_ADMIN_KEY=$ALGOLIA_ADMIN_KEY
+
+RUN yarn global add gatsby-cli
+WORKDIR /usr/src/app
+ADD . ./
+WORKDIR /usr/src/app/gatsby
+RUN yarn
+RUN gatsby build
+
 FROM getsentry/jekyll-base:runtime-${VERSION} AS runtime
+
+COPY --from=gatsby /usr/src/app/gatsby/public/ /usr/share/nginx/html/gatsby
+COPY --from=builder /usr/src/app/_site/ /usr/share/nginx/html/jekyll

Dockerfile

@@ -20,7 +20,7 @@ GIT
 GEM
   remote: https://rubygems.org/
   specs:
-    activesupport (5.2.3)
+    activesupport (5.2.4.3)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
@@ -37,7 +37,7 @@ GEM
       execjs
     colorator (1.1.0)
     colorize (0.8.1)
-    concurrent-ruby (1.1.5)
+    concurrent-ruby (1.1.6)
     em-websocket (0.5.1)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0.6.0)
@@ -62,7 +62,7 @@ GEM
       yell (~> 2.0)
     http_parser.rb (0.6.0)
     httpclient (2.8.3)
-    i18n (1.6.0)
+    i18n (1.8.2)
       concurrent-ruby (~> 1.0)
     jekyll-algolia (1.2.7)
       algolia_html_extractor (~> 2.5.2)
@@ -109,15 +109,15 @@ GEM
       ruby_dep (~> 1.2)
     mercenary (0.3.6)
     mini_portile2 (2.3.0)
-    minitest (5.11.3)
+    minitest (5.14.1)
     nokogiri (1.8.5)
       mini_portile2 (~> 2.3.0)
     parallel (1.17.0)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
     progressbar (1.10.0)
     public_suffix (3.0.3)
-    rack (2.0.8)
+    rack (2.2.3)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
       ffi (~> 1.0)
@@ -135,7 +135,7 @@ GEM
     thread_safe (0.3.6)
     typhoeus (1.3.1)
       ethon (>= 0.9.0)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
     verbal_expressions (0.1.5)
     yell (2.1.0)

Gemfile.lock

@@ -16,7 +16,7 @@ Additional Use Grant: You may make use of the Licensed Work, provided that you d
                       error-reporting or application monitoring features of the
                       Licensed Work.
 
-Change Date:          2023-04-01
+Change Date:          2023-07-01
 
 Change License:       Apache License, Version 2.0
 

LICENSE

@@ -0,0 +1,6 @@
+develop:
+	[ ! -f gatsby/.env.develpoment ] && cp gatsby/.env.example gatsby/.env.development
+	yarn develop
+
+test:
+	yarn test

Makefile

@@ -1,31 +1,82 @@
 # Sentry Documentation
 
-The Sentry documentation is a static site, generated by [Jekyll][jekyll].
+The Sentry documentation is a static site, generated by [Jekyll][jekyll] and [Gatsby][gatsby].
 
 ## Getting started
 
-You will need [Ruby][ruby], [Bundler][bundler], [Node.js][nodejs], and [Yarn] installed. If you don't have opinions about the process, this will get you going:
+You will need [Ruby][ruby], [Bundler][bundler], and [Volta][volta.sh] installed. If you don't have opinions about the process, this will get you going:
 
 ```bash
 # Install Homebrew and everything mentioned above
 $ bin/bootstrap
 ```
 
-To run the local webserver:
+Once you have the required system dependencies:
 
+```bash
+# Install or update application dependencies
+$ make
 ```
-$ bin/server
+
+Now run the development webserver:
+
+```bash
+$ yarn start
 ```
 
-This will run Bundler to install all the necessary dependencies and then run a webserver at http://localhost:9001/.
+You will now be able to access docs via http://localhost:3000.
+
+Note: This is running both the Jekyll (port 9001) and Gatsby (port 8000) servers, with a proxy routing requests between the two.
+
+## The Great Gatsby Migration
+
+The repository currently contains a Jekyll site (`./`) as well as a Gatsby site (`./gatsby`). This is to aid with a progressive migratiopn over to Gatsby. There's a bit of magic that you need to understand in how this is deployed:
+
+- In production, the `nginx.conf` file determines which routes are served by Jekyll vs Gatsby. Gatsby is the default behavior, whereas Jekyll routes are listed explicitly.
 
-[jekyll]: https://jekyllrb.com/
-[ruby]: https://www.ruby-lang.org/
-[bundler]: http://bundler.io/
-[nodejs]: https://nodejs.org/
-[yarn]: https://yarnpkg.com
+- In development, the proxy server (`server.js`) manages routing between Jekyll (http://localhost:9001) and Gatsby (http://localhost:8000). Route configuration is the same as whats in nginx.
 
-## Development mode
+- We've disabled the default optimized static links within Gatsby due to the complexity of navigating between two codebases. Once the Jekyll conversion is done, we'll want to make the change in `<SmartLink>`.
+
+- We're automatically importing _all_ Jekyll pages inside of Gatsby. They won't all work. When formally converting a page over to Gatsby you should move it into a parallel location inside of the Gatsby file tree (`./src/docs/...`). You also like want to convert it to `.mdx` instead of `.md`. (DC: you will need to update `gatsby-node.js` to handle indexing `.mdx` once the first is added!)
+
+- This is likely brittle. We want to move away from Jekyll as quickly as possible, so ideally all new content is done in Gatsby.
+
+- You can determine which engine is used by viewing source and looking for `"Rendered with"` in the HTML.
+
+## MDX Components + Markdown
+
+:pray: that MDX v2 fixes this.
+
+MDX has its flaws. When rendering components, any text inside of them is treated as raw text (_not_ markdown). To work around this you can use the `<markdown>` tag, but it also has its issues. Generally speaking, put an empty after the opening tag, and before the closing tag.
+
+```jsx
+// dont do this as parsing will hit weird breakages
+<markdown>
+foo bar
+</markdown>
+```
+
+```jsx
+// do this@
+<markdown>
+
+foo bar
+
+</markdown>
+```
+
+## Development mode (Gatsby-specific)
+
+The following instructions assume you're in `./gatsby`.
+
+Nothing to really see here yet. We'll update this when the Jekyll wrappers are gone.
+
+```bash
+$ yarn start
+```
+
+## Development mode (Jekyll-specific)
 
 There are a number of enhancements in place that are only available when developing locally.
 
@@ -35,7 +86,7 @@ There are a number of enhancements in place that are only available when develop
 
 ### Environment Variables
 
-The following variables can be set when using `bin/server`. Defaults prefer performance.
+The following variables can be set when using `bin/server` (aka `yarn start-jekyll`). Defaults prefer performance.
 
 - `FAST_BUILD=true` The master switch. When true, all performance adjustments are enabled. Disable to debug strange behavior.
 - `JEKYLL_INCREMENTAL=true` When true, Jekyll only rebuilds pages that have changed. In some cases this can create [unpredictable behavior](https://jekyllrb.com/docs/configuration/#incremental-regeneration).
@@ -79,3 +130,7 @@ Categories are manually defined.
 ### Add a document
 
 Category hierarchy is automatically defined by folder structure. Add a markdown file to a folder within _src/collections/_documentation_. Order is alphabetical by default, or you may force sorting order by adding an `sidebar_order` integer value in the frontmatter of the document.
+
+## Updating Test Snapshots
+
+When adding new pages, use `bin/test -u` to update test snapshots.