Merge branch 'master' into cayla/various-search-bugs

newrelic · Jun 25, 2020 · 637f696 · 637f696
2 parents a9a97c9 + 5fb7854
commit 637f696
Show file tree

Hide file tree

Showing 28 changed files with 987 additions and 62 deletions.
diff --git a/CLA.md b/CLA.md
@@ -0,0 +1,19 @@
+# NEW RELIC, INC
+
+## INDIVIDUAL CONTRIBUTOR LICENSE AGREEMENT
+
+Thank you for your interest in contributing to the open source projects of New Relic, Inc. (“New Relic”). In order to clarify the intellectual property license granted with Contributions from any person or entity, New Relic must have a Contributor License Agreement ("Agreement") on file that has been signed by each Contributor, indicating agreement to the license terms below. This Agreement is for your protection as a Contributor as well as the protection of New Relic; it does not change your rights to use your own Contributions for any other purpose.
+
+You accept and agree to the following terms and conditions for Your present and future Contributions submitted to New Relic. Except for the licenses granted herein to New Relic and recipients of software distributed by New Relic, You reserve all right, title, and interest in and to Your Contributions.
+
+## Definitions
+
+1. "You" (or "Your") shall mean the copyright owner or legal entity authorized by the copyright owner that is entering into this Agreement with New Relic. For legal entities, the entity making a Contribution and all other entities that control, are controlled by, or are under common control with that entity are considered to be a single Contributor. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity.
+2. "Contribution" shall mean any original work of authorship, including any modifications or additions to an existing work, that is intentionally submitted by You to New Relic for inclusion in, or documentation of, any of the products managed or maintained by New Relic (the "Work"). For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to New Relic or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, New Relic for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by You as "Not a Contribution."
+3. Grant of Copyright License. Subject to the terms and conditions of this Agreement, You hereby grant to New Relic and to recipients of software distributed by New Relic a perpetual, worldwide, non-exclusive, no-charge, royalty-free, transferable, irrevocable copyright license to reproduce, prepare derivative works of, publicly display, publicly perform, sublicense, and distribute Your Contributions and such derivative works.
+4. Grant of Patent License. Subject to the terms and conditions of this Agreement, You hereby grant to New Relic and to recipients of software distributed by New Relic a perpetual, worldwide, non-exclusive, no-charge, royalty-free, transferable, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by You that are necessarily infringed by Your Contributions alone or by combination of Your Contribution(s) with the Work to which such Contribution(s) was submitted. If any entity institutes patent litigation against You or any other entity (including a cross-claim or counterclaim in a lawsuit) alleging that Your Contribution, or the Work to which You have contributed, constitutes direct or contributory patent infringement, then any patent licenses granted to that entity under this Agreement for that Contribution or Work shall terminate as of the date such litigation is filed.
+5. You represent that You are legally entitled to grant the above licenses. If Your employer(s) has rights to intellectual property that You create that includes Your Contributions, You represent that You have received permission to make Contributions on behalf of that employer, that Your employer has waived such rights for Your Contributions to New Relic, or that Your employer has executed a separate Agreement with New Relic.
+6. You represent that each of Your Contributions is Your original creation (see section 7 for submissions on behalf of others). You represent that Your Contribution submissions include complete details of any third-party license or other restriction (including, but not limited to, related patents and trademarks) of which You are personally aware and which are associated with any part of Your Contributions.
+7. You are not expected to provide support for Your Contributions, except to the extent You desire to provide support. You may provide support for free, for a fee, or not at all. Unless required by applicable law or agreed to in writing, You provide Your Contributions on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON- INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE.
+8. Should You wish to submit work that is not Your original creation, You may submit it to New Relic separately from any Contribution, identifying the complete details of its source and of any license or other restriction (including, but not limited to, related patents, trademarks, and license agreements) of which You are personally aware, and conspicuously marking the work as "Submitted on behalf of a third-party: [named here]".
+9. You agree to notify New Relic of any facts or circumstances of which You become aware that would make these representations inaccurate in any respect.
diff --git a/README.md b/README.md
@@ -12,32 +12,34 @@ npm start
 
 Your site is now running at `http://localhost:8000`!
 
+### Dependencies
+
+Node v12 is used in this project as specified in [.nvmrc](https://github.com/newrelic/developer-website/blob/master/.nvmrc).
+
 ## 📝 Unit tests
 
-To run the unit tests, run `npm test` in the terminal. If you would like to 
+To run the unit tests, run `npm test` in the terminal. If you would like to
 have the tests automatically re-run, use `npm run test:watch`.
 
 ## 🌎 Community
 
-New Relic hosts and moderates an online forum where customers can interact with 
-New Relic employees as well as other customers to get help and share best practices. 
-If you are looking for configuration help or more information about New Relic's 
+New Relic hosts and moderates an online forum where customers can interact with
+New Relic employees as well as other customers to get help and share best practices.
+If you are looking for configuration help or more information about New Relic's
 products please visit the [New Relic Explorers Hub](https://discuss.newrelic.com/)
 
-
-## 🚧 Contributing 
+## 🚧 Contributing
 
 We welcome contributions to the New Relic Developer Site. Please review our
-[Contributors Guide](CONTRIBUTING.md) prior to submitting any code. 
-
+[Contributors Guide](CONTRIBUTING.md) prior to submitting any code.
 
-## 🚦Code of conduct 
+## 🚦Code of conduct
 
 Please review and agree to our [Code of Conduct](CODE_OF_CONDUCT.md) prior to submitting any code.
 
 ## 🐛 Issues / enhancement requests
 
-Please submit any issues or enhancement requests using one of our 
-[Issue Templates](https://github.com/newrelic/developer-website/issues/new/choose). 
-Please search for and review the existing open issues before submitting a new 
+Please submit any issues or enhancement requests using one of our
+[Issue Templates](https://github.com/newrelic/developer-website/issues/new/choose).
+Please search for and review the existing open issues before submitting a new
 issue to prevent the submission of duplicate issues.
diff --git a/src/components/FeatherIcon.js b/src/components/FeatherIcon.js
@@ -83,6 +83,14 @@ const ICONS = {
   github: (
     <path d="M9 19c-5 1.5-5-2.5-7-3m14 6v-3.87a3.37 3.37 0 0 0-.94-2.61c3.14-.35 6.44-1.54 6.44-7A5.44 5.44 0 0 0 20 4.77 5.07 5.07 0 0 0 19.91 1S18.73.65 16 2.48a13.38 13.38 0 0 0-7 0C6.27.65 5.09 1 5.09 1A5.07 5.07 0 0 0 5 4.77a5.44 5.44 0 0 0-1.5 3.78c0 5.42 3.3 6.61 6.44 7A3.37 3.37 0 0 0 9 18.13V22" />
   ),
+  pen: (
+    <>
+      <path d="M12 19l7-7 3 3-7 7-3-3z" />
+      <path d="M18 13l-1.5-7.5L2 2l3.5 14.5L13 18l5-5z" />
+      <path d="M2 2l7.586 7.586" />
+      <circle cx="11" cy="11" r="2" />
+    </>
+  ),
   search: (
     <>
       <circle cx="11" cy="11" r="8" />
@@ -97,6 +105,12 @@ const ICONS = {
       <polyline points="16 16 12 12 8 16" />
     </>
   ),
+  award: (
+    <>
+      <circle cx="12" cy="8" r="7" />
+      <polyline points="8.21 13.89 7 23 12 20 17 23 15.79 13.88" />
+    </>
+  ),
 };
 
 FeatherIcon.propTypes = {

diff --git a/src/components/Footer.js b/src/components/Footer.js
@@ -28,6 +28,10 @@ const Footer = ({ className }) => {
       </div>
 
       <div className={styles.right}>
+        <Link to="/terms">
+          <FeatherIcon className={styles.linkIcon} name="pen" size="1rem" />
+          Terms of service
+        </Link>
         {fileRelativePath && (
           <ExternalLink
             href={`${githubBaseUrl}/blob/master/${fileRelativePath}`}

diff --git a/src/components/Footer.module.scss b/src/components/Footer.module.scss
@@ -6,6 +6,10 @@
   font-size: 0.75rem;
   z-index: 1;
 
+  @media (max-width: 1080px) {
+    flex-direction: column;
+  }
+
   a {
     color: currentColor;
   }

diff --git a/src/components/NavigationItems.js b/src/components/NavigationItems.js
@@ -8,6 +8,17 @@ import { BreadcrumbContext } from './BreadcrumbContext';
 import styles from './NavigationItems.module.scss';
 import { link } from '../types';
 
+const iconLibrary = {
+  'Collect data': 'collectData',
+  'Build apps': 'buildApps',
+  'Automate workflows': 'automation',
+  'Explore docs': 'developerDocs',
+};
+
+const featherIconLibrary = {
+  'Developer champions': 'award',
+};
+
 const getHighlightedText = (text, highlight) => {
   const parts = text.split(new RegExp(`(${highlight})`, 'gi'));
   return (
@@ -59,6 +70,28 @@ const NavigationItems = ({
   });
 };
 
+const NavIcon = ({ page }) => {
+  if (featherIconLibrary[page.displayName]) {
+    return (
+      <FeatherIcon
+        className={styles.headerIcon}
+        name={featherIconLibrary[page.displayName]}
+      />
+    );
+  }
+
+  if (iconLibrary[page.displayName]) {
+    return (
+      <NewRelicIcon
+        className={styles.headerIcon}
+        name={iconLibrary[page.displayName]}
+      />
+    );
+  }
+
+  return null;
+};
+
 const NavItem = ({ page, depthLevel, searchTerm, filteredPageNames }) => {
   const crumbs = useContext(BreadcrumbContext).flatMap((x) => x.displayName);
   const isHomePage = crumbs.length === 0 && depthLevel === 0;
@@ -67,19 +100,8 @@ const NavItem = ({ page, depthLevel, searchTerm, filteredPageNames }) => {
     isHomePage || crumbs.includes(page.displayName)
   );
 
-  const iconLibrary = {
-    'Collect data': 'collectData',
-    'Build apps': 'buildApps',
-    'Automate workflows': 'automation',
-    'Explore docs': 'developerDocs',
-  };
   const isCurrentPage = crumbs[crumbs.length - 1] === page.displayName;
-  const headerIcon = depthLevel === 0 && (
-    <NewRelicIcon
-      className={styles.headerIcon}
-      name={iconLibrary[page.displayName]}
-    />
-  );
+  const headerIcon = depthLevel === 0 && <NavIcon page={page} />;
   const display = filteredPageNames
     ? getHighlightedText(page.displayName, searchTerm)
     : page.displayName;
@@ -104,7 +126,7 @@ const NavItem = ({ page, depthLevel, searchTerm, filteredPageNames }) => {
           )}
           to={page.url}
         >
-          <span>
+          <span className={styles.navLinkText}>
             {headerIcon}
             {display}
           </span>
@@ -154,6 +176,12 @@ const NavItem = ({ page, depthLevel, searchTerm, filteredPageNames }) => {
   );
 };
 
+NavIcon.propTypes = {
+  page: PropTypes.shape({
+    displayName: PropTypes.string.isRequired,
+  }),
+};
+
 NavigationItems.propTypes = {
   pages: PropTypes.array.isRequired,
   filteredPageNames: PropTypes.array,

diff --git a/src/components/NavigationItems.module.scss b/src/components/NavigationItems.module.scss
@@ -51,6 +51,11 @@ button.navLink {
   }
 }
 
+.navLinkText {
+  display: flex;
+  align-items: center;
+}
+
 .currentPageIndicator {
   stroke-width: 4;
   @media (min-width: 760px + 1) {

diff --git a/src/images/nrone-table-guide/added-table.png b/src/images/nrone-table-guide/added-table.png
diff --git a/src/images/nrone-table-guide/app-overview.png b/src/images/nrone-table-guide/app-overview.png
diff --git a/src/images/nrone-table-guide/clicked.png b/src/images/nrone-table-guide/clicked.png
diff --git a/src/images/nrone-table-guide/demo-app-button.png b/src/images/nrone-table-guide/demo-app-button.png
diff --git a/src/images/nrone-table-guide/hovered.png b/src/images/nrone-table-guide/hovered.png
diff --git a/src/images/nrone-table-guide/interactive-table.gif b/src/images/nrone-table-guide/interactive-table.gif
diff --git a/src/images/nrone-table-guide/interactive-table.png b/src/images/nrone-table-guide/interactive-table.png
diff --git a/src/images/nrone-table-guide/newtable.png b/src/images/nrone-table-guide/newtable.png
diff --git a/src/images/nrone-table-guide/nrone-launcher.png b/src/images/nrone-table-guide/nrone-launcher.png
diff --git a/src/images/nrone-table-guide/predefined.png b/src/images/nrone-table-guide/predefined.png
diff --git a/src/images/nrone-table-guide/table-new-cells.png b/src/images/nrone-table-guide/table-new-cells.png
diff --git a/src/images/time-picker-guide/add-timepicker.png b/src/images/time-picker-guide/add-timepicker.png
diff --git a/src/images/time-picker-guide/console.png b/src/images/time-picker-guide/console.png
diff --git a/src/images/time-picker-guide/homepage-launcher.png b/src/images/time-picker-guide/homepage-launcher.png
diff --git a/src/markdown-pages/5-min-tag-resources.mdx b/src/markdown-pages/5-min-tag-resources.mdx
@@ -0,0 +1,162 @@
+---
+path: '/guides/5-min-tag-resources'
+duration: '5 min'
+title: 'Quickly tag a set of resources'
+template: 'GuideTemplate'
+description: 'Add tags to applications you instrument for easier filtering and organization.'
+---
+
+<Intro>
+
+[Tags](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/core-concepts/tagging-use-tags-organize-group-what-you-monitor) help you group, search, filter, and focus the data about your [entities](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/core-concepts/what-entity-new-relic), which can be anything from applications to hosts to services. Tagging entities using the New Relic CLI is a good candidate for automation.
+
+In this 5-minute guide, you are going to use the New Relic CLI to add multiple tags to one of your entities.
+
+</Intro>
+
+## Before you begin
+
+For this guide you need your New Relic [personal API Key](https://docs.newrelic.com/docs/apis/get-started/intro-apis/types-new-relic-api-keys#personal-api-key): Create it at the **Account settings** screen of your New Relic account.
+
+<Steps>
+<Step>
+
+## Install the New Relic CLI
+
+You can download the New Relic CLI via [Homebrew](https://brew.sh/) (macOS), [Scoop](https://scoop.sh/) (Windows), and [Snapcraft](https://snapcraft.io/) (Linux). You can also download [pre-built binaries](https://github.com/newrelic/newrelic-cli/releases) for all platforms, including .deb and .rpm packages, and our Windows x64 .msi installer.
+
+* #### Linux
+
+    With [Snapcraft](https://snapcraft.io/) installed, run:
+
+    `sudo snap install newrelic-cli`
+
+* #### macOS
+
+    With [Homebrew](https://brew.sh/) installed, run:
+
+    `brew install newrelic-cli`
+
+* #### Windows
+
+    With [Scoop](https://scoop.sh/) installed, run:
+
+    `scoop bucket add newrelic-cli https://github.com/newrelic/newrelic-cli.git`<br />
+    `scoop install newrelic-cli`
+
+</Step><Step>
+
+## Create your New Relic CLI profile 
+
+New Relic CLI profiles contain credentials and settings that you can apply to any CLI command.
+
+To create your first CLI profile, run the [`profiles add`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_profile_add.md) command. Don't forget to set the [region](https://docs.newrelic.com/docs/using-new-relic/welcome-new-relic/get-started/our-eu-us-region-data-centers) of your New Relic account: use `-r` to set either `us` or `eu` (this is required).
+
+```bash lineNumbers=false
+# Create the tutorial account for the US region
+newrelic profiles add -n tutorial --apiKey API_KEY -r us
+# Set the profile as default
+newrelic profiles default -n tutorial
+```
+
+</Step><Step>
+
+## Search for an entity
+
+Your New Relic account may have hundreds of entities: Have a quick look by opening 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).
+
+In the terminal, run [`entity search`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_entity_search.md) to retrieve a list of entities from your account as JSON. In the example, you're searching for all entities with "test" in their name.
+
+```bash lineNumbers=false
+# Change the `name` to match any of your existing entities
+newrelic entity search --name "test" 
+```
+
+</Step><Step>
+
+If there are matching entities in your account, the query yields data in JSON format, similar to this workload example.
+
+Select an entity from the results and look for its `guid` value; the `guid` is the unique identifier of the entity. Write it down.
+
+```json lineNumbers=false copy=false
+{
+    "accountId": 123456789,
+    "domain": "NR1",
+    "entityType": "WORKLOAD_ENTITY",
+    "guid": "F7B7AE59FDED4204B846FB08423DB18E",
+    "name": "Test workload",
+    "reporting": true,
+    "type": "WORKLOAD"
+  },
+```
+</Step><Step>
+
+## Add tags and tag lists to your entity
+
+With your entity `guid`, you can add tags right away. You can do so by invoking the [`entities tags create`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_entity_tags_create.md) command. 
+
+What if you want to add multiple tags? You can use tag sets for that: While tags are key-value pairs separated by colons, tag sets are comma-separated lists of tags. For example:
+
+`tag1:value1,tag2:value2`
+
+<Important>Adding tags is an asynchronous operation: it could take a little while for the tags to get created.</Important>
+
+```bash lineNumbers=false
+# Adding a single tag
+newrelic entity tags create --guid GUID --tag key:value
+# Adding multiple tags
+newrelic entity tags create --guid GUID --tag tag1:test,tag2:test
+```
+</Step><Step>
+
+## Check that the tags are there
+
+To make sure that the tags have been added to your entities, retrieve them using the [`entity tags get`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_entity_tags_get.md) command. All tags associated with your entity are retrieved as a JSON array.
+
+`newrelic entity tags get --guid GUID`
+
+<Tip>
+
+Tags can be deleted at any time by invoking the [`entity tags delete`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_entity_tags_delete.md) command followed by the same arguments you used to create them.
+
+</Tip>
+
+
+```json lineNumbers=false
+[
+  {
+    "Key": "tag1",
+    "Values": [
+      "true"
+    ]
+  },
+  {
+    "Key": "tag2",
+    "Values": [
+      "test"
+    ]
+  },
+  {
+    "Key": "tag3",
+    "Values": [
+      "testing"
+    ]
+  }
+  // ...
+]
+```
+</Step></Steps>
+
+## Next steps
+
+Have a look at [all the New Relic CLI commands](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic.md). For example, you could create a [New Relic workflow](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/core-concepts/new-relic-one-workloads-isolate-resolve-incidents-faster) using [`workload create`](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic_workload_create.md).
+
+If you'd like to engage with other community members, visit our [New Relic Explorers Hub](https://discuss.newrelic.com/c/build-on-new-relic/developer-toolkit) page. We welcome feature requests or bug reports on [GitHub](https://github.com/newrelic/newrelic-cli).
+
+## Related info
+
+- [Understanding Entity Explorer (Video)](https://www.youtube.com/watch?v=IGZQup8ZEmE)
+- [Tagging: Use tags to organize and group what you monitor](https://docs.newrelic.com/docs/new-relic-one/use-new-relic-one/core-concepts/tagging-use-tags-organize-group-what-you-monitor)
+- [New Relic CLI commands reference](https://github.com/newrelic/newrelic-cli/blob/master/docs/cli/newrelic.md)
+- [New Relic CLI repository on GitHub](https://github.com/newrelic/newrelic-cli)
+