RubyGems - station - Versions diffs - 0.0.0 → 0.0.93 - Mend

station 0.0.0 → 0.0.93

Files changed (619) hide show

data/lib/nexmo_developer/app/views/contribute/guides/markdown-guide.md ADDED

@@ -0,0 +1,420 @@
+---
+title: Markdown Guide
+navigation_weight: 3
+---
+⚓ Anchor Example
+# Markdown Guide
+Here is a complete overview of the basic markdown and custom plugins that Nexmo Developer supports.
+We use plugins sparingly to extend functionality where the only other option would be HTML.
+You can find this document in `/app/views/contribute/guides/markdown-guide.md`. The side navigation has been left present to be an accurate representation of the content width.
+There is no markdown syntax in here as this document is rendered with the same engine and no support exists for escaping Markdown. Examples would ultimately be rendered. To understand recursion you must first understand recursion.
+## Metadata
+The first part of a Markdown file includes metadata similar to the following:
+```
+---
+title: Markdown Guide
+navigation_weight: 3
+---
+```
+The purpose of the metadata is to provide useful information in the following areas:
+* Algolia search results (that is when you search in NDP)
+* Google (and other external search engine) search results
+* Information for the navbar (also sometimes called the table of contents or TOC)
+The meta data items that can be used are described in the following table:
+Metadata | HTML generated | Description
+----|----|----
+`title` | N/A | This is the title for the topic that will be displayed in the navbar. This main be different to that display at the top of the topic. It is displayed in the Algolia search results when you search NDP.
+`description` | N/A | This is the short description for the topic. It is displayed in the Algolia search results when you search NDP. It should indicate the nature of the content of the topic.
+`meta_title` | `<head><title>The title</title>...</head>` | Used for SEO in external search engine results. This should be more descriptive than the `title` to provide additional context in the absence of the navbar. [Further reading](https://moz.com/learn/seo/title-tag).
+`meta_description` | `<head><meta name="description" content="The description">...</head>` | Used in external search engine results. Provides SEO. Should be no more than 160 characters. [Further reading](https://moz.com/learn/seo/meta-description).
+`navigation_weight` | N/A | A hint to position the topic in the navbar where a particular position is preferred. The lower the number used the higher in the navbar the item will appear. Overrides information defined in `config/navigation.yml`. In most cases you only need to add a `navigation_weight` item if your topic is not automatically displayed in your preferred position in the navbar.
+### Example
+The following shows an example of metadata use:
+```
+---
+title: Overview
+description: An overview of the Vonage Voice API.
+meta_title: Text-To-Speech, IVR, Call Recording and more with the Vonage Voice API.
+meta_description: The Vonage Voice API is the easiest way to build high-quality voice applications in the Cloud.
+navigation_weight: 1
+---
+```
+### Writing an effective `title`
+When using `title` bear in mind that while something like "Overview" may be fine for the navbar (as the navbar provides positional context), that would not be very informative in the title of a search result. Sometimes you would see `title` as Overview, but supplement that with a `meta_title` of "Vonage Voice API Overview" for clarity in external search engine search results.
+Ideally task (step) or other active topics should include a gerund. For example:
+* Installing the Vonage Command Line Interface (CLI)
+Topics providing reference information would have a noun-based title, for example:
+* The Conversation object
+To provide greater context in external search results a corresponding `meta_title` might contain much more specific information, for example:
+* The Vonage Conversation API Conversation object
+### Writing an effective `description`
+`description` is used in search results when you search on NDP. The description should be written to give the user a clear idea of the purpose on the topic, as in many cases it will not be possible to determine the content of a topic from `title` alone.
+### Writing an effective `meta_title`
+This appears in external search engine results. While navbar titles such as "Overview" might be fine for the navbar (as the navbar provides positional context) this would not be very information in search engine results. `meta_title` could then be set to something that clearly indicates the content of the topic in the external search engine context. You can read more information about how `meta_title` is leveraged by search engines on [this page](https://moz.com/learn/seo/meta-title).
+### Writing an effective `meta_description`
+`meta_description` is used by external search engines. It provide SEO for external engines. It is an opportunity to create an information description containing important key words. You can read more information about how `meta_description` is leveraged by search engines on [this page](https://moz.com/learn/seo/meta-description).
+## Typography
+**Headings**
+# I am a H1
+## I am a H2
+### I am a H3
+> Custom extension: Headings have their own slugified ID's for deep linking. For example the `h1` has an ID of `i-am-a-h1`
+**Paragraphs**
+Duis mollis, est non commodo luctus, nisi erat porttitor ligula, eget lacinia odio sem nec elit. Cras mattis consectetur purus sit amet fermentum. Donec id elit non mi porta gravida at [eget metus](#). Vestibulum id ligula porta felis euismod semper. Donec id elit non mi porta gravida at eget metus. Cras mattis consectetur purus sit amet fermentum. Sed posuere consectetur est at lobortis.
+**Inline styles**
+Text can be **bold**, *italic* or ***bold and italic***. You could use ~~strikethrough~~ but please don't.
+You can define inline `code block` with backticks.
+This is a [link](http://google.com) to Google.
+> **Note**: You can use a `>` to specify a blockquote. We use these for tips like this.
+**Labels**
+You can have [labels].
+They auto-magically color when you use verbs like [POST] or [DELETE]
+**Collapsible Content (custom plugin)**
+| ### Click me
+|
+| Here is some hidden content.
+|
+| Markdown _still_ works `here`!
+|
+| Nullam id dolor id nibh ultricies vehicula ut id elit. Donec ullamcorper nulla non metus auctor fringilla. Fusce dapibus, tellus ac cursus commodo, tortor mauris condimentum nibh, ut fermentum massa justo sit amet risus.
+| ### Alpha
+|
+| Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Sed posuere consectetur est at lobortis. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Donec ullamcorper nulla non metus auctor fringilla.
+|
+| Donec id elit non mi porta gravida at eget metus. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Nulla vitae elit libero, a pharetra augue. Donec sed odio dui. Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Cras mattis consectetur purus sit amet fermentum.
+|
+| Vivamus sagittis lacus vel augue laoreet rutrum faucibus dolor auctor. Donec id elit non mi porta gravida at eget metus. Lorem ipsum dolor sit amet, consectetur adipiscing elit. Nulla vitae elit libero, a pharetra augue. Praesent commodo cursus magna, vel scelerisque nisl consectetur et. Aenean lacinia bibendum nulla sed consectetur. Nullam quis risus eget urna mollis ornare vel eu leo.
+**Tooltips (custom plugin)**
+Find out ^[more](Tooltips are useful for when you have more information to convey, but don't want to break context.).
+## Images
+![Please always add alt-text](https://media.giphy.com/media/pDTLSpqNvNxlu/giphy.gif)
+> Images should be used sparingly, try to avoid using screenshots that might go out of date.
+>
+> Also... Please ALWAYS write descriptive alt text.
+## Lists
+**Unordered Lists**
+> List items have `*` in front of them.
+>
+> Indentations are 4 spaces.
+* Alpha
+* Bravo
+    * Charlie
+    * Delta
+        * Echo
+    * Foxtrot
+* Golf
+**Ordered Lists**
+> List items have `1.`, `2.`, `3.` etc in front of them.
+>
+> Indentations are 4 spaces.
+1. One
+2. Two
+    1. Three
+    2. Four
+        1. Five
+    1. Six
+3. Seven
+## Code
+See our detailed [code examples guide](/contribute/guides/code-examples) for advice on including code.
+## Tables
+> Pipes should only be between cells. Two hyphens `--` should be used to 'underline' the headings.
+>
+> You'll have to view the `markdown-guide.md` source to see how since showing you the syntax would result in it being processed.
+Key | Description
+-- | --
+`TO_NUMBER` | The number you are sending the SMS to
+`API_KEY` | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview)
+`API_SECRET` | You can find this in your [account overview](https://dashboard.nexmo.com/account-overview)
+## Tabbed Content (custom plugin)
+To use the tabbed content block, add a section like this to your markdown to point out where the directory holding the examples is:
+````
+```tabbed_content
+source: '/_examples/styleguide/tabbed-content'
+```
+````
+Each file becomes a tab, as you can see:
+```tabbed_content
+source: '/_examples/styleguide/tabbed-content'
+```
+## Tabbed folder (custom plugin)
+Tabbed folders provide a convenient method for automatically tabbing a collection of content contained in a folder.
+You can create tabbed content using a tabbed folder configuration file, along with the content to be tabbed, all organized in the same folder. You would create a configuration file, `.config.yml`, in the folder, and then create the markdown documents to be tabbed in the same folder.
+You can see an example of what this looks like [here](/client-sdk/setup/add-sdk-to-your-app).
+Config file, `.config.yml`, would contain metadata such as the following:
+```
+---
+title: Add Client SDK to your application
+description: How to add the Client SDK to your application.
+navigation_weight: 2
+tabbed: true
+---
+```
+Note that `tabbed` is set to `true` for tabbed folder content.
+Example files can be found in the folder `_documentation/en/client-sdk/setup/add-sdk-to-your-app`:
+* `.config.yml`
+* `android.md`
+* `ios.md`
+* `javascript.md`
+The rendered output can be found [here](/client-sdk/setup/add-sdk-to-your-app/javascript).
+## Mermaid (custom plugin)
+You can use any [Mermaid](https://mermaidjs.github.io/) diagram using the `mermaid` filter.
+````
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+````
+Creates a diagram like this:
+```mermaid
+graph TD;
+    A-->B;
+    A-->C;
+    B-->D;
+    C-->D;
+```
+Some common diagrams e.g. sequence diagrams may have specific extensions, so keep reading!
+## Sequence Diagram (custom plugin, using Mermaid)
+Our sequence diagrams are simple markup that is rendered to a graphical representation by a custom plugin. Starting with code like this:
+````
+```sequence_diagram
+Andrew->China: Says Hello
+Note right of China: China thinks\nabout it
+China-->Andrew: How are you?
+Andrew->>China: I am good thanks!
+```
+````
+Creates the following diagram:
+```sequence_diagram
+Andrew->China: Says Hello
+Note right of China: China thinks\nabout it
+China-->Andrew: How are you?
+Andrew->>China: I am good thanks!
+```
+## Languages (custom plugin)
+Inline [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag) support, using both primary language tags and subtags, is provided using the following syntax.
+Language | Key | Text
+-- | -- | --
+English | none | Hello World
+Spanish | `es` | [Hola Mundo](lang: 'es')
+French | `fr` | [Bonjour le monde](lang: 'fr')
+Brazilian Portuguese | `pt-BR` | [Olá Mundo](lang: 'pt-BR')
+Hebrew | `il` | [שלום עולם](lang: 'il')
+## Anchors (custom plugin)
+Adding custom anchors and retaining support for old headings can be done as such:
+````
+⚓ This is the old heading
+````
+This would produce the following HTML:
+```html
+<a name="this-is-the-old-heading"></a>
+```
+If you are adding support for a changed header this would normally go above the old heading as such:
+````
+⚓ Send with Short Message Service
+⚓ Send with SMS
+# Sending an SMS
+````
+### Example
+[Go to the anchor](#anchor-example). I've placed at the top of this document.
+## Screenshots
+Webpage screenshots can be scripted so that they only require sourcing once. Define a screenshot as such:
+````
+```screenshot
+script: app/screenshots/webhook-url-for-delivery-receipt.js
+```
+````
+Run the following command:
+```
+$ rake screenshots:new
+```
+This changes the original source document to add an `image` value pointing to the screenshot:
+````
+```screenshot
+script: app/screenshots/webhook-url-for-delivery-receipt.js
+image: public/assets/screenshots/da5f952d465355c19eb888fa1049844b31e090c2.png
+```
+````
+You can also update all examples by running the following command:
+```
+$ rake screenshots:all
+```
+Here is the example of the final rendered output:
+```screenshot
+script: app/screenshots/webhook-url-for-delivery-receipt.js
+image: public/assets/screenshots/da5f952d465355c19eb888fa1049844b31e090c2.png
+```
+## Audio (custom plugin)
+The HTML `<audio>` element can be utilised in Markdown with the following syntax:
+````
+🔈[https://developer.nexmo.com.s3.amazonaws.com/assets/ssml/06-phonemes.mp3]
+````
+This produces the following output:
+🔈[https://developer.nexmo.com.s3.amazonaws.com/assets/ssml/06-phonemes.mp3]
+## Dynamic content
+You can use syntax such as:
+````
+Welcome to [~dynamic_content_example~]
+````
+This will render as:
+Welcome to [~dynamic_content_example~]
+## Concept list (custom plugin)
+If you need to produce a list of concepts (also known as guides) on a page, you can specify a product and have it render an unstyled `<ul>`
+````
+```concept_list
+product: voice/voice-api
+```
+````
+This produces the following output:
+```concept_list
+product: voice/voice-api
+```
+Alternatively, you can specify the concepts to list manually if you need to show a subset of concepts, or concepts from multiple different products:
+````
+```concept_list
+concepts:
+  - voice/voice-api/call-flow
+  - messaging/sms/delivery-receipts
+```
+````
+This produces the following output:
+```concept_list
+concepts:
+  - voice/voice-api/call-flow
+  - messaging/sms/delivery-receipts
+```

data/lib/nexmo_developer/app/views/contribute/guides/platform.md ADDED

@@ -0,0 +1,220 @@
+---
+title: Platform
+navigation_weight: 7
+---
+# Platform
+This document provides some insight into the inner-workings of Nexmo Developer as platform and where various resources can be found.
+## Contents
+- [Contents](#contents)
+- [Icons](#icons)
+- [Navigation Text](#navigation-text)
+- [Pages and content](#pages-and-content)
+- [OpenAPI Pages](#openapi-pages)
+- [Admin](#admin)
+- [Search](#search)
+- [Non-Markdown pages](#non-markdown-pages)
+- [Team listing](#team-listing)
+- [Markdown Pipeline](#markdown-pipeline)
+  - [Filters](#filters)
+- [Webpack](#webpack)
+- [Hosting](#hosting)
+- [Redirects](#redirects)
+- [Notices](#notices)
+  - [Site wide](#site-wide)
+  - [Section Specific (non-dismissible)](#section-specific-non-dismissible)
+- [Code Examples](#code-examples)
+## Icons
+Icons are turned into fonts using a tool called [Icomoon](https://icomoon.io/app/).
+We use a mixture of custom icons and ones made available by the packs, a backup file should be maintained so that icons can be added, removed and edited by anybody. You can find the most recent backup file at `/app/assets/fonts/nexmo-developer.json`.
+## Navigation Text
+The navigation is generated from the file structure of the `/_documentation` folder. The documents get their titles from the front-matter within the Markdown files themselves for example the file at `/_documentation/messaging/sms/code-snippets/send-an-sms.md` has the following front-matter:
+```
+---
+title: Send an SMS
+navigation_weight: 1
+---
+```
+The `title` is used for both the meta `<title>` and also the navigation text.
+The `navigation_weight` is used to force the order of the page within the navigation in relation to its siblings. By default pages are ordered Alphabetically by giving pages weights this default can be overridden.
+Folders however don't have any document that could provide front-matter so these care configured by a configuration YAML documents:
+Document | Description
+--- | ---
+`/config/locales/en.yml` | This file translates the directory name into the display name. For example `in-app-messaging` to `In-app Messaging`.
+`/config/navigation.yml` | This file provides the `navigation_weight` for directories so that products or content types can be placed in a defined order.
+> **NOTE**: Complex ordering or navigation items that share a display name.
+>
+> §
+>
+> The ordering is a flat lookup of the name. This can cause issues if two different orderings are required relating to two or more menu items with the same name. An example of this is that at the time of writing this Concepts sits as the very first and top-most element. If a product was to need a concepts section this would be forced to the top the product tree since they would both share a common name.
+>
+> §
+>
+> Although this specific issue hasn't been addressed some work has been made towards having a tree based overrides, this could allow an individual item to be overridden by specifying it's location within the document hirearchy. You can see the start of this work under `navigation_overrides` within the `/config/navigation.yml` file.
+## Pages and content
+Documentation pages can be created by creating a new Markdown file for the content within the `/_documentation` directory hierarchy. For existing products adding the file is sufficient enough to create new content. To create documentation for new products however requires a small update to the `DocumentationConstraint`.
+You can find this at `/app/constraints/documentation_constraint.rb`. The `product` and `product_with_parent` methods supply a hash of constraints back to the router so that context can be inferred by the application. Any new products should be added to this list.
+<a name="open-api-pages" />
+## OpenAPI Pages
+API pages use a custom OpenAPI parser and renderer. The parser belongs to a separate dependency you can find at [https://github.com/nexmo/oas_parser](https://github.com/nexmo/oas_parser). The rendering is provided by views that can be found at `/app/views/open_api/`.
+Each of the OpenAPI pages consumes an OpenAPI Specification 3 definition for that API. These are held in a separate repo <https://github.com/Nexmo/api-specification> and are brought into NDP as a git submodule.
+The parser has been built in such a way that it has tested against several OAS definitions however full compatibility with the specification shouldn't be assumed and development work may be required to support new features as they are authored within our definitions.
+## Admin
+Our Admin panel uses a framework called [Active Admin](https://github.com/activeadmin/activeadmin). It is used to manage:
+- Events
+- Job listings
+- Feedback
+  - Authors
+  - Resources
+  - Feedbacks
+- Admin Users
+You should refer to the [Active Admin Docs](https://activeadmin.info/documentation.html) for any information regarding customisation.
+## Search
+Our search is powered by [Algolia](https://www.algolia.com/). There are indices for development, staging (including review apps) and production.
+The indices are automatically refreshed on each deployment by the `refresh` Rake task. There are three Rake tasks available for performing search actions:
+```
+rake search_terms:algolia:clear         # Clear the index in Algolia
+rake search_terms:algolia:generate      # Publish search terms to Algolia
+rake search_terms:algolia:refresh       # Refresh the Algolia index
+```
+Searching is performed directly from the client to Algolia. Protected resources such as restricting the indices or filtering items from the knowlegebase are handled by using [Algolia's Secured API Keys](https://www.algolia.com/doc/tutorials/security/api-keys/secured-api-keys/how-to-restrict-the-search-to-a-subset-of-records-belonging-to-a-specific-user/) functionality.
+The configuration object that configures the secured API key can be found in the `ALGOLIA_CONFIG` environment variable or for easier local development the `/config/algolia.yml.example` file can be renamed to `/config/algolia.yml`.
+## Non-Markdown pages
+Some pages including the landing, tools and community pages are not Markdown pages since they usually have more complicated layouts or database concerns.
+Many of these are handled by the `StaticController`, however you can find out which controller and action is handling a particular page by running:
+```
+$ rails routes
+```
+## Team listing
+The [team page](/team) lists members that are defined in the `/config/team.yml` file. Avatars are pulled from [Gravatar](http://en.gravatar.com/) giving individuals an easy way to choose their image. Lastly, the role defaults to `Developer Advocate` unless provided within the configuration.
+> **Tip**: Getting new hires to add themselves onto the team page is a great way to get them setup with the basics of Nexmo Developer, process and to become familiar with deployments.
+## Markdown Pipeline
+Nexmo Developer has a powerful Markdown pipeline that adds additional support to Markdown providing some tools that support technical writing.
+Here is a video to help explain this concept starts at 6 minutes, 58 seconds:
+<iframe width="854" height="480" src="https://www.youtube.com/embed/AnvqMb1VT40?t=456" frameborder="0" allow="autoplay; encrypted-media" allowfullscreen></iframe>
+### Filters
+Here is a quick explanation of all of the filters:
+Filter | Current User Context | Type | Description
+--- | --- | --- | ---
+Frontmatter | No | [Implicit] | Strips frontmatter from documents
+PHPInliner | No | [Implicit] | Fixes a quirk with our code parser that requires PHP code to have `<?php` at the start. This filter adds an option onto PHP code examples that makes this not required.
+InlineEscape | No | [Extended] | Allows for escaping of inline code where normally the internals would be processes by the markdown. For example this isn't turned into a ``[label]`` when surrounded by two backticks.
+BlockEscape | No | [Extended] | Allows for escaping of code fences where normally the internals would be processes by the markdown.
+Screenshot | No | [Plugin] | Allows for screenshots be put into documentation that are captured by a headless browser so they can be easily refreshed.
+Anchor | No | [Extended] | Useful for when a title changes, an explicit anchor can be added and renders a non-visible anchor link to the same content.
+Audio | No | [Extended] | Used to embed audio examples using the `<audio>` element.
+Tooltip | No | [Extended] | Allows for ^[Toolips](Hello world!) to be added with a markdown-style syntax.
+Collapsible | No | [Extended] | Allows for collapsible and expandable content to be added with a markdown-style syntax.
+TabbedExamplesFilter | Yes | [Plugin] | Pulls in code examples into multiple tabs.
+TabbedContentFilter | Yes | [Plugin] | Renders markdown files into multiple tabs.
+Code | No | [Plugin] | Allows for code to be pulled in as a partial.
+Indent | No | [Extended] | Adds an indentation to text with a markdown-style syntax.
+Modal | No | [Extended] | Adds a link that launches a modal loaded from another markdown file by using a markdown-style syntax.
+JsSequenceDiagram | No | [Extended] | Adds [JS Sequence Diagrams](https://bramp.github.io/js-sequence-diagrams/) rendering in Markdown.
+Partial | No | [Plugin] | Pull in another markdown file. Good for content reuse.
+Techio | No | [Extended] | Pull in a [Tech.io](https://tech.io) playground widget into the document.
+Tutorials | No | [Plugin] | Pull in cars linking to tutorials into the markdown document.
+Language | No | [Extended] | Wraps content into a span with a `lang` attribute by using a markdown-style syntax.
+Columns | No | [Extended] | Allows for basic column layout  by using a markdown-style syntax.
+Markdown | No | - | Converts markdown to HTML
+UserPersonalizationFilter | Yes | [Implicit] | Replaces specific keywords with a logged in users values. Can be used to inject credentials into code examples
+Heading | No | [Implicit] | Automatically adds parameterized id to heading items avoiding conflicts.
+Label | No | [Extended] | Adds support for [labels] by using square brackets as such ``[labels]``.
+Break | No | [Extended] | Allows for breaks to be added using the ``§`` symbol. Great for § adding § new § lines § where it would normally be difficult in markdown such as in tables.
+Unfreeze | No | [Implicit] | Supports several other filters that Base64 their output to prevent manipulation by other filters especially the MarkdownFilter from changing any further.
+Icon | No | [Implicit] | Changes emoji into nice icons.
+ExternalLink | No | [Implicit] | Automatically adds an icon and `target="blank"` to links that go off-site such as [Google](https://google.com).
+## Webpack
+We use [Webpacker](https://github.com/rails/webpacker) to handle JavaScript in webpack with Ruby on Rails. We use the React integration with this tool.
+The JavaScript file that is loaded can be found at `/app/javascript/packs/application.js`.
+Any further information on how to consume or configure this can be found in [Webpacker Usage Guide](https://github.com/rails/webpacker#usage)
+## Hosting
+Nexmo Developer is hosted on Heroku which auto-deploys any changes to the `master` branch on the [public repo](https://github.com/nexmo/nexmo-developer).
+The EA site automatically deploys from the `private/ea` branch on the [private repo](https://github.com/nexmo/nexmo-developer-private).
+Review apps can be created from the Heroku Dashboard, auto-deployment should not be enabled since it could cause a security concern if an outside authors code that dumps `ENV` variables to HTML or externally.
+## Redirects
+When a documentation page is not found the `Redirector` service is invoked to see if a redirection can be found. If it can it issues a redirection to the client otherwise the `404 Not Found` page is rendered.
+## Notices
+Notices can be added site-wide or on specific routes. Here are examples of implementing this:
+### Site wide
+```yaml
+some-unique-id:
+  content: |-
+    <h4>Welcome to Nexmo Developer</h4>
+    <p>We are improving our Documentation, API references, learning resources & tooling to help you more effectively use our services. We want to help you find everything you need to integrate Nexmo APIs into your code.</p>
+    <p>As we start this transition, we’d love to hear from you with thoughts & suggestions. If you’ve got something, positive or negative, to tell us, please tell us using the feedback tool at the bottom of each guide or <a href="https://github.com/Nexmo/nexmo-developer/issues/new">file an issue</a> on GitHub. - Nexmo</p>
+```
+### Section Specific (non-dismissible)
+```yaml
+another-inique-id:
+  dismissible: false
+  path: '^\/(api\/)?new-product'
+  content: |-
+    <h4>Welcome to the Developer Preview for New Product</h4>
+    <p>If you are interested in participating, have any questions, or feedback you can email us at <a href="mailto:support@nexmo.com">support@nexmo.com</a>.</p>
+```
+## Code Examples
+Code examples are often pulled in from other repositories using submodules - refer to the project `README` for more information.