Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Implement Wizards #21

Closed
mitsuhiko opened this issue Sep 21, 2015 · 1 comment
Closed

Implement Wizards #21

mitsuhiko opened this issue Sep 21, 2015 · 1 comment

Comments

@mitsuhiko
Copy link
Member

This is a quick overview issue about the wizard functionality:

What are Wizards?

Wizards are a basic overview of how to configure a client or integration for a sentry project. Just the bare minimums for copy/paste.

Where are Wizards configured?

Wizards are configured in a sentry-doc-config.json file. There can be multiple wizards per such a file and those files can appear in any folder in the documentation tree. The contents are as follows:

{
  // all wizards go here
  "wizards": {
    // the key is the id of the wizard which is how sentry can identify it.
    "python": {
      // the human readable name for this wizard.  This should be the name
      // of the programming language of framework.
      "name": "Python",
      // the most appropriate name of the client lib used
      "client_lib": "raven-python",
      // this is true if the wizard refers to a framework or app rather than a raw client.
      "is_framework": false,
      // the name of the document (can be relative) the documentation should
      // link to.
      "doc_link": "installation",
      // a list of selectors that should be included in the wizard.  This just
      // points to `rst_file#headline_anchor`.
      "snippets": [
        "installation#installation",
        "usage#capture-an-error",
        "usage#reporting-an-event"
      ]
    }
}

How are Wizards build?

The docs build them out automatically. They are then placed in a _wizards folder as JSON file. The server can either load that directly from the docs or we can ship it.

@cameronmcefee
Copy link
Contributor

I presume this is an early draft of what became _platforms

@github-actions github-actions bot locked and limited conversation to collaborators Dec 16, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants