[WIP] feat: New SDK docs

.vscode/settings.json

@@ -0,0 +1,4 @@
+{
+  "editor.trimAutoWhitespace": false,
+  "files.trimTrailingWhitespace": false,
+}

_config.yml

@@ -56,7 +56,11 @@ defaults:
       path: collections/_dev_components/markdown-styleguide/*
     values:
       layout: doc
-
+  - scope:
+      path: collections/_dev_components/markdown-styleguide/*
+    values:
+      layout: doc
+
 assets:
   source_maps: false # Prefer webpack sourcemaps
   plugins:

nginx.conf

@@ -15,6 +15,14 @@ server {
 
   rewrite ^/(?:hosted|on-premise)/(.*)$ /$1$is_args$args redirect;
 
+  location = /clients/rust/ {
+    return 302 /platforms/rust/$is_args$args;
+  }
+
+  location = /clients/minidump/ {
+    return 302 /platforms/minidump/$is_args$args;
+  }
+
   location = /clients/javascript/integrations/angular2/ {
     return 302 /clients/javascript/integrations/angular/$is_args$args;
   }

src/_assets/css/_includes/platform-specific-content.scss

@@ -5,3 +5,20 @@
     display: block;
   }
 }
+
+.unsupported {
+  .unsupported-hint {
+    display: none;
+  }
+}
+
+.unsupported.is-unsupported {
+  opacity: 0.5;
+
+  .unsupported-hint {
+    display: block;
+    font-size: 0.9rem;
+    font-weight: bold;
+    margin-bottom: 0.3rem;
+  }
+}

src/_assets/css/_includes/type.scss

@@ -60,6 +60,12 @@
   }
 }
 
+// Config keys
+h3.config-key {
+  font-family: $font-family-monospace;
+  font-size: 1.3rem;
+}
+
 // Remove the bottom margin from the final direct child.
 //
 // Example:

src/_data/LEGACY_platform_icons.yml

@@ -13,35 +13,6 @@
 - name: React Native
   link: _documentation/clients/react-native/index.md
   platformicon: react
-- name: PHP
-  link: _documentation/clients/php/index.md
-  platformicon: php
-- name: Ruby
-  link: _documentation/clients/ruby/index.md
-  platformicon: ruby
-- name: Cocoa
-  link: _documentation/clients/cocoa/index.md
-  platformicon: apple
-- name: Java
-  link: _documentation/clients/java/index.md
-  platformicon: java
-- name: 'C#'
-  link: _documentation/clients/csharp/index.md
-  platformicon: csharp
-- name: Rust
-  link: _documentation/clients/rust/index.md
-  platformicon: rust
-- name: Go
-  link: _documentation/clients/go/index.md
-  platformicon: go
-- name: Elixir
-  link: _documentation/clients/elixir/index.md
-  platformicon: elixir
 - name: Perl
   link: _documentation/clients/perl/index.md
   platformicon: perl
-- name: Cordova
-  link: _documentation/clients/cordova/index.md
-  platformicon: cordova
-- name: Minidump
-  link: _documentation/clients/minidump/index.md

src/_data/documentation_categories.yml

@@ -7,11 +7,14 @@
   slug: learn
 
 - title: Platforms
-  slug: clients
+  slug: platforms
 
 - title: Integrations
   slug: integrations
 
+- title: Legacy Clients
+  slug: clients
+
 - title: On-Premise
   slug: server
 

src/_data/platform_icons.yml

@@ -0,0 +1,51 @@
+- name: HTML
+  link: _documentation/platforms/javascript/browser.md
+  platformicon: HTML5
+
+- name: JavaScript
+  link: _documentation/platforms/javascript/browser.md
+  platformicon: javascript
+
+- name: Node.js
+  link: _documentation/platforms/javascript/node.md
+  platformicon: nodejs
+
+- name: Vue
+  link: _documentation/platforms/javascript/vue.md
+  platformicon: vue
+
+- name: Angular.js
+  link: _documentation/platforms/javascript/angularjs.md
+  platformicon: angularjs
+
+- name: Ember
+  link: _documentation/platforms/javascript/ember.md
+  platformicon: ember
+
+- name: React
+  link: _documentation/platforms/javascript/react.md
+  platformicon: react
+
+- name: Cordova
+  link: _documentation/platforms/javascript/cordova.md
+  platformicon: cordova
+
+- name: Electron
+  link: _documentation/platforms/javascript/electron.md
+  platformicon: electron
+
+- name: Python
+  link: _documentation/platforms/python/index.md
+  platformicon: python
+
+- name: Django
+  link: _documentation/platforms/python/django.md
+  platformicon: django
+
+- name: Flask
+  link: _documentation/platforms/python/flask.md
+  platformicon: flask
+
+- name: Celery
+  link: _documentation/platforms/python/celery.md
+  platformicon: python

src/_data/platforms.yml

@@ -10,20 +10,36 @@
       support_level: production
       type: language
       name: Node.js
+      # XXX: does this have a better link?
+      doc_link: /platforms/javascript/
+      # this is actually the old wizard
+      wizard: ['_documentation/clients/node/index.md#installation', '_documentation/clients/node/index.md#configuring-the-client', '_documentation/clients/node/index.md#reporting-errors']
+      case_style: camelCase
+      fallback_platform: javascript
+-
+      slug: node-legacy
+      support_level: production
+      type: language
+      name: Node.js
       doc_link: /clients/node/
       wizard: ['_documentation/clients/node/index.md#installation', '_documentation/clients/node/index.md#configuring-the-client', '_documentation/clients/node/index.md#reporting-errors']
+      case_style: camelCase
+      fallback_platform: javascript
+      superseded_by: node
 -
       slug: express
       support_level: production
       type: framework
       name: Express
+      # XXX: this links to the old ones
       doc_link: /clients/node/integrations/express/
       wizard: ['_documentation/clients/node/index.md#installation', _documentation/clients/node/integrations/express.md]
 -
       slug: connect
       support_level: production
       type: framework
       name: Connect
+      # XXX: this links to the old ones
       doc_link: /clients/node/integrations/connect/
       wizard: ['_documentation/clients/node/index.md#installation', _documentation/clients/node/integrations/connect.md]
 -
@@ -33,6 +49,22 @@
       name: Cordova
       doc_link: /clients/cordova/
       wizard: ['_documentation/clients/cordova/index.md#installation', '_documentation/clients/cordova/index.md#configuration']
+      case_style: camelCase
+      fallback_platform: javascript
+-
+      slug: csharp
+      support_level: production
+      type: language
+      name: C#
+      doc_link: /clients/
+      case_style: snake_case
+-
+      slug: aspnetcore
+      support_level: production
+      type: framework
+      name: ASP.NET Core
+      doc_link: /clients/
+      fallback_platform: csharp
 -
       slug: java
       support_level: production
@@ -87,15 +119,27 @@
       support_level: production
       type: language
       name: Python
-      doc_link: /clients/python/
+      doc_link: /platforms/python/
+      # this is actually the old wizard
       wizard: ['_documentation/clients/python/index.md#installation', '_documentation/clients/python/usage.md#capture-an-error', '_documentation/clients/python/usage.md#reporting-an-event']
+      case_style: snake_case
+-
+      slug: python-legacy
+      support_level: production
+      type: language
+      name: Python Legacy
+      doc_link: /clients/python/
+      wizard: []
+      case_style: snake_case
+      superseded_by: python
 -
       slug: pyramid
       support_level: production
       type: framework
       name: Pyramid
       doc_link: /clients/python/integrations/pyramid/
       wizard: ['_documentation/clients/python/index.md#installation', '_documentation/clients/python/integrations/pyramid.md#pastedeploy-filter', '_documentation/clients/python/integrations/pyramid.md#logger-setup']
+      case_style: camelCase
 -
       slug: rq
       support_level: production
@@ -154,15 +198,36 @@
       wizard: ['_documentation/clients/cocoa/index.md#installation', '_documentation/clients/cocoa/index.md#configuration', '_documentation/clients/cocoa/index.md#debug-symbols', '_documentation/clients/cocoa/dsym.md#upload-symbols-with-sentry-cli']
       version: 4.1.0
       version_key: SENTRY_COCOA_TAG
+-
+      slug: browser
+      support_level: production
+      type: language
+      name: Browser Javascript
+      doc_link: /clients/javascript/
+      wizard: []
+      case_style: camelCase
+      fallback_platform: javascript
 -
       slug: javascript
       support_level: production
       type: language
       name: JavaScript
-      doc_link: /clients/javascript/
+      doc_link: /platforms/javascript/
+      # this is actually the old wizard
       wizard: ['_documentation/clients/javascript/index.md#installation', '_documentation/clients/javascript/index.md#configuring-the-client', '_documentation/clients/javascript/index.md#manually-reporting-errors']
+      case_style: camelCase
+      superseded_by: 
+-
+      slug: javascript-legacy
+      support_level: production
+      type: language
+      name: JavaScript
+      doc_link: /clients/javascript/
+      wizard: []
       version: 3.26.4
       version_key: RAVEN_VERSION
+      case_style: camelCase
+      superseded_by: javascript
 -
       slug: vue
       support_level: production
@@ -224,13 +289,16 @@
       name: Electron
       doc_link: /clients/electron/
       wizard: ['_documentation/clients/electron/index.md#installation', '_documentation/clients/electron/index.md#configuring-the-client']
+      case_style: camelCase
+      fallback_platform: javascript
 -
       slug: elixir
       support_level: production
       type: language
       name: Elixir
       doc_link: /clients/elixir/
       wizard: ['_documentation/clients/elixir/index.md#installation', '_documentation/clients/elixir/index.md#configuration', '_documentation/clients/elixir/usage.md#capturing-errors']
+      case_style: PascalCase
 -
       slug: cocoa
       support_level: beta
@@ -248,12 +316,24 @@
       version: 4.1.0
       version_key: SENTRY_COCOA_TAG
 -
+      # XXX: this should probably be dotnet and not csharp
       slug: csharp
+      support_level: production
+      type: language
+      name: 'C#'
+      doc_link: /platforms/dotnet/
+      # this is actually the old wizard
+      wizard: ['_documentation/clients/csharp/index.md#installation', '_documentation/clients/csharp/index.md#capturing-exceptions']
+      case_style: PascalCase
+-
+      slug: csharp-legacy
       support_level: community
       type: language
       name: 'C#'
       doc_link: /clients/csharp/
-      wizard: ['_documentation/clients/csharp/index.md#installation', '_documentation/clients/csharp/index.md#capturing-exceptions']
+      wizard: []
+      case_style: PascalCase
+      superseded_by: csharp
 -
       slug: go
       support_level: in-development
@@ -322,14 +402,15 @@
       support_level: production
       type: language
       name: Rust
-      doc_link: /clients/rust/
-      wizard: ['_documentation/clients/rust/index.md#installation', '_documentation/clients/rust/index.md#configuring-the-client', '_documentation/clients/rust/index.md#reporting-errors', '_documentation/clients/rust/index.md#catching-panics']
+      doc_link: /platforms/rust/
+      wizard: ['_documentation/platforms/rust/index.md#installation', '_documentation/platforms/rust/index.md#configuring-the-client', '_documentation/platforms/rust/index.md#reporting-errors', '_documentation/platforms/rust/index.md#catching-panics']
       version: 0.6.0
       version_key: SENTRY_VERSION
+      case_style: snake_case
 -
       slug: minidump
       support_level: production
       type: language
       name: Minidump
-      doc_link: /clients/minidump/
-      wizard: ['_documentation/clients/minidump/index.md#platform-and-language-support', '_documentation/clients/minidump/index.md#creating-and-uploading-minidumps']
+      doc_link: /platforms/minidump/
+      wizard: ['_documentation/platforms/minidump/index.md#platform-and-language-support', '_documentation/platforms/minidump/index.md#creating-and-uploading-minidumps']

src/_includes/components/config_key.html

@@ -0,0 +1 @@
+<code>{{ include.key }}</code>

src/_includes/components/platform_content.html

@@ -97,7 +97,7 @@
       {% include_relative {{ __relative_path }} %}
       {%- endcapture -%}
       <div class="tab-pane{% if __is_default %} show active{% endif %}" id="{{ __uniq }}-{{ __slug }}" role="tabpanel" aria-labelledby="{{ __uniq }}-{{ __slug }}-tab">
-        {{ __content | liquify | markdownify }}
+        {{ __content | markdownify }}
       </div>
     {%- endfor -%}
   </div>

src/_includes/head.html

@@ -35,8 +35,10 @@
 <link rel="canonical" href="{{ page.url | site.url | replace:'index.html',''}}">
 
 <script>
-  window.loadIfTrackersOk=[];
-  window.supportedPlatforms={{ site.data.platforms | map: "slug" | jsonify }}
+  window.loadIfTrackersOk = [];
+  window.activePlatform = null;
+  window.supportedPlatforms = {{ site.data.platforms | map: "slug" | jsonify }};
+  window.platformData = {{ site.data.platforms | map_select: "slug,name,case_style,fallback_platform" | make_map_by: "slug" | jsonify }};
 </script>
 
 {% asset screen.css %}