diff --git a/.github/ISSUE_TEMPLATE/bug-report---.md b/.github/ISSUE_TEMPLATE/bug-report---.md index 1ddc80be2..311aad12f 100644 --- a/.github/ISSUE_TEMPLATE/bug-report---.md +++ b/.github/ISSUE_TEMPLATE/bug-report---.md @@ -1,10 +1,9 @@ --- -name: "Bug report \U0001F41B" +name: "Bug report \U0001F41B" about: 'Report a bug or defect!' title: This is a bug please fix! labels: bug assignees: '' - --- ### Description + A clear and concise description of what the bug is. ### Steps to reproduce + 1. Go to '...' 2. Click on '....' 3. Scroll down to '....' 4. See error ### Expected behavior + A clear and concise description of what you expected to happen. ### Screenshots + If applicable, add screenshots to help explain your problem. ### Additional context + Add any other context about the problem here. ### Environment diff --git a/.github/ISSUE_TEMPLATE/documentation-issue.md b/.github/ISSUE_TEMPLATE/documentation-issue.md deleted file mode 100644 index f781464bd..000000000 --- a/.github/ISSUE_TEMPLATE/documentation-issue.md +++ /dev/null @@ -1,41 +0,0 @@ ---- -name: "Documentation issue \U0001F4DC" -about: Report a documentation issue! -title: This is a documentation problem! -labels: documentation -assignees: '' - ---- - - - -### Summary - -What problem(s) did you see in our documentation? Please be explicit. - -### Screenshots -If applicable, add screenshots to help explain your problem. - -### Additional context -Add any other context about the problem here. - -### Improving the documentation - -If you are interested in helping us fixing this documentation please let us know. -We encourage community contributions and can more quickly move your idea to publication if you suggest changes, or create an outline or rough draft. We'll collaborate with you to hone whatever content you provide. - diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 7d984c2e2..2dfceeddb 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -4,22 +4,25 @@ about: Suggest an enhancement! title: 'This is an enhancement request!' labels: enhancement assignees: '' - --- -### Is your feature request related to a problem? Please describe. +### Is your feature request related to a problem? Please describe + A clear and concise description of what the problem is. ### Describe the solution you'd like + A clear and concise description of what you want to happen. What is the expected outcome? ### Describe why this important to you -Why should we work on this? What use cases does it support? + +Why should we work on this? What use cases does it support? ### Additional context + Add any other context or screenshots about the feature request here. diff --git a/README.md b/README.md index 4e258353b..206684442 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +[![Community Project header](https://github.com/newrelic/open-source-office/raw/master/examples/categories/images/Community_Project.png)](https://github.com/newrelic/open-source-office/blob/master/examples/categories/index.md#category-community-project) + # developer.newrelic.com ## 🚀 Local development diff --git a/STYLE_GUIDE.md b/STYLE_GUIDE.md index cf9786ac6..2de8aca86 100644 --- a/STYLE_GUIDE.md +++ b/STYLE_GUIDE.md @@ -284,8 +284,11 @@ The value that is assigned to the key slug is used in order to navigate to your easier for users to discover - `tileShorthand` (optional): config for guides when they appear as tiles. Accepts 2 options: - `title`: provide a shortened title for the tile. The title will fallback to the guide title if this is not provided. - - `description`: provide a shortended description for the tile. The description will + - `description`: provide a shortened description for the tile. The description will fallback to the guide description if this is not provided. +- `redirects`: + - url you wish to redirect from + - another url you wish to redirect from ### GuideTemplate Frontmatter example @@ -300,6 +303,9 @@ promote: true tileShorthand: title: Add a time picker description: Add the time picker to a sample app to specify a time range in data +redirects: + - /build-tools/new-relic-one-applications/intro-to-sdk + - /client-side-sdk/index.html --- ``` diff --git a/src/components/NewRelicIcon.js b/src/components/NewRelicIcon.js index 995bd73ec..f916e6830 100644 --- a/src/components/NewRelicIcon.js +++ b/src/components/NewRelicIcon.js @@ -41,9 +41,10 @@ const NEWRELIC_ICONS = { ), buildApps: ( <> - - - + + + + ), collectData: ( diff --git a/src/components/Seo.js b/src/components/Seo.js index 30170ade6..8a9ff885f 100644 --- a/src/components/Seo.js +++ b/src/components/Seo.js @@ -30,6 +30,10 @@ function SEO({ description, lang, meta, title }) { 'data-type': 'enum', content: 'developer', }, + { + name: 'google-site-verification', + content: 'eT8TSNhvMuDmAtqbtq5jygZKVkhDmz565fYQ3DVop4g', + }, ]; const social = [ diff --git a/src/markdown-pages/explore-docs/intro-to-sdk.mdx b/src/markdown-pages/explore-docs/intro-to-sdk.mdx index 48494d981..09db9d046 100644 --- a/src/markdown-pages/explore-docs/intro-to-sdk.mdx +++ b/src/markdown-pages/explore-docs/intro-to-sdk.mdx @@ -8,12 +8,13 @@ tileShorthand: description: 'Reference for all New Relic One components' redirects: - /build-tools/new-relic-one-applications/intro-to-sdk + - /client-side-sdk/index --- To help you build a New Relic One application we provide you with the New Relic One SDK. -Here we give you an introduction to the types of API calls and components in the SDK. The SDK provides everything you need to build your Nerdlets, create visualizations, and fetch data (New Relic or third-party). +Here we give you an introduction to the types of API calls and components in the SDK. The SDK provides everything you need to build your Nerdlets, create visualizations, and fetch data (New Relic or third-party). @@ -34,23 +35,23 @@ The **UI components** category of the SDK contains React UI components, includin - **Layout components**: These components give you control over the layout, and help you build complex layout designs without having to deal with the CSS. Layout components include: - - [`Grid`](../components/grid) + - [`Grid`](../components/grid) and [`GridItem`:](../components/grid-item) for organizing more complex, larger scale page content in rows and columns - - [`Stack`](../components/stack) + - [`Stack`](../components/stack) and [`StackItem`](../components/stack-item): for organizing simpler, smaller scale page content (in column or row) - - [`Tabs`](../components/tabs) + - [`Tabs`](../components/tabs) and [`TabsItem`](../components/tabs-item): group various related pieces of content into separate hideable sections - - [`List`](../components/list) + - [`List`](../components/list) and [`ListItem`](../components/list-item): for providing a basic skeleton of virtualized lists - - [`Card`](../components/card), + - [`Card`](../components/card), [`CardHeader`](../components/card-header) and [`CardBody`](../components/card-body) : used to group similar concepts and tasks together @@ -61,8 +62,8 @@ The **UI components** category of the SDK contains React UI components, includin - **Overlaid components**: These components are used to display contextual information and options in the form of an additional child view that appears above other content on screen when an action or event is triggered. They can either require user interaction (like modals), or be augmenting (like a tooltip). These include: [`Modal`](../components/modal) and [`Tooltip`](../components/tooltip). > Components suffixed with `Item` can only operate as direct children of that -name without the suffix. For example: [`GridItem`](../components/grid-item) -should only be found as a child of [`Grid`](../components/grid). +> name without the suffix. For example: [`GridItem`](../components/grid-item) +> should only be found as a child of [`Grid`](../components/grid). ### Chart components @@ -83,13 +84,13 @@ We also provide storage for storing small data sets, such as configuration setti The Platform API components of the New Relic One SDK enable your application to interact with different parts of the New Relic One platform, by reading and writing state from and to the URL, setting the configuration, etc. They can be divided into these categories: -- [`PlatformStateContext`](../components/platform-state-context): provides read access to the platform URL state variables. -Example: `timeRange` in the time picker. -- [`navigation`](../api/navigation): an object that allows programmatic manipulation of the navigation -in New Relic One. Example: opening a new Nerdlet. -- [`NerdletStateContext`](..components/nerdlet-state-context): provides read access to the Nerdlet URL state variables. -Example: an `entityGuid` in the [entity explorer](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/ui-data/new-relic-one-entity-explorer-view-performance-across-apps-services-hosts). -- [`nerdlet`](../api/navigation): an object that provides write access to the Nerdlet URL state. +- [`PlatformStateContext`](../components/platform-state-context): provides read access to the platform URL state variables. + Example: `timeRange` in the time picker. +- [`navigation`](../api/navigation): an object that allows programmatic manipulation of the navigation + in New Relic One. Example: opening a new Nerdlet. +- [`NerdletStateContext`](..components/nerdlet-state-context): provides read access to the Nerdlet URL state variables. + Example: an `entityGuid` in the [entity explorer](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/ui-data/new-relic-one-entity-explorer-view-performance-across-apps-services-hosts). +- [`nerdlet`](../api/navigation): an object that provides write access to the Nerdlet URL state. ## Related info